PeopleSoft HCM 9.2: PeopleSoftGlobal Payroll for Brazil

January 2022

PeopleSoft HCM 9.2: PeopleSoft Global Payroll for BrazilCopyright © 1988, 2022, Oracle and/or its affiliates.

This software and related documentation are provided under a license agreement containing restrictions on use anddisclosure and are protected by intellectual property laws. Except as expressly permitted in your license agreementor allowed by law, you may not use, copy, reproduce, translate, broadcast, modify, license, transmit, distribute,exhibit, perform, publish, or display any part, in any form, or by any means. Reverse engineering, disassembly, ordecompilation of this software, unless required by law for interoperability, is prohibited.

The information contained herein is subject to change without notice and is not warranted to be error-free. If youfind any errors, please report them to us in writing.

If this is software or related documentation that is delivered to the U.S. Government or anyone licensing it on behalfof the U.S. Government, then the following notice is applicable:

U.S. GOVERNMENT END USERS: Oracle programs (including any operating system, integrated software,any programs embedded, installed or activated on delivered hardware, and modifications of such programs) andOracle computer documentation or other Oracle data delivered to or accessed by U.S. Government end users are"commercial computer software" or “commercial computer software documentation” pursuant to the applicableFederal Acquisition Regulation and agency-specific supplemental regulations. As such, the use, reproduction,duplication, release, display, disclosure, modification, preparation of derivative works, and/or adaptation of i) Oracleprograms (including any operating system, integrated software, any programs embedded, installed or activatedon delivered hardware, and modifications of such programs), ii) Oracle computer documentation and/or iii) otherOracle data, is subject to the rights and limitations specified in the license contained in the applicable contract. Theterms governing the U.S. Government’s use of Oracle cloud services are defined by the applicable contract for suchservices. No other rights are granted to the U.S. Government.

This software or hardware is developed for general use in a variety of information management applications. It isnot developed or intended for use in any inherently dangerous applications, including applications that may create arisk of personal injury. If you use this software or hardware in dangerous applications, then you shall be responsibleto take all appropriate fail-safe, backup, redundancy, and other measures to ensure its safe use. Oracle Corporationand its affiliates disclaim any liability for any damages caused by use of this software or hardware in dangerousapplications.

Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other names may be trademarks of theirrespective owners.

Intel and Intel Inside are trademarks or registered trademarks of Intel Corporation. All SPARC trademarks are usedunder license and are trademarks or registered trademarks of SPARC International, Inc. AMD, Epyc, and the AMDlogo are trademarks or registered trademarks of Advanced Micro Devices. UNIX is a registered trademark of TheOpen Group.

This software or hardware and documentation may provide access to or information about content, products, andservices from third parties. Oracle Corporation and its affiliates are not responsible for and expressly disclaim allwarranties of any kind with respect to third-party content, products, and services unless otherwise set forth in anapplicable agreement between you and Oracle. Oracle Corporation and its affiliates will not be responsible for anyloss, costs, or damages incurred due to your access to or use of third-party content, products, or services, except asset forth in an applicable agreement between you and Oracle.

Documentation Accessibility

For information about Oracle's commitment to accessibility, visit the Oracle Accessibility Program website at http://www.oracle.com/pls/topic/lookup?ctx=acc&id=docacc.

Access to Oracle Support

Oracle customers that have purchased support have access to electronic support through My Oracle Support. Forinformation, visit http://www.oracle.com/pls/topic/lookup?ctx=acc&id=info or visit http://www.oracle.com/pls/topic/lookup?ctx=acc&id=trs if you are hearing impaired.

Contents

Preface: Preface..........................................................................................................................................xvUnderstanding the PeopleSoft Online Help and PeopleBooks.............................................................xv

Hosted PeopleSoft Online Help..................................................................................................... xvLocally Installed Help.................................................................................................................... xvDownloadable PeopleBook PDF Files...........................................................................................xvCommon Help Documentation.......................................................................................................xvField and Control Definitions....................................................................................................... xviTypographical Conventions...........................................................................................................xviISO Country and Currency Codes................................................................................................ xviRegion and Industry Identifiers................................................................................................... xviiTranslations and Embedded Help................................................................................................ xvii

Using and Managing the PeopleSoft Online Help............................................................................xviiiRelated Links for PeopleSoft HCM.................................................................................................. xviiiContact Us..........................................................................................................................................xviiiFollow Us...........................................................................................................................................xviii

Chapter 1: Getting Started with Global Payroll for Brazil.................................................................. 21Global Payroll for Brazil Overview..................................................................................................... 21Global Payroll for Brazil Business Processes...................................................................................... 21Global Payroll for Brazil Integrations.................................................................................................. 22Global Payroll for Brazil Implementation............................................................................................22

Chapter 2: Understanding Global Payroll for Brazil............................................................................ 23Global Payroll for Brazil...................................................................................................................... 23Global Payroll for Brazil Business Processes...................................................................................... 23Delivered Elements for Brazil.............................................................................................................. 25

Creation of Delivered Elements.....................................................................................................25Element Ownership and Maintenance........................................................................................... 26

Naming Convention for Delivered Elements....................................................................................... 27Element Names...............................................................................................................................27Functional Area Codes................................................................................................................... 35Element Type Codes (PIN_TYPE)................................................................................................ 36

Data Archiving for Global Payroll for Brazil...................................................................................... 37How to View Delivered Elements........................................................................................................37

Chapter 3: Defining Country Data.......................................................................................................... 39Setting Up Utilities in Global Payroll for Brazil................................................................................. 39

Pages Used to Set Up Utilities in Global Payroll for Brazil......................................................... 39Understanding Element Mapping...................................................................................................39Define Variable Attributes BRA Page........................................................................................... 40Map Elems to Comp/Rcd BRA Page............................................................................................ 41Viewing Delivered Elements..........................................................................................................42

Selecting Report Elements and Defining Payslip Sort Order.............................................................. 42Pages Used to Select Report Elements and Define Payslip Sort Order.........................................42Element Lists BRA Page............................................................................................................... 43Sort IDs BRA Page........................................................................................................................ 44

Defining Service Takers........................................................................................................................45Page Used to Define Service Taker Data...................................................................................... 46Service Takers BRA Page..............................................................................................................46

Copyright © 1988, 2022, Oracle and/or its affiliates. iii

Contents

Defining Union Parameters.................................................................................................................. 48Pages Used to Define Union Parameters.......................................................................................48General Parameters Page................................................................................................................49

Setting Up Payee Data..........................................................................................................................53Pages Used to Define Payee Data for Brazil.................................................................................53Labor Reform Update.....................................................................................................................54Maintain Payee-Union Data BRA Page.........................................................................................54Payee Parameters Page...................................................................................................................55Termination Parameters Page.........................................................................................................59FGTS and Stability Page................................................................................................................63Employee Other Annual Amt BRA Page...................................................................................... 64

Defining Unhealthy and Hazardous Indicators for Job Codes and Positions.......................................66Page Used to Define Indicators..................................................................................................... 66Position/JobCd Parameters BRA Page...........................................................................................66

Defining SEFIP Parameters.................................................................................................................. 67Pages Used to Define SEFIP Parameters...................................................................................... 67SEFIP Parameters BRA Page........................................................................................................ 68SEFIP Absence Table BRA Page.................................................................................................. 69SEFIP Absence Parameters BRA Page......................................................................................... 69Service Taker Transactions BRA Page.......................................................................................... 70Service Taker Data BRA Page.......................................................................................................71SEFIP Autonomous Review BRA Page........................................................................................ 73Legal Movement Codes BRA Page...............................................................................................73

Using Core Functionality in Brazil...................................................................................................... 74Defining Retroactivity in Brazil.....................................................................................................75Using Accumulators in Brazil........................................................................................................76Using Segmentation in Brazil........................................................................................................ 76Using Triggers in Brazil.................................................................................................................76Using Rounding Rules in Brazil.................................................................................................... 78Using Rate Codes in Brazil........................................................................................................... 78

Viewing Delivered Process Lists..........................................................................................................78Chapter 4: Setting Up the 13th Salary....................................................................................................81

Understanding the 13th Salary............................................................................................................. 81Viewing Delivered Elements..........................................................................................................81

Setup Considerations.............................................................................................................................82Viewing Delivered 13th Salary Elements.............................................................................................82

Viewing Delivered 13th Salary Earnings.......................................................................................82Viewing Delivered 13th Salary Deductions...................................................................................84Viewing Delivered Accumulators.................................................................................................. 84Viewing Delivered Sections........................................................................................................... 84

Chapter 5: Setting Up Vacation Pay........................................................................................................87Understanding Vacation Setup..............................................................................................................87

Core Application Setup.................................................................................................................. 87Global Payroll for Brazil Setup..................................................................................................... 88Viewing Delivered Elements..........................................................................................................88

Defining Vacation Parameters for Brazil..............................................................................................88Pages Used to Define Vacation Parameters................................................................................... 89Understanding Vacation Parameters...............................................................................................89Vacation Parameters BRA Page.....................................................................................................90Closing and Continuing Entitlement Balances.............................................................................. 97Vacation Calendars BRA Page.......................................................................................................98

iv Copyright © 1988, 2022, Oracle and/or its affiliates.

Contents

Chapter 6: Defining Average Salary Rules........................................................................................... 101Understanding Average Salary Calculations...................................................................................... 101

Prerequisites.................................................................................................................................. 101Viewing Delivered Elements........................................................................................................102

Understanding Average Salary Setup................................................................................................. 102Example: Average Setup with Retroactive Processing................................................................ 102Example: Maternity Average Setup............................................................................................. 105Example: Vacation and Paid Vacation Average Setup.................................................................106

Defining Average Salary Rules.......................................................................................................... 107Pages Used to Define Average Salary Rules............................................................................... 107Average Version BRA Page......................................................................................................... 107Averages Page...............................................................................................................................113

Generating the Averages Report.........................................................................................................114Page Used to Generate the Averages Report............................................................................... 114Averages Report BRA Page.........................................................................................................114

Chapter 7: Setting Up Termination Pay................................................................................................117Understanding Terminations............................................................................................................... 117

DSR Compensated Saturday and Indemnities Earnings.............................................................. 119Viewing Delivered Elements........................................................................................................120

Setting Up Termination Versions........................................................................................................120Pages Used to Define Termination Versions................................................................................120Understanding Termination Versions........................................................................................... 120Termination Versions Page...........................................................................................................122Earnings/Deductions Page............................................................................................................125

Chapter 8: Defining Earnings.................................................................................................................127Calculating Earnings........................................................................................................................... 127

Calculating Base Compensation...................................................................................................127Calculating Bonuses and Premiums.............................................................................................128Calculating Additional Earnings.................................................................................................. 129Calculating Overtime....................................................................................................................131

Defining Salary Advances.................................................................................................................. 132Salary Advances and Taxation.....................................................................................................133

Loading Batch Positive Input............................................................................................................. 133Page Used for Loading Batch Positive Input.............................................................................. 134Manage Pos Input via Batch BRA Page......................................................................................134

Chapter 9: Understanding Deductions.................................................................................................. 139Understanding Deduction Types.........................................................................................................139Using Batch Positive Input.................................................................................................................139Creating Deduction Elements............................................................................................................. 139Viewing Delivered Deduction Elements............................................................................................ 140

General Deductions...................................................................................................................... 140Process Lists with Deductions..................................................................................................... 142

Chapter 10: Creating Payslips................................................................................................................143Understanding the Payslip Definition Process................................................................................... 143

Viewing Delivered Elements........................................................................................................143Viewing Payslips.................................................................................................................................144Running the Payslip Report................................................................................................................144

Page Used to Run the Payslip Report..........................................................................................144Create/Print Payslips BRA Page.................................................................................................. 144

Chapter 11: Managing Off-Cycle Payments for Brazil....................................................................... 147Understanding Off-Cycle Processing..................................................................................................147

Copyright © 1988, 2022, Oracle and/or its affiliates. v

Contents

The Off-Cycle Process................................................................................................................. 147Types of Off-Cycle Transactions................................................................................................. 147Viewing Delivered Elements........................................................................................................148

Recording Manual Payments for Brazil............................................................................................. 148Entering Manual Payments.......................................................................................................... 148

Entering or Reversing Payroll Results for Brazil...............................................................................149Corrections....................................................................................................................................149

Making Unscheduled Payments for Brazil.........................................................................................149Issuing Advance Payments for Brazil................................................................................................ 149

Chapter 12: Processing Banking............................................................................................................ 151Understanding the Banking Process for Brazil.................................................................................. 151

Viewing Delivered Elements........................................................................................................151Defining Recipients.............................................................................................................................151

Pages Used to Define Recipients.................................................................................................152Recipient Information Page..........................................................................................................152Define Deduction Recipients Page...............................................................................................153Recipient Deposit Schedule Page................................................................................................ 154

Creating Bank Reporting Formats......................................................................................................154Pages Used to Create Bank Reporting Formats...........................................................................154Layout Definition Page................................................................................................................ 154Layout Criteria Page.....................................................................................................................155Field Definition Page................................................................................................................... 157Characters Replacement Page...................................................................................................... 159Centralization Data BRA Page.................................................................................................... 160

Defining the Banking Process............................................................................................................ 161Pages Used to Define Banking in Brazil..................................................................................... 162Understanding the Banking Process.............................................................................................162Run Payment Prep Process BRA Page........................................................................................ 162Create EFT Payment File BRA Page.......................................................................................... 163

Chapter 13: Processing Alimony............................................................................................................ 165Understanding Alimony Deductions...................................................................................................165Entering Alimony Information........................................................................................................... 165

Chapter 14: Working With eSocial........................................................................................................173Understanding eSocial........................................................................................................................ 173

Delivered eSocial Enhancements in Global Payroll for Brazil....................................................174Events and File Layouts...............................................................................................................174eSocial Implementation................................................................................................................ 175

Setting Up eSocial.............................................................................................................................. 177Pages Used to Set Up eSocial......................................................................................................177Understanding SetID and Company Mapping............................................................................. 180Understanding Action and Reason Setup.................................................................................... 182Setting Up eSocial........................................................................................................................182eSocial Parameters BRA Page..................................................................................................... 184eSocial Register Number BRA Page........................................................................................... 184ASO Exam Procedure Page......................................................................................................... 185Import Historical Data BRA Page............................................................................................... 187XML Batch Group Definition Page.............................................................................................192Events Setup Page........................................................................................................................ 193Events Activation Page................................................................................................................ 196Basic Table Events Page.............................................................................................................. 198Non Periodic Events Page............................................................................................................199

vi Copyright © 1988, 2022, Oracle and/or its affiliates.

Contents

Periodic Events Page....................................................................................................................200Company Parameters Page...........................................................................................................201SetID Group Page........................................................................................................................ 204XML Options Page...................................................................................................................... 205Software Providers Page.............................................................................................................. 207Address Type Page....................................................................................................................... 208Address Format Page................................................................................................................... 209Timecard Type Page.....................................................................................................................211Dependents Page...........................................................................................................................211Ethnic Groups Page......................................................................................................................213Education Level Page...................................................................................................................214Marital Status Page.......................................................................................................................215Visa and Permits Page..................................................................................................................215Labor Category Legal Codes Page.............................................................................................. 216Labor Regime Page...................................................................................................................... 217Termination Legal Codes Page.................................................................................................... 218Hire Action/Reason Page............................................................................................................. 219Termination Action/Reason Page................................................................................................. 220Other Action/Reason Page........................................................................................................... 222Absence Legal Codes Page..........................................................................................................223Absence Take and Reason Page...................................................................................................224Country and Nationality Cd Bra Page......................................................................................... 225INSS Tax Incidence Code Page...................................................................................................226Income Tax Incidence Code Page................................................................................................227Wage Type Code Page................................................................................................................. 227Wage Types Table Page............................................................................................................... 228Run Types Page............................................................................................................................232Health Data Page..........................................................................................................................234Exemption Proceedings Page....................................................................................................... 235eSocial Diagnostic Procedures Page............................................................................................ 239Hazard Agent Code BRA Page....................................................................................................239Hazard Factor Table Page............................................................................................................ 240Special Activities Page.................................................................................................................242

Understanding Events......................................................................................................................... 242Understanding Initial Data Loading.............................................................................................242Understanding Reporting of Ongoing Transactions and Event Categories..................................244Driver and Cross-Reference Tables............................................................................................. 247Splitting of Events for Multiple Impacted Companies................................................................ 248Mapping Process...........................................................................................................................248Loading Staging Tables................................................................................................................248Processing Phases and Options.................................................................................................... 249HCM Transaction Data Retrieved For eSocial Events................................................................ 252Understanding Pre-Hiring Events................................................................................................ 270

Identifying Events............................................................................................................................... 270Pages Used to Identify Events..................................................................................................... 271eSocial Basic Initial Page.............................................................................................................272eSocial Employee Initial Page..................................................................................................... 274eSocial Basic Table Event Page...................................................................................................277eSocial Non Periodic Event Page................................................................................................ 279eSocial Pre-Hiring Event Page.....................................................................................................282eSocial Pre-Hiring Monitor Page.................................................................................................285

Copyright © 1988, 2022, Oracle and/or its affiliates. vii

Contents

eSocial Pre-Hiring Monitor - Details Page..................................................................................289eSocial Termination Events Page.................................................................................................290eSocial Processed Calendars - eSocial Termination Events Page................................................293eSocial Processed Employees - eSocial Termination Events Page..............................................293eSocial Payroll Tax Exempt BRA Page.......................................................................................294eSocial Employer Union Contrib Page........................................................................................296eSocial Payroll Events Page.........................................................................................................297eSocial Processed Calendars - eSocial Payroll Events Page....................................................... 301eSocial Processed Employees - eSocial Payroll Events Page......................................................302eSocial Period Controls Page.......................................................................................................303Company Without Movement Page............................................................................................. 305eSocial Hire Exclusion Page........................................................................................................306

Creating XML Outputs for Events..................................................................................................... 308Page Used to Create XML Outputs For Submission...................................................................308Understanding XML Output Generation..................................................................................... 308eSocial Recreate XML Files Page............................................................................................... 310

Submitting XML Outputs and Requesting Results............................................................................ 312Pages Used to Submit XML Outputs and Request Submission Results......................................312Understanding eSocial Data Transmission Between PeopleSoft and eSocial Systems................313Delivered Services........................................................................................................................313Send Batch Process Page............................................................................................................. 315Get Events Results Process Page.................................................................................................317

Monitoring eSocial Events..................................................................................................................318Pages Used to Monitor eSocial Events........................................................................................318Understanding eSocial Event Monitoring....................................................................................319eSocial Error Catalog Page.......................................................................................................... 319eSocial Events Monitor Page....................................................................................................... 321eSocial Events Monitor - Details Page........................................................................................ 326Event Details Page....................................................................................................................... 329eSocial Monitor XML Preview Page...........................................................................................330Employee Event History Page..................................................................................................... 331

Generating CAT Forms.......................................................................................................................334Page Used to Generate CAT Forms.............................................................................................334Understanding eSocial CAT Forms..............................................................................................334CAT Form Page............................................................................................................................334

Chapter 15: Calculating Social Security Contributions...................................................................... 337Understanding INSS Contributions.................................................................................................... 337

Viewing Delivered Elements........................................................................................................337Entering GPS Establishment Information.......................................................................................... 337Determining Social Security Contributions........................................................................................338

Determining Company Social Security Contributions.................................................................338Determining Third-Party Social Security Contributions..............................................................339Determining Contribution to SAT (Workers' Accident Insurance).............................................. 339Determining Employee Social Security Contributions................................................................ 339Determining Maternity Allowance Contributions........................................................................340Determining Family Allowance Contributions............................................................................ 340Determining Contributions For Contracting Independent Workers............................................. 340Determining Contributions for Compensation Paid to Businessmen...........................................340

Calculating Social Security (INSS) Payments................................................................................... 340Calculating INSS with IN BR PCT INSS Bracket Data............................................................. 340Calculating INSS - Salary for Contribution.................................................................................341

viii Copyright © 1988, 2022, Oracle and/or its affiliates.

Contents

Calculating INSS.......................................................................................................................... 342Calculating INSS for Income Tax................................................................................................342Calculating INSS for Special Retirement.................................................................................... 342

Running the GPS Report.................................................................................................................... 343Page Used to Run the GPS Report..............................................................................................343GPS Report BRA Page................................................................................................................ 343

Chapter 16: Withholding Income Tax (IRRF)..................................................................................... 345Understanding Income Tax Withholding............................................................................................345

Income Tax Rates and Amounts.................................................................................................. 345Allowable Tax Deductions........................................................................................................... 346Income Tax Calculation................................................................................................................347Special Tax Withholding Situations.............................................................................................348Viewing Delivered Elements........................................................................................................348

Viewing Dependents........................................................................................................................... 348Page Used to View Dependents...................................................................................................349Review Dependent Data BRA Page............................................................................................ 349

Running the Income Tax Report........................................................................................................ 350Pages Used to Run the Income Tax Report.................................................................................350

Generating Declaration of Withholding Tax (DIRF) Reports............................................................ 350Pages Used to Produce DIRF Reports.........................................................................................351Understanding DIRF Reporting................................................................................................... 351DIRF Parameters BRA Page........................................................................................................352Monthly DIRF Report BRA Page................................................................................................356DIRF Report BRA Page...............................................................................................................358Income & Taxes Page.................................................................................................................. 360Health Service Page..................................................................................................................... 361

Generating Document for the Collection of Federal Revenues (DARF) Reports.............................. 362Pages Used to Produce DARF Reports....................................................................................... 362Understanding DARF Reporting..................................................................................................362DARF Parameters BRA Page...................................................................................................... 362DARF Report BRA Page............................................................................................................. 364

Generating the Statement of Income and Withholding Tax (IREN) Report.......................................367Pages Used to Produce the IREN Report.................................................................................... 367Understanding the IREN Reporting Process................................................................................367Recpnt/Benef Relationship BRA Page.........................................................................................367IREN Parameters BRA Page........................................................................................................368IREN Report BRA Page.............................................................................................................. 370

Viewing Delivered Income Tax Elements..........................................................................................371Deductions for Income Tax..........................................................................................................372Earnings for Income Tax..............................................................................................................372Income Tax Sections.................................................................................................................... 372

Chapter 17: Generating MANAD Reports........................................................................................... 373Understanding MANAD Reports....................................................................................................... 373

Setting Up MANAD Reports.......................................................................................................373Defining MANAD Report Parameters............................................................................................... 374

Pages Used to Define MANAD Report Parameters.................................................................... 374MANAD Parameters BRA Page..................................................................................................374Responsible Data Page................................................................................................................. 376Accountant Data Page.................................................................................................................. 377

Generating the MANAD Report.........................................................................................................378Page Used to Generate the MANAD Report...............................................................................379

Copyright © 1988, 2022, Oracle and/or its affiliates. ix

Contents

MANAD File Process BRA Page................................................................................................379Chapter 18: Managing Social Integration Program Payments...........................................................381

Understanding PIS Payment Processing.............................................................................................381Defining Parameters for Processing PIS Payments............................................................................381

Pages Used to Define Parameters for PIS Payments...................................................................381Understanding Setup Steps for PIS Payments............................................................................. 382PIS Parameters BRA Page........................................................................................................... 382Override PIS Param Page.............................................................................................................383Additional Info - Brazil Page.......................................................................................................384Centralization Data Page..............................................................................................................384PIS Parameters Page.....................................................................................................................385PIS Assignment BRA Page..........................................................................................................385

Processing PIS Payments....................................................................................................................386Page Used to Run PIS Processes.................................................................................................386Understanding PIS Payment Processing...................................................................................... 386Prerequisites.................................................................................................................................. 388PIS Processing BRA Page........................................................................................................... 389

Chapter 19: Calculating Legal Provisions.............................................................................................391Understanding Legal Provisions......................................................................................................... 391

Provision Calculations..................................................................................................................391Provision Reporting......................................................................................................................391

Prerequisites for Calculating Provisions.............................................................................................392Viewing Delivered Elements for Provisions...................................................................................... 392

Delivered Earning Elements for Provisions.................................................................................392Delivered Deduction Elements for Provisions.............................................................................394Delivered Process List for Provisions..........................................................................................394

Chapter 20: Entering Absences..............................................................................................................397Understanding Absence Entry in Brazil.............................................................................................397

Absence Setup Tasks....................................................................................................................397Understanding Absence Take Elements in Brazil........................................................................398Viewing Delivered Elements........................................................................................................400Understanding Absence Take Types in Brazil............................................................................. 400

Entering Absences and Forecasting Results.......................................................................................401Pages Used to Enter Absences and Run the Absence Forecasting Process................................. 401Running the Absence Forecasting Process.................................................................................. 402Absence Entry Page..................................................................................................................... 402Forecast Messages Page............................................................................................................... 407Absence Forecast Results Page....................................................................................................408

Entering Contracts and Absences for Trainees.................................................................................. 409Pages Used to Enter Absences for Trainees................................................................................ 409Understanding Absences for Trainees..........................................................................................409Trainee Contract Page.................................................................................................................. 411Contract Details Page................................................................................................................... 412Trainee Recess BRA Page........................................................................................................... 414

Viewing Delivered Absences Elements for Brazil............................................................................. 415Absence Earnings......................................................................................................................... 416Absence Deductions..................................................................................................................... 416Absence Takes.............................................................................................................................. 417Absence Entitlements................................................................................................................... 418Absence Process Lists.................................................................................................................. 418

Chapter 21: Managing Vacation Data................................................................................................... 419

x Copyright © 1988, 2022, Oracle and/or its affiliates.

Contents

Entering Vacation Data and Updating Entitlement............................................................................ 419Pages Used to Enter Vacation Data and Update Entitlement...................................................... 419Understanding How to Enter Vacation Data................................................................................419Understanding How to Update Vacation Entitlement..................................................................420Prerequisites.................................................................................................................................. 420Splitting of Vacation Leaves........................................................................................................ 421Vacation Acquis Prd-Sched BRA Page....................................................................................... 421

Creating Mass Vacation Takes............................................................................................................426Page Used to Generate Mass Vacation Takes..............................................................................426Understanding Mass Vacation Takes........................................................................................... 426Prerequisites.................................................................................................................................. 426Mass Vacation Programming BRA Page..................................................................................... 427

Generating the Vacation Payslip.........................................................................................................429Pages Used to Generate the Vacation Payslip............................................................................. 430Understanding the Vacation Payslip.............................................................................................430Create/Print Payslips BRA Page.................................................................................................. 430

Running the Vacation Receipt and Vacation Notice Reports............................................................. 431Page Used to Run the Vacation Receipt and Vacation Notice Reports........................................431Understanding the Vacation Receipt and Vacation Notice Reports............................................. 431Vacation Receipt\Notice BRA Page.............................................................................................431

Viewing Delivered Vacation Elements............................................................................................... 433Vacation Entitlements................................................................................................................... 434Vacation Takes..............................................................................................................................434Vacation Process Lists..................................................................................................................434

Chapter 22: Tracking Loans...................................................................................................................435Understanding Loans in Brazil...........................................................................................................435

Viewing Delivered Elements........................................................................................................435Defining Loans in Brazil.................................................................................................................... 435

Page Used to Define Loans in Brazil.......................................................................................... 435Request Loans BRA Page............................................................................................................436

Creating Deduction Assignments for Loan Schedules.......................................................................438Calculating Loan Payments................................................................................................................ 438Adjusting Loan Payments...................................................................................................................439

Chapter 23: Running Mass Termination Simulations......................................................................... 441Understanding Mass Termination Simulation.................................................................................... 441

Setting Up Mass Termination Simulation Process.......................................................................441Defining the Mass Termination Simulation Process.......................................................................... 442

Pages Used to Define the Mass Termination Simulation Process............................................... 442Mass Term Simulation Data Page................................................................................................442Payee Detail Page.........................................................................................................................443Off Cycle On Demand Page........................................................................................................ 446

Chapter 24: Processing Termination Pay..............................................................................................449Understanding Termination Payments................................................................................................ 449

Viewing Delivered Elements........................................................................................................449Prerequisites........................................................................................................................................ 449Running the Employment Contract Termination Report....................................................................450

Page Used to Run the Employment Contract Termination Report.............................................. 450Understanding the Employment Contract Termination Report....................................................450Legal Codes by Process Type BRA Page....................................................................................451Legal Codes by Action Reason BRA Page................................................................................. 451Termination Contract Rpt BRA Page.......................................................................................... 452

Copyright © 1988, 2022, Oracle and/or its affiliates. xi

Contents

Running the Unemployment Insurance Request Report.................................................................... 454Page Used to Run the Unemployment Insurance Request Report...............................................454Understanding the Unemployment Insurance Request Report.................................................... 454Unemployment Insurance Rpt BRA Page................................................................................... 455

Viewing Delivered Termination Elements..........................................................................................456Termination Earnings....................................................................................................................457Termination Deductions................................................................................................................458Termination Process Lists and Sections.......................................................................................458

Chapter 25: Processing Mass Termination and Complementary Termination Payroll....................461Understanding Mass Termination and Complementary Termination Payroll.....................................461

Setting Up Mass Termination and Complementary Termination Processing...............................461Defining Mass Termination and Complementary Termination Processing........................................ 463

Pages Used to Define Mass Termination and Complementary Termination Processing..............463Mass Term & Comp Data Page...................................................................................................463Payee Detail Page.........................................................................................................................465Off Cycle On Demand Page........................................................................................................ 469

Chapter 26: Managing Year-End Reporting.........................................................................................471Understanding RAIS Reporting..........................................................................................................471

Prerequisites.................................................................................................................................. 471Defining Company Parameters for the RAIS Report.........................................................................471

Pages Used to Define a Company's RAIS Parameters................................................................ 472RAIS Parameters Page................................................................................................................. 472RAIS Values Page........................................................................................................................ 473RAIS Absence Parameter Page....................................................................................................476

Generating the RAIS Report.............................................................................................................. 477Page Used to Generate the RAIS Report.....................................................................................477RAIS Report BRA Page...............................................................................................................477Reviewing the Log File and Resolving Errors............................................................................ 478

Chapter 27: Using the General Ledger Interface.................................................................................481Running the General Ledger Interface Process..................................................................................481

Page Used to Run the General Ledger Interface Process............................................................ 481Understanding the General Ledger Interface Process..................................................................481Send Costs to GL BRA Page.......................................................................................................481

Chapter 28: Global Payroll for Brazil Reports.................................................................................... 483Global Payroll for Brazil Reports: A to Z......................................................................................... 483Global Payroll for Brazil eSocial Event Layouts...............................................................................488

Event Inactivation.........................................................................................................................491S-1000 - Employer Data.............................................................................................................. 491S-1005 - Establishment and Building Site Table.........................................................................495S-1010 - Wage Types Table......................................................................................................... 495S-1020 - Tax Location Table....................................................................................................... 497S-1030 - Job Code Table............................................................................................................. 498S-1050 - Work Shift and Time Labor Table................................................................................498S-1060 - Workplace Table............................................................................................................498S-1070 - Administrative and Legal Proceedings......................................................................... 501S-1200 - Compensation................................................................................................................503S-1210 - Miscellaneous Payments............................................................................................... 506S-1280 - Complementary Information to Periodic Events.......................................................... 506S-1295 - Request for Totalization for Contingent Payment........................................................ 508S-1298 - Reopening Periodic Events........................................................................................... 509S-1299 - Closing Periodic Events................................................................................................509

xii Copyright © 1988, 2022, Oracle and/or its affiliates.

Contents

S-1300 - Employer Union Contribution...................................................................................... 510S-2190 - Pre-Hiring Event........................................................................................................... 512S-2200 - Employees Initial Loading and Hiring......................................................................... 512S-2205 - Personal Data Changes................................................................................................. 513S-2206 - Employment Contract Changes.................................................................................... 517S-2210 - Accident at Work Communication (CAT).................................................................... 521S-2220 - Worker Health Monitoring – ASO............................................................................... 522S-2221 - Toxicological Exam for Professional Drivers...............................................................525S-2230 - Temporary Absence...................................................................................................... 526S-2240 - Environmental Working Conditions..............................................................................527S-2250 - Termination Previous Notification................................................................................530S-2298 - Employee Reinstatement...............................................................................................531S-2299 - Termination................................................................................................................... 532S-2300 - Workers who have no employment relationship - Begin..............................................535S-2306 - Workers who have no employment relationship - Changes..........................................536S-2399 - Workers who have no employment relationship - End.................................................537S-3000 - Event Exclusion............................................................................................................ 537S-5001 - Social Contributions by Employee............................................................................... 538S-5002 - Income Tax Withholding by Employee........................................................................ 539S-5003 - FGTS Employee............................................................................................................539S-5011 - Social Contributions by Employer................................................................................539S-5012 - IRRF Information Consolidated by Employer..............................................................539S-5013 - FGTS by Company....................................................................................................... 540

Copyright © 1988, 2022, Oracle and/or its affiliates. xiii

Contents

xiv Copyright © 1988, 2022, Oracle and/or its affiliates.

Preface

Understanding the PeopleSoft Online Help and PeopleBooks

The PeopleSoft Online Help is a website that enables you to view all help content for PeopleSoftapplications and PeopleTools. The help provides standard navigation and full-text searching, as well ascontext-sensitive online help for PeopleSoft users.

Hosted PeopleSoft Online HelpYou can access the hosted PeopleSoft Online Help on the Oracle Help Center. The hosted PeopleSoftOnline Help is updated on a regular schedule, ensuring that you have access to the most currentdocumentation. This reduces the need to view separate documentation posts for application maintenanceon My Oracle Support. The hosted PeopleSoft Online Help is available in English only.

To configure the context-sensitive help for your PeopleSoft applications to use the Oracle Help Center,see Configuring Context-Sensitive Help Using the Hosted Online Help Website.

Locally Installed HelpIf you’re setting up an on-premise PeopleSoft environment, and your organization has firewall restrictionsthat prevent you from using the hosted PeopleSoft Online Help, you can install the online help locally.See Configuring Context-Sensitive Help Using a Locally Installed Online Help Website.

Downloadable PeopleBook PDF FilesYou can access downloadable PDF versions of the help content in the traditional PeopleBook format onthe Oracle Help Center. The content in the PeopleBook PDFs is the same as the content in the PeopleSoftOnline Help, but it has a different structure and it does not include the interactive navigation features thatare available in the online help.

Common Help DocumentationCommon help documentation contains information that applies to multiple applications. The two maintypes of common help are:

• Application Fundamentals

• Using PeopleSoft Applications

Most product families provide a set of application fundamentals help topics that discuss essentialinformation about the setup and design of your system. This information applies to many or allapplications in the PeopleSoft product family. Whether you are implementing a single application, somecombination of applications within the product family, or the entire product family, you should be familiarwith the contents of the appropriate application fundamentals help. They provide the starting points forfundamental implementation tasks.

Copyright © 1988, 2022, Oracle and/or its affiliates. xv

Preface

In addition, the PeopleTools: Applications User's Guide introduces you to the various elements of thePeopleSoft Pure Internet Architecture. It also explains how to use the navigational hierarchy, components,and pages to perform basic functions as you navigate through the system. While your application orimplementation may differ, the topics in this user’s guide provide general information about usingPeopleSoft applications.

Field and Control DefinitionsPeopleSoft documentation includes definitions for most fields and controls that appear on applicationpages. These definitions describe how to use a field or control, where populated values come from, theeffects of selecting certain values, and so on. If a field or control is not defined, then it either requiresno additional explanation or is documented in a common elements section earlier in the documentation.For example, the Date field rarely requires additional explanation and may not be defined in thedocumentation for some pages.

Typographical ConventionsThe following table describes the typographical conventions that are used in the online help.

Typographical Convention Description

Key+Key Indicates a key combination action. For example, a plus sign (+) between keys means that you must hold down the first keywhile you press the second key. For Alt+W, hold down the Altkey while you press the W key.

. . . (ellipses) Indicate that the preceding item or series can be repeated anynumber of times in PeopleCode syntax.

{ } (curly braces) Indicate a choice between two options in PeopleCode syntax. Options are separated by a pipe ( | ).

[ ] (square brackets) Indicate optional items in PeopleCode syntax.

& (ampersand) When placed before a parameter in PeopleCode syntax, an ampersand indicates that the parameter is an alreadyinstantiated object.

Ampersands also precede all PeopleCode variables.

⇒ This continuation character has been inserted at the end of aline of code that has been wrapped at the page margin. Thecode should be viewed or entered as a single, continuous lineof code without the continuation character.

ISO Country and Currency CodesPeopleSoft Online Help topics use International Organization for Standardization (ISO) country andcurrency codes to identify country-specific information and monetary amounts.

xvi Copyright © 1988, 2022, Oracle and/or its affiliates.

Preface

ISO country codes may appear as country identifiers, and ISO currency codes may appear as currencyidentifiers in your PeopleSoft documentation. Reference to an ISO country code in your documentationdoes not imply that your application includes every ISO country code. The following example is acountry-specific heading: "(FRA) Hiring an Employee."

The PeopleSoft Currency Code table (CURRENCY_CD_TBL) contains sample currency code data. TheCurrency Code table is based on ISO Standard 4217, "Codes for the representation of currencies," andalso relies on ISO country codes in the Country table (COUNTRY_TBL). The navigation to the pageswhere you maintain currency code and country information depends on which PeopleSoft applicationsyou are using. To access the pages for maintaining the Currency Code and Country tables, consult theonline help for your applications for more information.

Region and Industry IdentifiersInformation that applies only to a specific region or industry is preceded by a standard identifier inparentheses. This identifier typically appears at the beginning of a section heading, but it may also appearat the beginning of a note or other text.

Example of a region-specific heading: "(Latin America) Setting Up Depreciation"

Region Identifiers

Regions are identified by the region name. The following region identifiers may appear in the PeopleSoftOnline Help:

• Asia Pacific

• Europe

• Latin America

• North America

Industry Identifiers

Industries are identified by the industry name or by an abbreviation for that industry. The followingindustry identifiers may appear in the PeopleSoft Online Help:

• USF (U.S. Federal)

• E&G (Education and Government)

Translations and Embedded HelpPeopleSoft 9.2 software applications include translated embedded help. With the 9.2 release, PeopleSoftaligns with the other Oracle applications by focusing our translation efforts on embedded help. Weare not planning to translate our traditional online help and PeopleBooks documentation. Instead weoffer very direct translated help at crucial spots within our application through our embedded helpwidgets. Additionally, we have a one-to-one mapping of application and help translations, meaning thatthe software and embedded help translation footprint is identical—something we were never able toaccomplish in the past.

Copyright © 1988, 2022, Oracle and/or its affiliates. xvii

Preface

Using and Managing the PeopleSoft Online Help

Select About This Help in the left navigation panel on any page in the PeopleSoft Online Help to seeinformation on the following topics:

• Using the PeopleSoft Online Help

• Managing Hosted online help

• Managing locally installed PeopleSoft Online Help

Related Links for PeopleSoft HCM

Oracle Help Center

PeopleSoft Online Help Home

PeopleSoft Information Portal

My Oracle Support

PeopleSoft Training from Oracle University

PeopleSoft Video Feature Overviews on YouTube

PeopleSoft Business Process Maps (Microsoft Visio format)

HCM Abbreviations

PeopleSoft Spotlight Series

Contact Us

Send your suggestions to psoft-infodev_us@oracle.com.

Please include the applications update image or PeopleTools release that you’re using.

Follow Us

Field or Control Description

YouTube

xviii Copyright © 1988, 2022, Oracle and/or its affiliates.

Preface

Field or Control Description

Twitter@PeopleSoft_Info.

PeopleSoft Blogs

LinkedIn

Copyright © 1988, 2022, Oracle and/or its affiliates. xix

Chapter 1

Getting Started with Global Payroll forBrazil

Global Payroll for Brazil Overview

Global Payroll for Brazil delivers elements, rules, pages, processes, and reports that work with thePeopleSoft Global Payroll core application to form a complete payroll package for Brazil.

Global Payroll for Brazil delivers earnings for hourly and salaried employees, as well as overtime,bonuses, commissions, and cost allowances and travel expenses. Global Payroll for Brazil also deliversmany common deductions, such as those for union monthly fees, alimony, and dependent deductions. Thesystem enables you to calculate and withhold income tax using the graduated tax rate for monthly payroll,13th salary, and vacation payments. You can set up personal loans for employees. You can track absencesand vacations for employees. With Global Payroll for Brazil, you can calculate termination pay for anemployee. You can set up and run the banking process and process paychecks. With Global Payroll forBrazil, you can generate payslips.

Related LinksGlobal Payroll for Brazil Business Processes

Global Payroll for Brazil Business Processes

The business processes for Global Payroll for Brazil are:

• Banking

• 13th Salary

• Vacations

• Average Salary

• Termination Pay

• Payslips

• Social Security

• Income Tax

• Absences

• Loans

Copyright © 1988, 2022, Oracle and/or its affiliates. 21

Getting Started with Global Payroll for Brazil Chapter 1

• Provisions

We discuss these business processes in the business process topics in this product documentation.

Global Payroll for Brazil Integrations

Global Payroll for Brazil integrates with these applications through the core Global Payroll application:

• PeopleSoft Human Resources (HR).

• PeopleSoft Time and Labor.

• PeopleSoft General Ledger.

We discuss integration considerations in the PeopleSoft HCM: Global Payroll product documentation.

Related Links"Understanding Payee Data" (PeopleSoft Global Payroll)"Understanding How to Compensate Employees in Global Payroll for Time Reported Through Time andLabor" (PeopleSoft Global Payroll)"Understanding the General Ledger Interface" (PeopleSoft Global Payroll)

Global Payroll for Brazil Implementation

PeopleSoft Setup Manager enables you to generate a list of setup tasks for your organization based on thefeatures that you are implementing. The setup tasks include the components that you must set up, listed inthe order in which you must enter data into the component tables, and links to the corresponding productdocumentation.

Other Sources of Information

In the planning phase of your implementation, take advantage of all PeopleSoft sources of information,including the installation guides, table-loading sequences, data models, and business process maps.

Refer to the PeopleSoft HCM 9.2 - Reorganization of Component Interface Permissions (Doc ID2342162.1) MOS posting for a list of system-delivered CIs and their usage, the mapping of CIs andassociated permission lists, and the mapping of CI permission lists and user roles.

See Also PeopleTools: Setup Manager and PeopleTools: Component Interfaces

Related LinksApplication Fundamentals

22 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 2

Understanding Global Payroll for Brazil

Global Payroll for Brazil

Global Payroll for Brazil is a "country extension" of the core Global Payroll application. It provides youwith the payroll rules, elements, and absence processes needed to run a Brazilian payroll.

Global Payroll for Brazil Business Processes

Global Payroll for Brazil supports the following business processes:

• 13th Salary

Global Payroll for Brazil enables you to make 13th salary (Christmas bonus) payments to yourpayees. The system provides 13th salary parameters to define possible variations in 13th salarypayment. The system also enables you to decide when to pay the 13th Salary first installment.

• Vacations

Global Payroll for Brazil enables you to record and track vacations. You can generate vacationentitlements, create mass vacation takes, handle negative entitlement balances, track accrued vacationpremiums for financial reporting, process vacation pay, and generate a vacation payslip.

• Average Salary

Global Payroll for Brazil supports the addition of an allowance (based on the employee's averagevariable pay) to vacation, termination, 13th salary, or maternity pay for employees who receivevariable compensation. To determine which employees are eligible for average salary calculations,you set up the eligibility rules, based on union rules and the Consolidated Labor Laws (CLT). Beforecalculating average salary, you can specify the period of time to consider and whether you want theaverage salary calculations to be adjusted for inflation.

• Termination Pay

You can calculate the final check amount for terminated employees. The system enables you to definedifferent termination legal versions and which earnings/deductions are considered in each version.You can also define which termination versions are linked with each job/action reason.

• Payslips

Global Payroll for Brazil enables you to print payslips for weekly and monthly salaries, 13th salaries,and vacations. Because the format of payslips varies greatly from one company to another, anexample of a payroll payslip and a vacation payslip are provided as a reference when creating yourown payslips. You can define the criteria for printing payslips, so that they display exactly the

Copyright © 1988, 2022, Oracle and/or its affiliates. 23

Understanding Global Payroll for Brazil Chapter 2

information you require. You can prioritize the sort criteria and select the earnings, deductions, andcalculation bases you want to include in the payslip.

• Banking

Using this optional business process, you can pay employees using electronic transfers. The systemenables you to set up different bank layouts for file transfers. After you run a payroll, Global Payrollfor Brazil generates an EFT flat file that instructs the bank how to distribute the funds you sendto them. The process also generates a printed report of payment details. Global Payroll for Brazilsupports the Itaú bank reporting format.

• Social Security

Global Payroll for Brazil provides variables, formulas, deductions, and other rules to calculate andtrack all aspects of social security contributions. Both employers and employees must make a monthlycontribution to social security through the INSS using their own resources to finance the benefitspayable to employees. Calculation is in accordance with Institute's table, which is published monthlyby INSS. The system calculates how companies, third parties, and employees should contribute tosocial security.

• Income Tax

Global Payroll for Brazil provides rules and elements to calculate and deduct withholding of incometax using the graduated tax rate for monthly payroll, 13th salary, and vacation payments. The systemalso tracks the following allowable deductions: alimony, qualifying dependents, social securitycontributions, pension and retirement contributions, and retirement and pension income. There is alsoa report that shows the details of the employee's dependent data used for calculating income tax.

• Absences

You can use the system's predefined rules for processing absences. You may modify some of theabsence rules and create new ones to reflect you organization's policies. You can also assess theimpact of an absence using the Absence Forecasting process.

• Loans

It is a common practice for Brazilian companies to grant personal loans or pay for assets and serviceson behalf of their employees. Global Payroll for Brazil enables you to maintain these loans, createpayback schedules and modify the deduction of such values previously loaned to employees. You canadjust the loan by any rate and change the value of the deduction. On termination, the outstandingbalance must be deducted. The loan may be deducted from normal payroll, vacation, 13th salary ortermination.

• Provisions

Global Payroll for Brazil provides elements to calculate provisions for vacations and 13th salary.After the system calculates the provisions, you can generate a provisions report.

Related LinksUnderstanding the Banking Process for BrazilUnderstanding the 13th SalaryEntering Vacation Data and Updating EntitlementUnderstanding Average Salary Calculations

24 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 2 Understanding Global Payroll for Brazil

Understanding the Payslip Definition ProcessUnderstanding INSS ContributionsUnderstanding Income Tax WithholdingUnderstanding Absence Entry in BrazilUnderstanding Loans in BrazilUnderstanding Legal Provisions

Delivered Elements for Brazil

This section discusses:

• Creation of delivered elements.

• Element ownership and maintenance.

Creation of Delivered ElementsPeopleSoft Global Payroll defines each business process for Brazil in terms of delivered elements andrules. Some of these elements and rules are specifically designed to meet legal requirements, while otherssupport common or "customary" payroll practices.

All of the elements and rules delivered as part of your country extension were created using the coreapplication—the same application you will use both to create additional elements or rules, and (in manycases) to configure existing elements delivered as part of your Global Payroll system. Because the toolsneeded to redefine or create new payroll elements are fully documented in the core application productdocumentation, this documentation does not reproduce this information. Instead, it briefly reviews therelationship between the core application (which contains the tools you need to define your own elementsand rules) and the country extensions (which contain country-specific rules and elements defined byPeopleSoft).

The core application has the following characteristics:

• It consists of a payroll rules engine—a flexible tool that enables users to define the rules and elementsof their payroll system and perform payroll and absence calculations.

Global Payroll does not embed payroll-specific logic or computations in application code. Instead,it specifies all business application logic, such as earnings, deductions, absences, and accumulators,in terms of payroll rules and elements. Global Payroll enables the user to enter and maintain payrollrules through a set of pages and offers a comprehensive set of features that enable the user to work intheir preferred language or currency.

• It provides a payroll processing framework—a flexible way to define and run payroll and absenceprocessing flows, such as calendars, run types, pay periods, and process lists.

Country extensions have the following characteristics:

• They are built using the core application.

• They consist of statutory and customary objects (country-specific payroll rules, elements, payrollprocesses, reports, pages, and self-service applications).

Copyright © 1988, 2022, Oracle and/or its affiliates. 25

Understanding Global Payroll for Brazil Chapter 2

PeopleSoft delivers a query that you can run to view the names of all delivered elements designed forBrazil. Instructions for running the query are provided in the PeopleSoft HCM: Global Payroll productdocumentation.

Related Links"Understanding How to View Delivered Elements" (PeopleSoft Global Payroll)

Element Ownership and MaintenanceThe delivered elements and rules of your Global Payroll country extension can be classified according towhether they are owned and maintained by the customer or by PeopleSoft. Some elements and rules aremaintained exclusively by PeopleSoft and cannot be modified, while others can be configured to meetrequirements unique to each organization.

Element Ownership in PeopleSoft Global Payroll

There are five categories of element ownership in Global Payroll.

Term Definition

PS Delivered/Maintained Elements delivered and maintained on an ongoing basis byPeopleSoft.

PS Delivered/Not Maintained Elements PeopleSoft delivers that can be modified orreconfigured by the customer. This category consistsprimarily of either customary (non-statutory) rules or statutoryelements that customers may want to define according to adifferent interpretation of the rules. Although PeopleSoft mayoccasionally update elements defined as PS Delivered/NotMaintained, you are not required to apply these updates.

Customer Maintained Elements created and maintained by your organization. PeopleSoft does not deliver rules defined as CustomerMaintained.

PS Delivered/Customer Modified Elements that were originally PS Delivered/Maintainedelements over which the customer has decided to take control (this change is irreversible).

PS Delivered / Maintained / Secure Delivered elements that the customer can never modify orcontrol.

Element Ownership in Global Payroll for Brazil

Of the five ownership categories listed here, only the following two are used to define Brazilian elements:PS Delivered/Maintained and PS Delivered/Not Maintained. Although Global Payroll for Brazil deliverssome elements as PS Delivered/Maintained, the large majority of elements are designated PS Delivered/

26 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 2 Understanding Global Payroll for Brazil

Not Maintained. This enables you to modify, update, and reconfigure the delivered elements to meetneeds that are specific to your organization.

Note: In general, Global Payroll for Brazil uses the ownership category PS Delivered/Not Maintainedexcept where the modification of an element might interfere with calculations designed to satisfy strict(and generally invariable) legal requirements. The value of this approach is clearly evident in the setupof delivered accumulators. Because balance accumulators (for example, those storing taxable grosson a year-to-date basis) must be set up to comply with rigid legal requirement for reporting taxes andcontributions, Global Payroll for Brazil defines them as PS Delivered/Maintained (meaning you cannotmodify or directly add new elements to them). However, you can add new elements to these accumulatorsusing the delivered segment accumulators, which serve as the basic entry point into the system and arenot maintained by PeopleSoft. Therefore, when you define a new earning or deduction, you can assign theelement to a segment accumulator, and the segment accumulator automatically contributes to the correctbalance accumulators.

Related Links"Defining Element Names" (PeopleSoft Global Payroll)

Naming Convention for Delivered Elements

This section discusses:

• Element names.

• Functional area codes.

• Element type codes (PIN_TYPE).

Element NamesOne of the keys to understanding how delivered payroll elements function in the system is to understandtheir names. Understanding the naming convention developed for PeopleSoft-delivered elements canhelp you determine how an element is used, the element type, and even the functional area it serves.Depending on whether the element is a primary element, a component of a primary element, or asupporting element, one of the following naming conventions applies.

Supporting Elements

For supporting elements, such as variables, formulas, dates, durations, and so on, PeopleSoft uses thefollowing naming convention: FF TT NAME.

• FF: Functional Area Code (see Functional Area Codes for more information).

• TT: Type of Supporting Element (see List of Element Type Codes for more information).

• NAME: The name is based on a term in Portuguese and provides a further means of identifying theelement.

For example, in the tax array MD VR SUMA MED, MD represents the functional area, VR represents theelement type, and SUMA MED (Soma a Médias) provides a further means of identifying the element.

Copyright © 1988, 2022, Oracle and/or its affiliates. 27

Understanding Global Payroll for Brazil Chapter 2

Note: This naming convention applies to the following element types: arrays, brackets, counts, dates,durations, formulas, variables, historical rules, fictitious calculation rules, proration rules, rounding rules,writable arrays, and generation control conditions.

Primary Elements

Primary elements, such as earnings, deductions, accumulators, absence take, and absence entitlementelements generally do not contain functional area codes or element type codes in their names. This isbecause primary elements have names, based on Brazilian terms, that identify their function and elementtype without the use of additional codes. For example, the name of the earning element SALARIO MENSclearly identifies this element as an earning, and more specifically, as a base salary element.

Other Elements

Although there is no fixed naming convention for sections and element groups, Global Payroll for Brazilcommonly uses the following naming convention: FF NAME.

• FF: Functional Area Code (see Functional Area Codes for more information).

• NAME: The name is based on a term in Portuguese and provides a further means of identifying theelement.

For example, a section in a process list for Brazil might be named KR VENCIMENTOS, where KR is anidentifier and VENCIMENTOS provides a means of uniquely identifying the element.

Additional Clues to the Use of Brazilian Elements

Many Brazilian elements contain abbreviations that provide clues (beyond those provided by thefunctional area codes or element type codes) to their use in the system. For example, consider the durationelement FE DR DIAS AFA PER. While the functional area code FE indicates that this element is used forvacations, and the element type code DR identifies them as duration elements, the abbreviations AFA andPER provide additional clues to how the element is used. In this example, AFA stands for Afastamento(absences) and PER stands for Periodo (period). As you become more familiar with the payroll rulescreated for Brazil, these abbreviations will help you to further identify and understand the role played byeach element.

The following table lists the most common abbreviations used in the names of Brazilian elements:

Abbreviations Used inGlobal Payroll for Brazil

Portuguese English

NUM or QTD Número Number

%, PERC Porcentagem Percentage

ATU Atual Current

ACUM Acumulado Balances

28 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 2 Understanding Global Payroll for Brazil

Abbreviations Used inGlobal Payroll for Brazil

Portuguese English

13, 13º, 13S, 13 SAL Décimo Terceiro Salário Christmas Bonus

INVE Investimentos Savings

ALIM Alimenticia Alimony

ANTIG Antiguidade Seniority

ANU Anual Annual

ANV or ANIV Aniversário Anniversary

ASSO Associar Assign

ASST Assistência Assistance

CAL, CALEN Calendärio Calendar

CALC Cálculo Calculation Process

EMP, CIA Empresa ou Companhia Company

COMP Compensar Compensate

CRE or CRED Crédito Credit

QUO, QUT Quota Quote or Fee

DED, DE Dedução Deduction

DES, DESP Desconto e Despesas Discount, Food, or Rest andExpenses

ALIM Alimento Food

DEV Devolução Return

Copyright © 1988, 2022, Oracle and/or its affiliates. 29

Understanding Global Payroll for Brazil Chapter 2

Abbreviations Used inGlobal Payroll for Brazil

Portuguese English

DF, DIF Diferença Difference

DOBR Dobro Doubles

DOM or DOMIN Domingo Sunday

$$ Dinheiro Cash

ESP Especial Special

EX, EXTR Extra Non Taxable or Over

EXC or EXCE Excedente In Excess

ISEN Isento Non Taxable

FAT, FATOR Fator Factor

FED Federal Federal

FEST Dia Festivo ou Feriado Holiday

FIC or FICT Fictício Fictitious

FIX Fixo Fix

FRE or FREQ Freqüência Frequency

TRIBUT, TRIB Tributável Taxable

HOR Hora, Horista Hours

IMP, IR Imposto ou Imposto de Renda Tax or Amount

INC or INCAP Incapacidade Disability

VEN Vencimentos Earnings

30 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 2 Understanding Global Payroll for Brazil

Abbreviations Used inGlobal Payroll for Brazil

Portuguese English

LIM Limite Limit or Boundary

QUIT, RESC Liquidação Lay off

MIN Mínimo Minimum

NEG Negativo Negative

PER Período Period

VENC Vencimentos Earnings

PREM Prêmio Premium

EMPR Empréstimo Loan

ME Média Average

PROD Produzidas Produced

PROP Proporção ou Proporcional Proportion or Proportional

PROV Provisão Provision

PROJ Projetado Projected

RETID Retido Withheld

RETRO Retroativo Retroactive

INT, INTER Intervalo Rank

RIS, RISC Risco Risk

SAL Salário Salary

SEGM Segmento Segment

Copyright © 1988, 2022, Oracle and/or its affiliates. 31

Understanding Global Payroll for Brazil Chapter 2

Abbreviations Used inGlobal Payroll for Brazil

Portuguese English

SUB Subsídio Subsidy

SUP Superior Top Limit

TET Teto, topo Cap

TOT Total Total

TRA or TRAB Trabalhado Worked

TRIP, TRIPL Triplo Triple

ULT Último Last

UNI or UNID Unidades Units

FER , FERIAS Férias Vacations

VAL Vales Coupons

VAR or VARIAV Variável Variable

/ Por Per

Component Names (Suffixes)

In Global Payroll for Brazil, suffixes are used to name the components of earning and deduction elements.For example, when you create an earning, deduction, or absence element in PeopleSoft Global Payroll,you must define the components that make up the element, such as base, rate, unit, and percentage. Thesystem automatically generates the components and accumulators for the element based on the calculationrule or accumulator periods that are used. The system also names the components and accumulators byappending a suffix to the element's name.

Note: To view all the suffixes defined for your country, use the Element Suffixes page in the core GlobalPayroll application.

For example, let's say you define the earning element named EARN1 with the following calculation rule:

EARN1 = Rate × Unit

32 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 2 Understanding Global Payroll for Brazil

The system automatically creates two additional elements for the components in the calculation rule: arate element called EARN1_RATE and a unit element called EARN1_UNIT.

As you can see, the system creates suffixes to name the components of the element (_RATE and _UNIT).In Global Payroll all suffixes fall into one of the following types:

• Separator.

• Earnings/deductions component suffixes.

• Earnings/deductions accumulator suffixes.

• Deduction arrears component suffixes.

• Absence entitlement component suffixes.

• Absence entitlement accumulator suffixes.

In Global Payroll for Brazil, the following suffixes are pre-delivered.

Separator

The separator is defined as: _ (underscore)

Component Suffixes

The following table lists the component suffixes delivered for Brazil:

Component Suffix

Base BASE

Percentage PERC

Rate VRREF

Unit UNID

Accumulator Suffixes

The following table lists the accumulator suffixes delivered for Brazil:

Accumulator Suffix - CalendarPeriod: Amount

Suffix - CalendarPeriod: Unit

Suffix - FiscalPeriod: Amount

Suffix - CalendarPeriod: Unit

Calendar Period to Date VRPER UNPER VRPEF UNPEF

Month to Date VRMEN UNMEN VRMEF UNMEF

Copyright © 1988, 2022, Oracle and/or its affiliates. 33

Understanding Global Payroll for Brazil Chapter 2

Accumulator Suffix - CalendarPeriod: Amount

Suffix - CalendarPeriod: Unit

Suffix - FiscalPeriod: Amount

Suffix - CalendarPeriod: Unit

Quarter to Date VRTRI UNTRI VRTRF UNTRF

Year to Date VRANU UNANU VRANF UNANF

Deduction Arrears Component Suffixes

The following table lists the deduction arrears component suffixes delivered for Brazil:

Deduction Arrears Component Suffix

Payback DEVOL

Amount not Taken NDES

Add to Arrears ACINS

Arrears Accumulator INSUF

Absence Entitlements Suffixes

The following table lists the absence entitlement suffixes delivered for Brazil:

Absence Entitlement Component/Accumulator Suffix

Separator _

Unit Paid UNPAGComponent

Unit Adjustment UNAJU

Balance SALDO

Adjustment AJUST

Entitlement DIR

Accumulator

Take AUSEN

34 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 2 Understanding Global Payroll for Brazil

Related Links"Defining Suffixes" (PeopleSoft Global Payroll)

Functional Area CodesThe following table contains the functional area codes used in the names of Brazilian elements:

Functional Area Description

FP General (Folha de Pago)

RE Earnings (Remunerações)

FA Absences (Faltas, Atrazos, Afastamentos e Licenças)

MD Average salaries (Médias)

RC Terminations (Rescisão Contratual)

FE Vacations (Férias)

13 13th salary (13o. Salário)

CS Union contributions (Contribuições a Sindicatos)

IN Social security (INSS)

PA Alimony (Pensão Alimentícia)

IR Income tax (Imposto de Renda)

EP Loans (Empréstimos)

VT Transportation tickets (Vale Transporte)

AD Advance Payment (Adiantamento)

SF Family Allowance (Salário Família)

FG FGTS (Fundo de Garantia por Tempo de Serviço)

Copyright © 1988, 2022, Oracle and/or its affiliates. 35

Understanding Global Payroll for Brazil Chapter 2

Element Type Codes (PIN_TYPE)The following table contains codes for all the element types. Because not all element types are deliveredfor Brazil, not all of these codes appear in the names of Brazilian elements.

Element Type Description

AE Absence Entitlement

AT Absence Take

AC Accumulator

AR Array

AA Auto Assigned

BR Bracket

CT Count

DT Date

DD Deduction

DR Duration

ER Earnings

EG Element Group

EM Error Message

FC Fictitious Calculation

FM Formula

GC Generation Control

HR Historical Rule

PR Process List

36 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 2 Understanding Global Payroll for Brazil

Element Type Description

PO Proration Rule

RC Rate Code

RR Rounding Rule

SE Section

SY System Element

VR Variable

WA Writable Array

Data Archiving for Global Payroll for Brazil

Global Payroll for Brazil delivers an archiving tool called the Data Archive Manager with a predefinedarchive object (GPBR_RSLT_ARCHIVE) and an archive template (GPBRRSLT) that you can use toarchive your payroll results data. The delivered archive template uses queries to select and store data bycalendar group ID (CAL_RUN_ID field).

Note: Exercise extreme caution when making changes to delivered archive objects, queries, or templates.Any modifications can result in the loss of important data.

See "Archiving Global Payroll Data" (PeopleSoft Global Payroll).

How to View Delivered Elements

The PeopleSoft system delivers a query that you can run to view the names of all delivered elements thatare designed for Brazil. Instructions for running the query are provided in the PeopleSoft HCM: GlobalPayroll product documentation.

Related Links"Understanding How to View Delivered Elements" (PeopleSoft Global Payroll)

Copyright © 1988, 2022, Oracle and/or its affiliates. 37

Understanding Global Payroll for Brazil Chapter 2

38 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 3

Defining Country Data

Setting Up Utilities in Global Payroll for Brazil

To set up utilities in Global Payroll for Brazil, use the Define Variable Attributes BRA(GPBR_COMP_VARS) and the Map Elements to Component BRA (GPBR_ELEM_MAP) components.

This topic provides an overview of element mapping and discusses how to set up utilities in GlobalPayroll for Brazil.

Note: This setup is optional and is designed to help technical people manipulate PIN numbers duringdevelopment.

Pages Used to Set Up Utilities in Global Payroll for Brazil

Page Name Definition Name Usage

Define Variable Attributes BRA Page GPBR_COMP_VARS Define the variables for components tobe used on the Map Elems to Comp/RcdBRA page to define the variable type.

Map Elems to Comp/Rcd BRA Page (map elements to component/recordBRA page)

GPBR_ELEM_MAP Set up the mapping to the fields andvariables of an element which are usedduring development in the componentsinterface objects.

Understanding Element MappingThe element map plays a critical role when packaging and moving elements and data to other databases.

PIN numbers are used in PeopleCode, component interfaces, and reports to refer to global elements. ThePIN number is a consecutive number so it can change between databases or releases; therefore, there isa need to create a utility during development so that the PIN number is not hard-coded. Using the utilityalso ensures consistency between the PIN number changes.

There are two ways to map an element:

• By record

• By component

Select record when you need to map a record field into a core Global Payroll element.

Copyright © 1988, 2022, Oracle and/or its affiliates. 39

Defining Country Data Chapter 3

Select component when the mapping doesn't depend on a record field; instead, it depends on somebehavior on the page, for example, the record is used in more than one place and must map to differentcore Global Payroll elements.

If you select to map an element by component, you may want to define your component variables on theDefine Variable Attributes BRA page before you define your element mapping.

PeopleCode Function Example

When you need to use a PIN number in the PeopleCode, use this function to obtain the corresponding PINnumber:

Declare Function Get_Pin_Num PeopleCode GPBR_DERIVED_EM.PIN_NUM FieldFormula;&Record_Name = "GPBR_LOAN";&Date_Pin_Num = Get_Pin_Num ("R", &Record_Name, "DATE");

Define Variable Attributes BRA PageUse the Define Variable Attributes BRA page (GPBR_COMP_VARS) to define the variables forcomponents to be used on the Map Elems to Comp/Rcd BRA page to define the variable type.

Navigation:

Set Up HCM > Product Related > Global Payroll & Absence Mgmt > Elements > Define VariableAttributes BRA > Define Variable Attributes BRA

This example illustrates the fields and controls on the Define Variable Attributes BRA page.

Field or Control Description

Variable Name Enter the name of the variable. This can be any name you wantto use during PeopleCode development.

Variable Type Select the variable type. Values include Character, Date, DateTime, Image, Long Char, Numeric, Signed Number and Time.

Note: Once you have defined your component variables, youcan map your elements on the Map Elems to Comp/Rcd BRApage.

40 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 3 Defining Country Data

Map Elems to Comp/Rcd BRA PageUse the Map Elems to Comp/Rcd BRA (map elements to component/record) page (GPBR_ELEM_MAP)to set up the mapping to the fields and variables of an element which are used during development in thecomponents interface objects.

Navigation:

Set Up HCM > Product Related > Global Payroll & Absence Mgmt > Elements > Map Elementsto Component BRA > Map Elems to Comp/Rcd BRA

This example illustrates the fields and controls on the Map Elems to Comp/Rcd BRA page.

If you choose to map your elements by component, you may want to define your component variablesbefore you map your elements.

Field or Control Description

Type The key type that your mapping applies to appears here. Values include Other and Field.

Map Value Select the field or value to which you want to map. If youselected Record as the key type, you can select the recordfields. If you selected Component as the key type, then youcan select the variables defined for the component.

Copyright © 1988, 2022, Oracle and/or its affiliates. 41

Defining Country Data Chapter 3

Field or Control Description

Entry Type Select the element type on which you want to transform yourfield or variable. Values are Accumulator, Bracket - Numeric, Count, Deduction, Earnings, Formula - Numeric, Rate Code, Rate Code - Amount, Hrly+Amt, Variable - Numeric, Variable- Pointer, and Variable - Dec+Char+Date+Ptr. The valuesavailable depend on the map value type. For example, ifyou select a character map value, then you can select onlycharacter values.

Note: Although you can see System Element - Numeric as avalue, you cannot select it. The entry type cannot be a systemelement or a constant.

Name Select the name of the element.

Viewing Delivered ElementsThe PeopleSoft system delivers a query that you can run to view the names of all delivered elementsdesigned for Brazil. Instructions for running the query are provided in the PeopleSoft HCM: GlobalPayroll product documentation.

Related Links"Understanding How to View Delivered Elements" (PeopleSoft Global Payroll)

Selecting Report Elements and Defining Payslip Sort Order

To select report elements and define the sort order for payslips, use the Element Lists BRA(GPBR_PAYSLIP_FORMA) component and the Sort IDs BRA (GPBR_SORTID) component.

This topic discusses how to select report elements and define payslip sort order.

Pages Used to Select Report Elements and Define Payslip Sort Order

Page Name Definition Name Usage

Element Lists BRA Page GPBR_PAYSLIP_FORMA Select earnings, deductions, andcalculation bases eligible for printing formultiple reports, including payslips andpayroll results register.

Sort IDs BRA Page GPBR_SORTID Define the printing order selection forthe payslip.

42 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 3 Defining Country Data

Element Lists BRA PageUse the Element Lists BRA page (GPBR_PAYSLIP_FORMA) to select earnings, deductions, andcalculation bases eligible for printing for multiple reports, including payslips and payroll results register.

Navigation:

Set Up HCM > Product Related > Global Payroll & Absence Mgmt > Reports > Element ListsBRA > Element Lists BRA

This example illustrates the fields and controls on the Element Lists BRA page (1 of 2).

This example illustrates the fields and controls on the Element Lists BRA page (2 of 2).

Copyright © 1988, 2022, Oracle and/or its affiliates. 43

Defining Country Data Chapter 3

Note: The Element Lists BRA page is used in the financial register and payroll results register reports, aswell as payslip generation.

Field or Control Description

Total Earnings Select the accumulator that contains the earnings total. Thevalue of this accumulator prints as the total earnings on thereport or payslip.

Total Deductions Select the accumulator that contains the deductions total. Thevalue of this accumulator prints as the total deductions on thereport or payslip.

Net Pay Select the accumulator that contains the net payment. Thevalue of this accumulator prints as the difference between totalearnings and total deductions on the report or payslip.

Legal Code Enter the corresponding 4-digit legal code that you want to seeprinted on the Termination Contract report.

Earnings, Deductions, and Accumulator

In these group boxes, indicate whether you want to include or exclude the earning or deduction elementsyou list. It is up to you to decide if it is easier to define the elements by inclusion or exclusion.

Enter the accumulators you want to appear as informative data on the report or payslip.

Sort IDs BRA PageUse the Sort IDs BRA page (GPBR_SORTID) to define the printing order selection for the payslip.

Navigation:

Set Up HCM > Product Related > Global Payroll & Absence Mgmt > Payslips > Sort IDs BRA >Sort IDs BRA

44 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 3 Defining Country Data

This example illustrates the fields and controls on the Sort IDs BRA page.

Field or Control Description

Sort by and Then by Enter the criteria you want the payslip to sort by first in theSort by field. Enter additional criteria, in the order you wantto sort by, using theThen by fields. Values include Company, Department, Employee ID, Employee Name, EmployeeType, Establishment, Location, Pay Entity, Pay Group, andSupervisor Code.

The order in which you define your sort criteria determines theorder in which information is printed on the payslip.

In descending order Select if you want the sort order to be in descending order. Thedefault sort order is in ascending order.

Defining Service Takers

To set up service takers, use the Service Takers BRA (GPBR_SERVICE_TAKER) component.

This topic discusses how to set up service takers.

Service takers are companies that buy services from your company. For example, if your company is aconsulting company, all the different companies where your employees work during a defined period oftime are considered to be service takers.

Copyright © 1988, 2022, Oracle and/or its affiliates. 45

Defining Country Data Chapter 3

Page Used to Define Service Taker Data

Page Name Definition Name Usage

Service Takers BRA Page GPBR_SERVICE_TAKER Set up service takers to use for data entrypurposes. The SEFIP report uses servicetaker information.

Service Takers BRA PageUse the Service Takers BRA page (GPBR_SERVICE_TAKER) to set up service takers to use for dataentry purposes.

Both SEFIP and eSocial reports use service taker information.

Navigation:

Set Up HCM > Product Related > Global Payroll & Absence Mgmt > Framework >Organizational > Service Takers BRA > Service Takers

This example illustrates the fields and controls on the Service Takers BRA page.

46 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 3 Defining Country Data

Location

Field or Control Description

Inscription Type Select the type of ID that identifies the service taker. Valuesare CEI and CNPJ.

Inscription Number Enter the ID that identifies the service taker.

Establishments List

Field or Control Description

All Establishments Click this button to add all of the valid establishmentsfor a service taker. The Establishments region enablesyou to define the relationship between service takers andestablishments.

Establishments

Field or Control Description

Service Taker Tp (service taker type) Select the type of service contracted by the establishment, which is legal entity, according to eSocial requirements.

Contract Begin Date Enter the date when the contract between the establishmentand the service taker began.

By default, the system populates this field with the servicetaker’s effective date (currently displayed on the page), or theearliest effective date of the establishment, whichever is thelatest.

This information is used in eSocial reporting.

Copyright © 1988, 2022, Oracle and/or its affiliates. 47

Defining Country Data Chapter 3

Field or Control Description

CNO Owner Select the CNO or CEI responsible. Values are:

Estab (establishment)

Not Applicable

Other

Service Taker

If Other is selected, the CNPJ Owner field becomes availablefor edits.

Note: This field is required only if the service taker is related aconstruction establishment with partial contract.

CNPJ Owner Enter the CNPJ register number of the CEI responsible. Thisvalue is required if Other is selected in the CNO Owner field.

Related LinksService Taker Transactions BRA PageService Taker Data BRA Page

Defining Union Parameters

To set up union parameters, use the Union Parameters BRA (GPBR_UNION_PARMS) component.

This topic discusses how to set up union parameters.

Pages Used to Define Union Parameters

Page Name Definition Name Usage

General Parameters Page GPBR_UNION_PARM Set up union parameters.

Averages Page GPBR_AVERAGES Set up average salaries.

Supporting Elements Override Page GPBR_SOVR_VAL Override the value of bracket, date, duration, formula, or variable elementsthat are associated with a specified unionparameter setup.

48 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 3 Defining Country Data

General Parameters PageUse the General Parameters page (GPBR_UNION_PARM) to set up union parameters.

Navigation:

Set Up HCM > Product Related > Global Payroll & Absence Mgmt > Framework >Organizational > Union Parameters BRA > General Parameters

This example illustrates the fields and controls on the General Parameters page (1 of 2).

Copyright © 1988, 2022, Oracle and/or its affiliates. 49

Defining Country Data Chapter 3

This example illustrates the fields and controls on the General Parameters page (2 of 2).

Union parameters enable you to enter the details of agreements between unions and companies.

The fields on this page are monthly percentages and amounts.

Union Details

Field or Control Description

Min Guaranteed Commissionists (minimum guaranteedcommissionists)

Enter the minimum guaranteed monthly allowance that anemployee receives if the employee is one hundred percentcommissioned and has no salary earnings assigned in a givenmonth of work.

Union Monthly Contribution Pct (union monthlycontribution percent)

Enter the percentage of the employee's salary to contribute formonthly union dues. To have this contribution made, you mustenter the union code in the Alternate Union Code field on theJob Information page.

MaxUnion Monthly Contribution (maximum union monthlycontribution)

Enter the maximum amount to contribute for monthly uniondues.

Confederative Contribution Pct (confederative contributionpercent)

(Optional) Enter the percentage of the employee's salary tocontribute as a confederation contribution.

Max Confederate Contribution (maximum confederatecontribution)

Enter the maximum amount for a confederation contribution.

50 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 3 Defining Country Data

Field or Control Description

Attendance Contribution Pct (attendance contributionpercent)

(Optional) Enter the percentage for an attendance contribution. An employee can refuse to pay this contribution.

Max Attendance Contribution (maximum attendancecontribution)

Enter the maximum amount for an attendance contribution.

Transport Coupons Pct (transport coupons percent) Enter the maximum percentage of an employee's salary thatcan be used for transportation costs. By law, this amountcannot be more than 6 percent, but a union may have anagreement for a lower percentage.

Monthly Proration Method

Field or Control Description

Hiring Monthly Select how to pay the employee's salary, on calendar days oron a 30-day month basis.

For example, for an employee hired on February 28, theemployee receives payment for:

• One day if the Calendar Days option is selected.

• Three days if the 30 days Monthly Basis option isselected.

13th Salary Parameters

Field or Control Description

Calc Average First Installment (calculate averages on firstinstallment)

Select to have the system base an employee's 13th salary (firstpartiality) on his or her average salary calculation rather thanon the monthly salary.

Recalc First Installment (recalculate first installment) Select to indicate the system should recalculate the firstinstallment of the 13th salary. Since the 13th salary payment isrun in November, salary changes may occur that could causesome employees to receive an extra first installment of the13th salary. The system needs to recalculate 13th salary tomake sure that employees receive any extra payments they aredue.

Copyright © 1988, 2022, Oracle and/or its affiliates. 51

Defining Country Data Chapter 3

Termination and Stability Parm (termination and stability parameters)

Field or Control Description

Count Days-13 sal/prior notif (13th salary/prior notification) Select to make it required to provide advance notice prior totermination. By law, you must provide at least 30 days notice.

Allows Term. When Stability (allows termination whenstability)

Select to allow an employee to be terminated when he or shehas tenure.

Work Related Accident Select the absence take element for work related accidents.

Salary Base Rate

Use this section to select additional earnings to be considered base salaries, if applicable. Available basesalary types include Vacations, 13th Salary, and Overtime.

For example, you may select from a number of bonuses to be considered for base vacation rate. The basesalary to pay vacations is either monthly salary or trainee monthly salary, which means that if you don'tselect in the payee parameters any of the bonuses selected in this section, the vacation is paid using themonthly salary or the trainee monthly salary method depending on the employee class.

The rules read these values and store them in new variables during the resolution of the Union Parametersarray. The FER REMUN MEN accumulator uses these new variables in that way that each member of theaccumulator contributes 100% or 0% according to the value read in the Union Parameters array.

Field or Control Description

Process Type Select a process type. Values are 13th Salary, Overtime, andVacations.

Element Type Select an earning element for the selected process type. Available values include:

QUINQUEN MEN (Lustrum)

PERIC MEN (Hazardous Bonus Monthly)

INSALU MEN (Unhealthy Additional)

GRAT FUN MEN (Bonus of Function)

GRAT SUB MEN (Bonus of Substitution)

SALARIO MENS (Salary)

BOLSA AUX ME (Bolsa Auxilio Estagiario)

ADIC TRA MEN (Additional of Transfer)

52 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 3 Defining Country Data

Field or Control Description

Percentage Enter a percentage number for the associated element to beconsidered for the associated base salary rate (13th salary, overtime, or vacation). Enter a number from 0 (not to beincluded as salary) to 100 (to be included entirely as salary).

Union Contract Revision

Information entered in this section is used in SEFIP 650 reporting as well as eSocial reporting.

Field or Control Description

Begin Date and End Date Specify the start and end dates of the contract revision, forexample, collective agreement.

Gathering Attribute Select the applicable collective agreement. Values are:

05 - Collective Dispute

06 - Collective Agreement

07 - Collective Convention

08 - Previous Reconciliation

Collective Agreement Signature Enter the date the agreement was signed.

Setting Up Payee Data

This topic discusses how to define payee data for Brazil.

Pages Used to Define Payee Data for Brazil

Page Name Definition Name Usage

Maintain Payee-Union Data BRA Page GPBR_PYE_UN_DATA Add, modify, or delete union-relatedpayee information.

Payee Parameters Page GPBR_PAYEE_PARM Define payee parameters.

Termination Parameters Page GPBR_PYEST_PARM Define termination parameters.

Copyright © 1988, 2022, Oracle and/or its affiliates. 53

Defining Country Data Chapter 3

Page Name Definition Name Usage

PIS Parameters Page GPBR_PYPIS_PARM Define PIS parameters for an individualpayee.

FGTS and Stability Page GPBR_PYSTB_PARM Enter FGTS and stability information.

RAIS Parameters Page GPBR_PYRAIS_PARM Define an individual's RAIS (RelaçãoAnual das Informações Sociais)parameters, for Brazil's annual socialinformation report.

Employee Other Annual Amt BRA Page GPBR_OTH_EE_AMT Add, modify, or delete health care-related payee information.

Labor Reform UpdateOn November 11, 2017, a new labor rule on union contribution was implemented as part of the LaborReform.

Under the new reform, union contribution is no longer mandatory to employees. The deduction ofunion contribution using the CONTR SIND element only applies to employees who have the CSVR UC APROBACO variable (Union Contribution Approval) set to 1 on the "Supporting ElementsPage" (PeopleSoft Global Payroll).

If the variable value is set to 1, it means that the union contribution has been approved to be deducted forthe associated employee.

If the variable value is set to 0, or if the variable override is not added, no deduction will occur for theassociated employee.

For contributions that are made pertaining to the application of technical knowledge and training ofemployees, they continue to be recorded manually on the Maintain Payee-Union Data BRA Page as usual;no union contribution deduction will be applied.

Maintain Payee-Union Data BRA PageUse the Maintain Payee-Union Data BRA page (GPBR_PYE_UN_DATA) to add, modify, or deleteunion-related payee information.

Navigation:

Global Payroll & Absence Mgmt > Payee Data > Payee Union Contribution BRA > MaintainPayee-Union Data BRA

54 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 3 Defining Country Data

This example illustrates the fields and controls on the Maintain Payee-Union Data BRA page.

The system uses the information that you enter here when it calculates the employee's annualcontribution.

Field or Control Description

Calculation Type Displays the calculation type of the union contribution enteredfor the payee. Values are:

Manual: indicates that this row of information is being addedmanually to the system, and can be updated or deleted asnecessary.

Calculated: indicates that payroll is finalized, and the unioncontribution deduction amount (as updated by the CS WACONTR SIND array) is displayed on this page. Calculatedtype rows are read-only.

Payee Parameters PageUse the Payee Parameters page (GPBR_PAYEE_PARM) to define payee parameters.

Navigation:

Global Payroll & Absence Mgmt > Payee Data > Define Payee Parameters BRA > PayeeParameters

Copyright © 1988, 2022, Oracle and/or its affiliates. 55

Defining Country Data Chapter 3

This example illustrates the fields and controls on the Payee Parameters page (1 of 2).

This example illustrates the fields and controls on the Payee Parameters page (2 of 2).

The parameters you enter on this page insert a Supporting Element Override variable field at the payeelevel.

56 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 3 Defining Country Data

Payee Parameters

Field or Control Description

Begin Date Enter the effective date for these parameters.

The payee’s begin date must be greater than the hire date.

End Date Enter the date these parameters are no longer valid. You mustenter an end date before you can add a row with a new set ofparameters.

SEFIP Risk Level Select the appropriate risk level for the employee's activities. The system uses this information to generate the SEFIP reportand to determine the employee's retirement deduction.

Note: Setting a value in this field overrides the value specifiedon the Additional Info - BRA page.

See Calculating INSS for Special Retirement.

See "(BRA) Providing Additional Information for BrazilianEmployees" (PeopleSoft Human Resources AdministerWorkforce).

Unhealthy Indicator Select the appropriate health risk level for the employee'sactivities. The system uses this indicator to calculate anearning that compensates for this health risk factor.

Values are Default, Maximum Grade, Middle Grade, MinimumGrade, and Not Applicable.

Note: Setting a value in this field overrides the value specifiedon the Additional Info - BRA page.

See "(BRA) Providing Additional Information for BrazilianEmployees" (PeopleSoft Human Resources AdministerWorkforce).

Copyright © 1988, 2022, Oracle and/or its affiliates. 57

Defining Country Data Chapter 3

Field or Control Description

Risk Indicator Select the appropriate hazard level for the employee'sactivities. The system uses this indicator to calculate anearning that compensates for this hazardous factor.

Values are Applicable, Default, and Not Applicable.

Note: Setting a value in this field overrides the value specifiedon the Additional Info - BRA page.

See "(BRA) Providing Additional Information for BrazilianEmployees" (PeopleSoft Human Resources AdministerWorkforce).

Weekly Hours Enter the number of hours the employee works per week.

Note: This information is required. The vacations process usesthis information.

IR Ded Retirement (income tax retirement deduction) Select to indicate that the payee is an active retiree and entitledto a retirement deduction.

Union Contribution Paid Select to indicate that the employee has paid his or her unioncontribution.

Effective November 11, 2017, union contribution is no longerrequired for employees. This option is enabled by default fornewly added rows.

Service Taker Indicate the Service Taker to which the employee is assigned.

FGTS Option

Field or Control Description

FGTS Option (Fundo de Garantia por Tempo de Serviço) andFGTS Date

Select to indicate the employee participates in FGTS, and thedate participation began. Used for historical tracking, as FGTSparticipation is now required.

58 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 3 Defining Country Data

Advance Payment Option

Field or Control Description

Advance Payment Option and Advance Percentage Select to indicate the employee can receive payments inadvance from their regular salary and then enter the percentageof the monthly salary the employee can receive in advance.

Union Code

Field or Control Description

Union Code 1, Union Code 2, and Union Code 3 Enter the appropriate union codes for this employee. Youcan enter up to three union codes for an employee. Sinceeach union may have different mechanisms to determine theaverages calculation, the system compares the averages andensures that the employee receives the maximum value foreach earning.

See Averages Page.

Termination Parameters PageUse the Termination Parameters page (GPBR_PYEST_PARM) to define termination parameters.

Navigation:

Global Payroll & Absence Mgmt > Payee Data > Define Payee Parameters BRA > TerminationParameters

Copyright © 1988, 2022, Oracle and/or its affiliates. 59

Defining Country Data Chapter 3

This example illustrates the fields and controls on the Termination Parameters page (1 of 2).

This example illustrates the fields and controls on the Termination Parameters page (2 of 2).

60 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 3 Defining Country Data

Prior Notification

Select the appropriate prior notification date and option in this section for the employee, if applicable.Information specified here is used in eSocial reporting. Note that if an S-2298 Employee Reinstatementevent is submitted to the Government for the reinstatement of an employee, you need to add a new rowfor the new contractual period. In this scenario, the Prior Notification section appears blank and doesnot display any values that are carried over from the previous row. Similarly, when you add a new row,any prior notification and cancel prior notification data that is submitted to the Government does not getcarried over to the new row.

See Also S-2298 - Employee Reinstatement.

Field or Control Description

Notification Date Enter the date you notify the employee of his or hertermination.

Worked - Reduction of 2 Hours Select if the employee worked 2 hours less per day during theprior notification period.

Worked - Reduction of 7 Days Select if the prior notification period was shortened by 7 days.

Worked - Common Agreement Select if the employee worked with a common agreement heor she had with the employer (article 484-A, “caput”, CLT).

Excused of Notification Period Select if the employee was asked to be excused from workduring his or her prior notification period.

Notice Period Compliance

Select the appropriate prior notification compliance option for the employee, if either Worked -Reduction of 2 Hours or Worked - Reduction of 7 Days option is selected. Available complianceoptions are Full Compliance, Partial Compliance by Employee, Partial Compliance by Employer,and Partial Compliance Other reasons. Information specified here is used in eSocial reporting.

See Also S-2299 - Termination.

This section is not editable if the Excused of Notification Period option is selected.

Cancel Prior Notification

Select the appropriate check box to indicate the reason for canceling the employee’s prior notification, ifapplicable. Information specified here is used in eSocial reporting.

Note: Prior notification data (date and one selected option) must be available before you can enterinformation to cancel the prior notification.

Copyright © 1988, 2022, Oracle and/or its affiliates. 61

Defining Country Data Chapter 3

Field or Control Description

Cancel Date Enter the date the prior notification was canceled. The canceldate must be greater than the specified notification date.

Based on Article 489 of CLT Select if the cancelation was based on article 489 of CLT.

Judicial Determination Select if the cancelation was a judicial decision.

Comply with Legal Norm Select if the cancelation was made in compliance with thelegal norm.

Other Select if the cancelation was made for another reason notmentioned in this section.

Indicator of Alimony in FGTS

Data entered in this section is used in eSocial reporting for informational purposes.

Field or Control Description

Alimony in FGTS Select if and what kind of alimony deduction is applicable tothe employee. Values are:

0-There is no Alimony (default value)

1-Percentage of Alimony

2-Amount of Alimony

3-Pct and Amount of Alimony

Deduction Amount Enter the amount of alimony deduction, if 2-Amount ofAlimony or 3-Pct and Amount of Alimony is selected in theAlimony in FGTS field.

% Deduction (percentage deduction) Enter the percentage of alimony deduction, if 1-Percentageof Alimony or 3-Pct and Amount of Alimony is selected in theAlimony in FGTS field.

Termination Details and Judicial Decision

Data entered in this section is used in eSocial reporting.

62 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 3 Defining Country Data

Field or Control Description

Information Enter any comment regarding termination.

Proceeding Number Enter, if applicable, the proceeding number of the termination-related judicial decision for this employee.

FGTS and Stability PageUse the FGTS and Stability page (GPBR_PYSTB_PARM) to enter FGTS and stability information.

Navigation:

Global Payroll & Absence Mgmt > Payee Data > Define Payee Parameters BRA > FGTS andStability

This example illustrates the fields and controls on the FGTS and Stability page.

FGTS

Field or Control Description

FGTS Code The code of operation for an FGTS employee's account.

Copyright © 1988, 2022, Oracle and/or its affiliates. 63

Defining Country Data Chapter 3

Field or Control Description

Calculate last months FGTS Select this check box to indicate that FGTS should becalculated for the employee's last month.

Stability Data

Field or Control Description

Pregnant Date Enter the date the employee notifies you that she is pregnant.

Union Member, FGTS Board Member, CIPA's Titleholder/Substitute, CNPS Board Member, Cooperative SocietyMgr (cooperative society manager), and Prev SettlementCommittee Memb (previous settlement committee member)

Select the appropriate check boxes to indicate anymemberships or positions the employee holds. These optionsdefine a tenure status. If the employee has one of these optionsfor a started Begin Date and End Date, the system does notallow termination of the employee, unless that option isenabled on the Union Parameters page.

Employee Other Annual Amt BRA PageUse the Employee Other Annual Amt BRA page (GPBR_OTH_EE_AMT) to enter health care amountsfor employees and dependents.

Navigation:

Global Payroll & Absence Mgmt > Payee Data > DIRF Health Provider Amt BRA > EmployeeOther Annual Amt BRA

64 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 3 Defining Country Data

This example illustrates the fields and controls on the Employee Other Annual Amt BRA page.

The amount information that is entered on this page for the employee and dependents is displayed in theDIRF report.

Health Provider Amount

Field or Control Description

Company Select the employee’s company.

Health Provider Code Select the employee’s health provider.

Health provider codes are defined on the "Health ProvidersPage" (PeopleSoft Human Resources Administer Workforce).

Amount Enter the employee’s annual health care expense amount.

Health Provider Dependents Amount

Field or Control Description

Dependent/Beneficiary ID Select a dependent of the employee in the system.

Copyright © 1988, 2022, Oracle and/or its affiliates. 65

Defining Country Data Chapter 3

Field or Control Description

Amount and Currency Enter the annual health care expense amount andcorresponding currency for the dependent.

Defining Unhealthy and Hazardous Indicators for Job Codes andPositions

To set up indicators for job codes and positions, use the Position/JobCd Parameters BRA(GPBR_MIXED_PARM) component.

This topic discusses how to define unhealthy and hazardous indicators for job codes and positions.

Page Used to Define Indicators

Page Name Definition Name Usage

Position/JobCd Parameters BRA Page (position/job code parameters BRApage)

GPBR_MIXED_PARM Define unhealthy and hazardousindicators for job codes and positions.

Position/JobCd Parameters BRA PageUse the Position/JobCd Parameters BRA (position/job code parameters) page (GPBR_MIXED_PARM) todefine unhealthy and hazardous indicators for job codes and positions.

Navigation:

Set Up HCM > Product Related > Global Payroll & Absence Mgmt > Framework >Organizational > Position/JobCd Parameters BRA > Position/JobCd Parameters BRA

This example illustrates the fields and controls on the Position/JobCd Parameters BRA page.

66 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 3 Defining Country Data

Field or Control Description

Option Select whether you are assigning unhealthy/risk indicators to aJobcode or a Position.

Position, Business Unit, Location, and Job Code Select the position or job code you are assigning unhealthy/risk indicators to using these fields.

Unhealthy Select the appropriate health risk level for the activities of thejob code, position, or location. The system uses this indicatorto calculate an earning that compensates for this health riskfactor.

SEFIP Risk Select the appropriate risk level for the activities of the jobcode, position, or location. The system uses this informationto generate the SEFIP report and to determine the employee'sretirement deduction.

See Calculating INSS for Special Retirement.

Risk Select the appropriate hazard level for the activities of the jobcode, position, or location. The system uses this indicator tocalculate an earning that compensates for this hazardous factor.

Defining SEFIP Parameters

To define parameters for SEFIP, use the SEFIP Parameters BRA (GPBR_SEFIP_PARM), SEFIP AbsenceTable (GPBR_SEFIP_ABS), SEFIP Absence Parameters BRA (GPBR_SEFIP_ABSP), Service TakersBRA (GPBR_SERVICE_TAKER), and Legal Movement Codes BRA (LEG_MOV_COD_BRA)components.

This topic discusses how to define SEFIP parameters.

Pages Used to Define SEFIP Parameters

Page Name Definition Name Usage

SEFIP Parameters BRA Page GPBR_SEFIP_PARM Define SEFIP parameters.

SEFIP Absence Table BRA Page GPBR_SEFIP_PAR_ABS Map absence codes to SEFIP absencecodes.

SEFIP Absence Parameters BRA Page GPBR_SEFIP_ABSP Define absence parameters for SEFIP.

Service Taker Transactions BRA Page GPBR_SERV_T_DTL Administer service taker transactions.

Copyright © 1988, 2022, Oracle and/or its affiliates. 67

Defining Country Data Chapter 3

Page Name Definition Name Usage

Service Taker Data BRA Page GPBR_STAKER_DTA Define monthly parameters for servicetakers.

SEFIP Autonomous Review BRA Page GPBR_SEFIP_AUTO Enter SEFIP autonomous reviewinformation.

Legal Movement Codes BRA Page LEG_MOV_COD_BRA Define movement legal codes.

SEFIP Parameters BRA PageUse the SEFIP Parameters BRA page (GPBR_SEFIP_PARM) to define SEFIP parameters.

Navigation:

Global Payroll & Absence Mgmt > Social Security/Insurance > SEFIP Parameters BRA

This example illustrates the fields and controls on the SEFIP Parameters BRA page.

Some of the information that you enter on this page is included in the SEFIP report for the respectiveestablishment.

68 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 3 Defining Country Data

SEFIP Absence Table BRA PageUse the SEFIP Absence Table BRA page (GPBR_SEFIP_PAR_ABS) to map absence codes to SEFIPabsence codes.

Navigation:

Set Up HCM > Product Related > Global Payroll & Absence Mgmt > Elements > AbsenceElements > SEFIP Absence Table BRA > SEFIP Absence Table BRA

This example illustrates the fields and controls on the SEFIP Absence Table BRA page.

Use this page to associate absence codes with return codes that are used for SEFIP reporting. For eachlegal absence, SEFIP has an identification code and return code. This table is a prerequisite for theinformation on the SEFIP Absences Parameters page.

SEFIP Absence Parameters BRA PageUse the SEFIP Absence Parameters BRA page (GPBR_SEFIP_ABSP) to define absence parameters forSEFIP.

Navigation:

Set Up HCM > Product Related > Global Payroll & Absence Mgmt > Elements > AbsenceElements > SEFIP Absence Parameters BRA > SEFIP Absence Parameters BRA

Copyright © 1988, 2022, Oracle and/or its affiliates. 69

Defining Country Data Chapter 3

This example illustrates the fields and controls on the SEFIP Absence Parameters BRA page.

This page maps Global Payroll absence takes to SEFIP absence codes and the corresponding SEFIPabsence return code. In order to complete the information on this page you must complete the informationon the SEFIP Absence Parameters Page for each absence take.

Service Taker Transactions BRA PageUse the Service Taker Transactions BRA page (GPBR_SERV_T_DTL) to administer service takertransactions.

Navigation:

Global Payroll & Absence Mgmt > Social Security/Insurance > Service Taker Transactions BRA >Service Taker Transactions

This example illustrates the fields and controls on the Service Taker Transactions BRA page.

Information that you enter on this page is included in the SEFIP report.

70 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 3 Defining Country Data

Field or Control Description

Empl ID and Empl Record Specify the employee ID and the associated employee record. Selecting the employee record enables you to allocate thecorrect amounts for each employee in the SEFIP report.

Service Taker Specify the service taker to which the employee is assigned.

See Also Service Takers BRA Page.

Hours/Days Select Days or Hours, and specify the number of days or hoursin the corresponding field.

Percentage Contribution Enter a proration percentage. This percentage value is used toprorate employee amounts for the SEFIP report.

The total percentage contribution allowed for each employeeand employee record combination is 100.

Service Taker Data BRA PageUse the Service Taker Data BRA page (GPBR_STAKER_DTA) to define monthly parameters for servicetakers.

Navigation:

Global Payroll & Absence Mgmt > /Insurance > Service Taker Data BRA > Service Taker Data

Copyright © 1988, 2022, Oracle and/or its affiliates. 71

Defining Country Data Chapter 3

This example illustrates the fields and controls on the Service Taker Data BRA page.

Information that you enter on this page appears in the SEFIP Process report (GPBRSF01). It is not used inany report calculations.

Detail

Field or Control Description

Month The month to which the information on Social Security andpayment of FGTS applies.

Retention 9711/98 Law Enter the amount that represents the 11 percent requirementunder law 9.711/98.

Compensation Value Enter the adjusted compensation value to be reported on theGPS (Guia de Previdência Social) form for the referencemonth.

Issued Invoices Value Enter the total amount of invoices or bills issued for servicesduring the month.

72 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 3 Defining Country Data

Previous Competencies

Use these fields to enter the value of accrued contributions that were not reported on the GPS form inprevious months because they did not meet the minimum reportable value. Enter a separate value by typeof contribution: INSS or other entity.

SEFIP Autonomous Review BRA PageUse the SEFIP Autonomous Review BRA page (GPBR_SEFIP_AUTO) to enter SEFIP autonomousreview information.

Navigation:

Global Payroll & Absence Mgmt >Social Security / Insurance >SEFIP Autonomous ReviewBRA >SEFIP Autonomous Review BRA

This example illustrates the fields and controls on the SEFIP Autonomous Review BRA page.

Legal Movement Codes BRA PageUse the Legal Movement Codes BRA page to define movement legal codes.

Navigation:

Set Up HCM >Product Related >Workforce Administration >Legal Movement Codes BRA

Copyright © 1988, 2022, Oracle and/or its affiliates. 73

Defining Country Data Chapter 3

This example illustrates the fields and controls on the Legal Movement Codes BRA page.

Field or Control Description

Action and Reason Select an action and reason combination for which movementcan occur.

SEFIP Movement Code Select an applicable movement code.

For example, according to the labor law, employees areallowed movement of their linked accounts in the FGTS, if their employment ended as a result of mutual agreementbetween themselves and their employers. In this case, selectthe I5 - Term by Common Agreement movement code forthe termination action and reason combinations that allowmovement.

This field appears for the SEFIP Process type only.

Using Core Functionality in Brazil

This topic describes how to use the following core PeopleSoft Global Payroll features in your Brazilianpayroll system:

• Retroactivity

• Accumulators

• Segmentation

• Triggers

74 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 3 Defining Country Data

• Rounding rules

• Rate codes

Defining Retroactivity in BrazilRetroactivity is the process of going back in time and recalculating prior calendars because changes weremade after the original calculation was run. When retroactive processing occurs for a payee, the systemrecalculates each element generated for the payee. The difference between these results is the retro delta.

In Global Payroll, there are two methods for calculating retro:

• Corrective

• Forwarding

Note: In Brazil, all retro is handled with the forwarding method to comply with Brazilian legislation thatrequires all retroactive payments to be taxed in the current period. This includes both the Default retromethod and the On Conflict retro method.

With the forwarding method, payments are calculated in the respective periods, but balance accumulatorsfor the period are not updated. Only the segment accumulators are updated. Deltas are created for eachearning, deduction, and segment accumulator used in the process list. These deltas, which are identifiedon the "Retro Process Overrides Page" (PeopleSoft Global Payroll), are forwarded to the current period.

The system generates a retro trigger every time you enter a change on the data described in the followingsections.

Changes in the Employee's Data

Changes in employee data include compensation rate-related changes:

• Status.

• Compensation frequency.

• Standard hours.

• Pay system flag.

• Action for retroactive hire.

• Action for retroactive termination.

Changes in Other Data

Changes in other data include absence take-related changes:

• Positive input

• Pay group

Earnings and deductions are recalculated and a difference results.

Copyright © 1988, 2022, Oracle and/or its affiliates. 75

Defining Country Data Chapter 3

Note: Not all earnings or deductions will have an adjustment for retro. Some of the earnings anddeductions are forwarded to one earning or deduction, which then appears as a single adjustment in thecurrent period.

Related Links"Understanding Retroactive Methods" (PeopleSoft Global Payroll)

Using Accumulators in BrazilIn Brazil, the following types of accumulators are used:

• Annual accumulators for annual reports and average salary (when average salary is based in thecurrent year).

• Monthly accumulators for tax calculation and social security fees.

• Custom accumulators to store absences that affect the weekly days-off and holidays payments.

Using Segmentation in BrazilIn Global Payroll, if there is a change to employee details within a pay period that might affectcalculation, such as a pay rate increase, the calculation creates two slices. One slice uses the details beforethe change and the other slice uses the details after the change.

Global Payroll provides two types of segmentation: period segmentation or full segmentation and elementsegmentation or slice. Period segmentation occurs when more than one gross-to-net calculation isrequired. Element segmentation occurs when there is a change in the rate that affects the calculation ofone or more elements. In other words, element segmentation occurs when you want to calculate a selectset of earnings or deductions multiple times, but not the entire gross to net calculation.

Note: Global Payroll for Brazil does not utilize element segmentation.

In Global Payroll for Brazil, the following items produce a period segmentation:

• Changes in eligibility group.

• Changes in pay entity.

• Changes in pay group.

• Hirings and terminations held in the calendar.

Global Payroll for Brazil delivers some segmentation; however, you can alter the delivered segmentationevents and add or delete segmentation events depending on your business needs.

Using Triggers in BrazilTriggers are used to detect online changes to data that should result in some type of system action.Examples of common data changes that might use triggers include a new employee hire or a change inpay rate.

76 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 3 Defining Country Data

Global Payroll provides three types of triggers:

• Iterative − tells the system to process an employee for the current period.

• Segmentation − tells the system to segment a period or element.

• Retro − tells the system to perform retro processing.

Note: You must first set up an iterative trigger to tell the system when an event occurs, it should performthe desired action. After that, you can use a trigger to process an employee, perform segmentation, orperform retro processing.

Global Payroll for Brazil delivers some triggers; however, you can alter the delivered triggers and add ordelete trigger setups depending on your business needs.

Delivered Iterative Triggers

The following table lists the iterative trigger setups that are delivered with Global Payroll for Brazil:

Changes to: Trigger

Employee's employment record EMPLOYMENT

Employees job records JOB and JOB_JR

Employee's compensation record COMPENSATION

Employee's personal data record PERSONAL_DATA

Employee's contract data record CONTRACT_DATA

Employee's positive input records GP_PI_MNL_DATA

Employee's positive input supporting element override record GP_PI_MNL_SOVR

Employee's payee override record (earnings and deductions assignments) GP_PYE_OVRD

Employee's payee element assignment supporting element override record GP_PYE_OVR_SOVR

Employee's payee section detail record GP_PYE_SECT_DTL

Employee's personal data effective date record PERS_DATA_EFFDT

Employee's schedule calendar assignment record SCH_ASSIGN

Copyright © 1988, 2022, Oracle and/or its affiliates. 77

Defining Country Data Chapter 3

Changes to: Trigger

Employee's workday overrides record SCH_MNG_SCH_TBL

Employee's workforce contract type record WKF_CNT_TYPE

Employee's absence records GP_ABS_EVENT, GP_ABS_OVRD, etc.

Related Links"Understanding Triggers" (PeopleSoft Global Payroll)

Using Rounding Rules in BrazilIn Global Payroll, you can apply rounding to any component of an earning or deduction, the resolvedamount of an earning or deduction, or within a formula. Rounding is applied to each of the componentsfirst before the resolved amount is rounded. Rounding is applied after proration rules have been applied.

Global Payroll for Brazil does not deliver country-specific rounding rules.

Using Rate Codes in BrazilGlobal Payroll for Brazil supports the following types of salaries:

• Monthly

• Weekly

• Daily

• Hourly

Global Payroll for Brazil delivers the following HR rate codes to support the listed salaries:

Rate Code Description

KRH Hourly

KRM Monthly

Viewing Delivered Process Lists

The following table lists the delivered process lists for Brazil:

78 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 3 Defining Country Data

Process List Description

13 SALARIO 13th Salary Calculation

ADIANT QUINZENAL Advance Payment Process

AUSENCIAS Absences

FERIAS FOLHA Vacations Calculation

FERIAS TOMADAS Vacation Takes

FOLHA PAGAMENTO Payroll Calculation Process

PROVISOES Provisions

Note: PeopleSoft delivers a query that you can run to view the names of all delivered elements that aredesigned for Brazil.

Related Links"Understanding How to View Delivered Elements" (PeopleSoft Global Payroll)

Copyright © 1988, 2022, Oracle and/or its affiliates. 79

Defining Country Data Chapter 3

80 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 4

Setting Up the 13th Salary

Understanding the 13th Salary

Companies must pay a 13th salary (Christmas Bonus) to their payees. 13th salary is paid in two parts.The first installment corresponds to 50 percent of the total amount for 13th salary. The first installmentshould be paid by the end of November. Employees can also have their first installments paid in advanceas part of their vacation pay. If the first installment was paid as part of vacation pay, the company doesnot need to pay any 13th salary to the employee in November. In this situation, a company can choose torecalculate the first installment and pay the difference to the employee.

Two parameters on the General Parameters Page define:

• Whether the company recalculates the first installment (discounting the advanced amount).

• Whether to use averages when recalculating the first installment.

Employees who receive variable compensation, such as overtime or a differential for a night shift, may beentitled to have their 13th salary based on the averages of this variable compensation. Eligibility for theaverage salary allowance depends on union rules and the Consolidated Labor Laws (CLT).

The entire 13th salary amount must be paid by December 20. This payment discounts the amount of thefirst installment already paid. To make this payment by December 20, you might need to run an off-cyclepayroll.

To run an off-cycle payroll, you need to use one of two delivered special run types:

• KR 1A13SAL (for the first installment of 13th salary)

• KR 13SAL (for 13th salary payment).

Then, usually in December, the 13th salary is recalculated for everyone to ensure that if any differenceoccurred, the difference is paid to the employee.

Viewing Delivered ElementsThe PeopleSoft system delivers a query that you can run to view the names of all delivered elementsdesigned for Brazil. Instructions for running the query are provided in the PeopleSoft HCM: GlobalPayroll product documentation.

Related Links"Understanding How to View Delivered Elements" (PeopleSoft Global Payroll)

Copyright © 1988, 2022, Oracle and/or its affiliates. 81

Setting Up the 13th Salary Chapter 4

Setup Considerations

These three fields on two pages directly affect the processing of 13th salary payments:

• Field: Calc Average First Installment

Page and usage: General Parameters Page. If you want to calculate the average for the firstinstallment of 13th salary instead of using the daily rate, select this check box. If selected, the systemautomatically pays 50% of the 13th salary as calculated using average salary.

• Field: Recalc First Installment

Page and usage: General Parameters Page. Select to indicate the system should recalculate the firstinstallment 13th salary after it has been paid in advance as part of vacation pay. Since the 13th salarypayment is run in November, there may be salary changes that could cause some employees to receivean extra payment of 13th salary.

• Field: Advance 13th

Page and usage: Vacation Acquis Prd-Sched BRA Page. Select to have the employee receive the firstinstallment of his or her 13th salary at the time the employee leaves for vacation.

The first installment of 13th salary occurs only once a year. If an employee receives the firstinstallment in advance (at the time of vacation), the employee does not need to receive a 13th salarypayment in November.

Related LinksGeneral Parameters PageAverages PageVacation Parameters BRA PageVacation Acquis Prd-Sched BRA Page

Viewing Delivered 13th Salary Elements

This section discusses how to view the following delivered 13th salary elements:

• Earnings

• Deductions

• Accumulators

• Sections

Viewing Delivered 13th Salary EarningsThe following earning elements are delivered to calculate 13th salary:

82 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 4 Setting Up the 13th Salary

Earning Element Description

13 SALARIO Calculates 1/12 of the annual salary based on the eligible months during the year. Thisearning is calculated using the formula 13 FM 13 FIXO.

13 SAL-1PARC Calculates the first installment of the 13th salary. 50% of the 13 SALARIO. This earningis calculated using the formula 13 FM 13 FIXO.

13 SAL COM Calculates the average of commissions based on the eligible months earned during theyear. This earning is calculated using the formula 13 FM CAL MEDIAS.

13 SAL TAREF Calculates the average of the Tarefeiros (pieceworkers) units. Tarefeiros are paid based onthe number of produced units. This earning is calculated using the formula 13 FM MEDTAREFEIR.

13 SAL HOR Calculates the average of the worked hours. This earning is calculated using the formula13 FM MED HORISTA.

13 SALARIO INDEN This is an additional 1/12 that is paid if the employee is terminated without priornotification or with less than 15 days notice. This earning is calculated using the formulaRC FM 13 SAL INDE.

13 SAL DIF Calculates differences between the current 13th salary calculation and the previouscalculation (for example, salary changes not entered when calculating 13th salary).

13 SAL MAT Calculates 1/12 of the annual salary based on the eligible months for employees who areon maternity leave during the year. This earning is calculated using the formula 13 FMSAL MAT UNIT and FP FM SAL MAT TAR for the rate.

13 SAL MAT1P Calculates the first installment of the 13th salary. 50% of the 13 SAL MAT. This earningis calculated using the formula 13 FM SAL MAT UNIT and FP FM SAL MAT TAR forthe rate.

13 SALM IND This is an additional 1/12 that is paid if the employee on maternity leave is terminatedwithout prior notification or with less than 15 days notice. This earning is calculatedusing the formula 13 FM SAL MAT UNIT and FP FM SAL MAT TAR for the rate. Thiselement will or will not be calculated based on termination parameters.

13SALMATDIF Calculates differences between the current maternity 13th salary calculation and theprevious calculation (for example, salary changes not entered when calculating thematernity 13th salary).

Note: There are other earnings used by the vacations and provisions processes related to 13th salary.

Related LinksUnderstanding Vacation SetupUnderstanding Legal Provisions

Copyright © 1988, 2022, Oracle and/or its affiliates. 83

Setting Up the 13th Salary Chapter 4

Viewing Delivered 13th Salary DeductionsThe following deductions element is delivered to calculate 13th salary:

Deductions Element Description

DES ADIAN 13 Discounts the advance payment of 13 SAL FIXO, COM, TAREF, and HORpaid.

DESMEDHRS13S Discounts the advance payment made for Average Hourly earnings.

DESMEDVRS13S Discounts the advance payment made for Average Amount earnings.

Viewing Delivered AccumulatorsThe following accumulator elements are delivered to calculate 13th salary:

Accumulator Element Description

MESES 13 SALARIO Accumulates the number of months for which a payee is eligible for 13th salary. If the number of days worked is greater than 15 during a single month, thatmonth is counted toward 13th salary eligibility.

13 SALARIO PAGADO Accumulates the 13th salary already paid.

ACUM 13 SALARIO Accumulates the 13th salary base for average salary calculation purposes.

AFAST 13 SAL Accumulates the absences which reduce the number of worked days, whichaffects the 13th salary calculation.

Viewing Delivered SectionsThe following section elements are delivered to calculate 13th salary:

Section Element Description

KR 13º SALARIO This section is necessary for the pay calculation of 13th salary and can beincluded in the process list for either a regular payroll run or in a separatecalendar run.

Note: This PeopleSoft application delivers a query that you can run to view the names of all deliveredelements designed for Brazil.

84 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 4 Setting Up the 13th Salary

Related Links"Understanding How to View Delivered Elements" (PeopleSoft Global Payroll)

Copyright © 1988, 2022, Oracle and/or its affiliates. 85

Setting Up the 13th Salary Chapter 4

86 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 5

Setting Up Vacation Pay

Understanding Vacation Setup

This section provides an overview of vacation setup and discusses:

• Core application setup.

• Global Payroll for Brazil setup.

Vacation pay setup for Brazil is a subset of absence setup in general, because every absence—whether forvacation, sickness, or other cause—depends on the definition of absence take and entitlement elementsand other absence data in the Global Payroll core application.

In addition to general absence setup, you must define other vacation parameters, such as events perentitlement period, entitled days, and days per take, that define vacation business rules and enable you tointegrate Brazilian vacations with core absences.

Core Application SetupTo prepare Global Payroll for Brazil for absence processing, you must use core application pages tocomplete the following setup steps:

1. Define work schedules and assign a schedule to each payee.

2. Define holiday schedules.

3. Modify the delivered absence take and absence entitlement elements, and create new absenceelements, as needed.

Note: Global Payroll for Brazil delivers sample values for many of these elements. You may want toreplace at least some of these values with data that is specific to your organization.

See Entering Vacation Data and Updating Entitlement.

4. Assign absence elements to payees and process lists.

As with all primary elements, you must assign absence entitlement and take elements to payees andinclude the elements in the process lists that you use when you run the absence processes. This step isnot necessary for per-absence entitlement elements.

Global Payroll for Brazil delivers predefined sections and process lists for absence processing. Usethem, modify them, or create your own.

Copyright © 1988, 2022, Oracle and/or its affiliates. 87

Setting Up Vacation Pay Chapter 5

Global Payroll for Brazil SetupIn addition to the generic, core application setup steps required for absences, the setup of Brazilianvacation pay involves the following, additional steps using the Vacation Parameters BRA page in GlobalPayroll for Brazil:

• Define all company policies and legal requirements that are related to vacations using parameters.

Parameters include such information as the number of vacation days an employee can take perentitlement period, the maximum and minimum number of days of vacation that can be taken perleave, and the age above and below which vacations cannot be split into multiple periods.

• Identify the specific take and entitlement elements for which you are defining parameters.

These are the same elements that you will later use to enter and maintain vacation takes on theVacation Acquisition Prd-Sched (vacation acquisition period-schedule) page. The only absences thatyou can enter and maintain on the Vacation Acquisition Prd-Sched page are vacation-type absences;takes for other kinds of absences must be entered on the Absence Entry page for Brazil or on theAbsence Event Entry page in the core application.

Note: If you do not specify take and related entitlement elements on the Vacation Parameters BRApage, you cannot enter vacation time by using these elements on the Vacation Acquisition Prd-Schedpage.

Note: You must also upload vacation entitlement periods history during implementation. Global Payrollfor Brazil does not deliver a process to perform this upload.

This section discusses only the Brazil specific steps required to set up vacation leave; the documentationof generic procedures for defining absence elements can be found in yourPeopleSoft HCM: GlobalPayroll product documentation.

Related LinksEntering Vacation Data and Updating Entitlement"Understanding Absence Setup and Management Tasks" (PeopleSoft Global Payroll)"Understanding Absence Element Setup" (PeopleSoft Global Payroll)

Viewing Delivered ElementsThe PeopleSoft system delivers a query that you can run to view the names of all delivered elementsdesigned for Brazil. Instructions for running the query are provided in the "Understanding How to ViewDelivered Elements" (PeopleSoft Global Payroll) topic.

Defining Vacation Parameters for Brazil

To set up vacation parameters, use the Vacation Parameters (GPBR_VACN_PARM) component and theVacation Calendars BRA (GPBR_VAC_CALENDAR) component.

This topic provides an overview of vacation parameters and discusses how to define vacation parameters.

88 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 5 Setting Up Vacation Pay

Pages Used to Define Vacation Parameters

Page Name Definition Name Usage

Vacation Parameters BRA Page GPBR_VACN_PARM Define vacation parameters for Brazil. Also use to close and continueentitlement balances.

Vacation Calendars BRA Page GPBR_VAC_CALENDAR Specify which calendars to override forvacation events for a given pay group.

Understanding Vacation ParametersIn Global Payroll for Brazil, you use parameters to define company policies and legal requirements thatare related to vacation takes. You use these parameters to define for example:

• The number of vacation days that an employee can take per entitlement period.

• The number of vacations that an employee can take per entitlement period.

• The maximum and minimum number of days of vacation that can be taken per leave.

• Rules for calculating the value of vacation days that are sold back to the company by the employee.

• Rules for closing or extending an entitlement period when an employee exceeds the maximumnumber of total absences allowed in a period.

Labor Reform Update

On November 11, 2017, new labor rules on vacations were implemented as part of the Labor Reform.Under the new reform:

• Employers can configure the system to allow employees to take up to three vacation takes perentitlement period. With the 3-vacation take model, the length of one vacation take must be at least 14days long, and other two no less than 5 days each.

• The begin date of any vacation requests needs to at least three days before a holiday or weekend.

The system displays a warning message if this rule is not met, so that the user can adjust the begindate accordingly.

• Part-time employees who were entitled to 18 days of vacation per entitlement period are now entitledto 30 days of vacation.

Important! To update the vacation day count for part-time employees, make sure to add a new linemanually to the FE BR DIREITO PARC element, with the effective date set to November, 11, 2017.In this new line, change the vacation entitlement to 30 days.

• Age requirement is no longer enforced on partial vacation.

• For employees who have lost vacation day entitlement due to the number of absence days they tookduring the acquisitive period, and the reduction causes their new vacation balances to be less than the

Copyright © 1988, 2022, Oracle and/or its affiliates. 89

Setting Up Vacation Pay Chapter 5

stipulated limit (for example, 14 days), they must use up all their remaining vacation balances in onesingle instance.

See Also Vacation Parameters BRA Page

Vacation Parameters BRA PageUse the Vacation Parameters BRA page (GPBR_VACN_PARM) to define vacation parameters for Brazil.

The page is also used to close and continue entitlement balances.

Navigation:

Set Up HCM > Product Related > Global Payroll & Absence Mgmt > Framework >Organizational > Vacation Parameters BRA > Vacation Parameters BRA

This example illustrates the fields and controls on the Vacation Parameters BRA page (1 of 2).

90 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 5 Setting Up Vacation Pay

This example illustrates the fields and controls on the Vacation Parameters BRA page (2 of 2).

General

Field or Control Description

Takes per Acquisitive Period Enter the number of separate vacations that employees cantake within an entitlement period.

For example, an employee may be eligible for 30 days ofvacation per entitlement period, and this value indicates howmany separate vacations the employee can take with those 30days.

By default, the value is set to 3 vacation takes per entitlementperiod. According to the labor law, one of these three vacationtakes must be at least 14 days long, and each of the other twoneeds to be at least 5 days long.

Copyright © 1988, 2022, Oracle and/or its affiliates. 91

Setting Up Vacation Pay Chapter 5

Field or Control Description

Take - Needs Confirmation Select if vacation needs to be approved prior to beingprocessed by the system.

When you enter a vacation event in the Vacation AcquisitionPrd-Sched page, you assign the event a leave status ofProgramed, Confirmed, and so on. If the leave status isProgrammed and you select this check box, then the vacationpayroll process does not process the vacation until it is set toConfirmed. If you clear this check box, the vacation payrollprocess processes vacation events with a leave status ofProgrammed.

Note: You approve vacation takes on the Vacation AcquisitionPrd-Sched page. If you do not select this option, the systemprocesses both planned and confirmed vacation takes.

See Entering Vacation Data and Updating Entitlement.

Vacn Days Per Acquisitive Prd (vacation days per acquisitiveperiod)

Enter the number of vacation days to which employees areentitled per entitlement period. By default, the value is set to30 days.

Minimum Period Vacation Days Enter the minimum number of leave days to take in a singlelong vacation within an entitlement period.

By default, this value is set to 14 days. It is the minimumlength for one of the vacation takes (the long one) as requiredby the Brazilian labor law, if the system is set to allow 3vacation takes per entitlement period.

Allow Negative Balance Select to allow negative accrual balances for vacations. Thisfield allows vacation scheduling if an acquisitive period doesnot have sufficient entitlement. If you select this option, theLimit field appears.

92 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 5 Setting Up Vacation Pay

Field or Control Description

Credit Treatment Specify the credit treatment for vacation "sell" days. Valuesare:

End of Vacations: Select to base the value of any vacation selldays on the employee's salary at the end of the vacation period.

Proportional Vacation Days: Select if you want the system tocalculate the value of unused vacation days by using a factorthat is based on the proportion of vacation days actually takeneach month (if the vacation spans several months).

Starting Month: Select to base the value of any vacation selldays on the employee's actual daily salary at the start (the firstmonth) of the vacation period.

See Understanding Vacation Parameters.

Limit Enter the maximum negative entitlement balance allowed.Days that exceed this maximum must be taken as unpaid leave.

Note: This field appears only when you select the AllowNegative Balance check box.

Minimum Age for Partial Take Specify the age under which the division of vacations intoseparate events is not allowed. This field is not used as agerequirement is no longer enforced on partial vacation.

Maximum Age for Partial Take Specify the age over which the division of vacations intoseparate events is not allowed. This field is not used as agerequirement is no longer enforced on partial vacation.

Note: Companies that process vacation pay more than once each month can use the Vacation CalendarsBRA page.

See Vacation Calendars BRA Page.

Copyright © 1988, 2022, Oracle and/or its affiliates. 93

Setting Up Vacation Pay Chapter 5

Per Vacation Take

Field or Control Description

Min Days Nbr (minimum days number) Enter the minimum number of leave days that can be taken aspart of a single vacation take.

By default, this value is set to 5 days. It is the minimum lengthfor two of the vacation takes (the short ones) as required bythe Brazilian labor law, if the system is set to allow 3 vacationtakes per entitlement period.

Max Days Nbr (maximum days number) Enter the maximum number of leave days that can be taken aspart of a single vacation take.

Absences Take Credit Max % (absences take creditmaximum percentage)

Enter the maximum percentage of vacation allowance thata payee can sell. The Vacation Acquisition Prd-Sched pagedisplays this value when you select the Pay Credit check box.

Absence Elements

In the Absence Elements group box, you identify the specific absence take and entitlement elements touse when synchronizing the Vacations Entitlement and Takes BRA page with core pages and events. Forexample, to display the balance for a vacation entitlement period in the Vacations Entitlement and TakesBRA page, the system needs the name of the entitlement element—an element that calculates and storesthe vacation balance—to obtain the current balance in the results tables. Similarly, when entering vacationtakes, you insert, delete, or update a row in the Absence Entry page by way of a component interface; thesystem needs the name of the absence take to map vacation events.

Field or Control Description

Vacations Specify the absence take element to use for vacation takes. Thesystem uses this element to synchronize vacation takes withcore absences.

Paid Vacations Specify the absence take element to use for vacation credits. The system uses this element to synchronize vacation creditswith core absences.

Note: You must define how the system calculates vacationcredit—the amount returned to the payee when he or she sellsunused vacation days—by specifying a credit treatment optionin the Credit Treatment field.

Vacation Entitlement Specify the absence take element for which you want to adjustand display balances.

94 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 5 Setting Up Vacation Pay

Field or Control Description

Vacation Proportional Select the element that tracks proportional vacations earnedin each period (such as vacation acquired in the currentacquisitive period during a final payment).

Absence Interference on Acquisitive Period

Using the fields in the Absence Interference on Acquisitive Period group box, you can close or continuevacation entitlement periods in response to other absences or events that impact vacation entitlement. Forexample, you can instruct the system to close an entitlement period for a work disability that lasts morethan 180 days or for military service. You can also continue an entitlement period that would otherwise beclosed or reduced by an absence. For example, you can specify that if an employee takes maternity leavethat lasts 60 or more days, 60 additional days should be added to the entitlement period.

See Understanding Vacation Parameters.

Field or Control Description

Sequence Enter a sequence number.

The sequence number represents the order in which the systemprocesses the different actions (Close or Continue) that youdefined.

Action Enter the action that you want the system to take in response tothe absence that you specify in the Absence Type field. Valuesare:

Close: Select to close an entitlement period in response to theabsence types that are specified in theAbsence Type field.

Continue: Select to continue an entitlement period in responseto the absence types that are specified in the Absence Typefield.

Number of Days for Action Enter the number of days of the absence type or combinationof absence types, which are shown in the Absence Typefield, that an employee must accumulate before the Close orContinue action can take effect. For example, enter 180 toindicate that 180 or more days of sick leave (absence type ofAFA) should result in the closure of the entitlement period foryour employees.

Absence Type Enter the type of absence or combination of absence types thatshould result in the action that is specified in the Action field.

Copyright © 1988, 2022, Oracle and/or its affiliates. 95

Setting Up Vacation Pay Chapter 5

Selling Vacation Days

In Global Payroll for Brazil, you can credit the employee's account for the sale of unused vacation days.The vacations payroll process calculates the value of these days in one of several different ways based onthe value of the Credit Treatment field.

Consider the following salary and vacation data for an employee.

Salary Data:

• February Salary = 3000; daily salary is 3000÷30 = 100.

• March Salary = 3300; daily salary is 3300÷30 = 110.

• April Salary = 3630; daily salary is 3630÷30 = 121.

Note: The system calculates the daily salary by annualizing and reconfiguring using frequency annualfactors.

Vacation Data:

• The employee is entitled to 30 days of vacation per entitlement period.

• The employee sells 10 days of vacation in the entitlement period.

• The employee takes vacation from March 5 to March 24, 2002 (20 days).

• The employee receives vacation payment two days before he takes leave (on March 3).

• The employee's job record does not contain the March salary information at the time that theemployee receives the vacation payment.

Case 1: Credit Treatment is Starting Month.

In this case, the amount paid in advance of the vacation is based on the last salary value in the system,which is the February salary (3000). The employee receives pay for 20 days of vacation (2000) plus thevalue of 10 more days (1000) due to the sale of the unused entitlement.

The total initial payment is calculated as follows:

(Daily Salary) × (Number of Days), or (100 × 20) + (100 × 10), for a total of 3000.

However, because the credit treatment is Starting Month, the value of vacation sell days must berecalculated by using the March salary (3300), or rather, the salary in the first month of vacation. Thedifference between the initial calculated value of the vacation credit and the recalculation is paid to theemployee. In this case, the difference is (110 × 10) – (100 × 10), or 100.

Note: If the employee's job record contains the March salary information at the time of the vacationpayment, the system would use the March daily salary of 110 to calculate the initial vacation payment. Noretroactive processing is required in this case.

Case 2: Credit Treatment is End of Vacations.

As in the previous case, the amount paid in advance of the vacation is based on the last salary value in thesystem, which is the February salary (3000). The employee receives pay for 20 days of vacation (2000)plus the value of 10 more days (1000) due to the sale of the unused entitlement.

96 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 5 Setting Up Vacation Pay

The total initial payment is calculated as:

(Daily Salary) × (Number of Days), or 100 × 20 (2000 for the vacation) + 100 × 10 (1000 for the vacationcredit), for a total of 3000.

However, because the credit treatment is End of Vacations, the value of the vacation sell days must berecalculated by using the salary in effect at the end of the vacation, on March 25. (The vacation endson March 24.) But in this example, the vacation credit period crosses two months with two differentsalaries—it runs from March 25 to April 3, for a total of 10 days, 7 of which are in March, and 3 ofwhich are in April. Thus seven of the days are recalculated by using the March salary (3300), and threeare recalculated by using the April salary (3630). The payee receives the difference between the initialcalculated value and the recalculated value of the vacation sell days.

Case 3: Credit Treatment is Proportional Vacation Days.

To illustrate this case, the vacation period in this example extends from March 26 to April 4, for a totalof 10 days. Just as in the previous case, the payee has 10 days of vacation to sell and receives an initialvacation payment for 20 days ((10 vacation days) + (10 sell days)) based on the last salary in the system(February). However, because the credit treatment is Proportional Vacation Days, the system recalculatesthe value of the 10 vacation sell days based on the proportion of vacation days taken in each month. In thecurrent example, six days of the vacation fall within March, and four days within April. Thus, the systemrecalculates the value of six credit days by using the March salary (3300) and four credit days by usingthe April salary (3630). The payee receives the difference between the initial calculated value and therecalculated value of the vacation sell days.

Closing and Continuing Entitlement BalancesOn the Vacation Parameters BRA page, you can close or continue vacation entitlement periods inresponse to other absences or events that impact vacation entitlement. For example, you can instruct thesystem to close an entitlement period for a work disability that lasts more than 180 days, or for militaryservice. You can also continue an entitlement period. For example, you can specify that if an employeetakes maternity leave that lasts 60 or more days, 60 additional days should be added to the entitlementperiod.

Closing an Entitlement Period

To close an entitlement period:

1. Enter a sequence number on the Vacation Parameters BRA page for each absence type or combinationof types that can cause the closure of an entitlement period.

Note: Many different absence types or combinations of absence types may cause the closure orcontinuation of an entitlement period. The sequence number tells the system in what order to processthe effect of these different absences on vacation entitlement.

2. Enter Close in the Action field.

3. In the Absence Type field, enter the absence type or combination of absence types that will trigger theClose action.

4. In the Vacn Days per Acquisitive Prd (vacation days per acquisitive period) field, enter the numberof days of the absence type or combination of absence types shown in theAbsence Type field that anemployee must accumulate before the Close action can take effect.

Copyright © 1988, 2022, Oracle and/or its affiliates. 97

Setting Up Vacation Pay Chapter 5

For example, you could specify that 180 or more days of sick leave (absence type of AFA) shouldresult in the closure of the entitlement period for your employees.

Note: When you close an entitlement period in Global Payroll, you lose all vacation days thataccumulated for the period.

Continuing an Entitlement Period

To continue an entitlement period that would otherwise be closed or curtailed:

1. Enter a Sequence Number on the Vacation Parameters BRA page for each absence type orcombination of types that can cause the continuation of an entitlement period.

Note: Many different absence types or combinations of absence types may cause the closure orcontinuation of an entitlement period. The sequence number tells the system in what order to processthe effect of these different absences on vacation entitlement.

2. Enter Continue in the Action field.

3. In the Absence Type field, enter the absence type or combination of absence types that will trigger theContinue action.

4. In the Vacn Days per Acquisitive Prd (vacation days per acquisitive period) field, enter the numberof days of the absence type or combination of absence types shown in the Absence Type field anemployee must accumulate before the Continue action can take effect.

For example, you could specify that 60 or more days of maternity leave (absence type of LCM) shouldresult in the continuation of the entitlement period for the number of days that the payee was absentdue to maternity leave during the entitlement period.

Note: When you extend an entitlement period in Global Payroll for Brazil, you maintain all vacationdays that were previously accumulated and accumulate additional entitlement during the continuationperiod.

Related LinksEntering Vacation Data and Updating Entitlement

Vacation Calendars BRA PageUse the Vacation Calendars BRA page (GPBR_VAC_CALENDAR) to for a given pay group, specifywhich calendars to override for vacation events.

Navigation:

Set Up HCM > Product Related > Global Payroll & Absence Mgmt > Framework > Calendars >Vacation Calendars BRA > Vacation Calendars BRA

98 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 5 Setting Up Vacation Pay

This example illustrates the fields and controls on the Vacation Calendars BRA page.

You can use this page to identify, for a given pay group, the vacation absence calendars and vacationpayroll calendars to override when you enter vacation events on the Vacation Acquisition Prd-Sched page.

For example, assume that an employee will be on vacation from January 31 to March 1 and that tocomply with the law, you must issue advance payment of the employee's January and February vacationon January 29. When you enter the vacation event on the Vacation Acquisition Prd-Sched page, thesystem refers to the Vacation Calendars BRA page to determine the calendars for which to create overrideinstructions. It looks for the row that contains January 29 to determine which calendars to override forthe vacation days in January and does the same thing for February and March. In this way, the systemidentifies which calendars to process in advance and creates the corresponding overrides for thosecalendars.

Copyright © 1988, 2022, Oracle and/or its affiliates. 99

Setting Up Vacation Pay Chapter 5

100 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 6

Defining Average Salary Rules

Understanding Average Salary Calculations

Employees who receive variable compensation, such as overtime or a differential for a night shift, may beentitled to have their vacation, termination, 13th salary, and maternity pay based on their average variablepayments. Eligibility for the average salary allowance depends on union rules and the Consolidated LaborLaws (CLT).

To define your organization's rules for calculating the average salary:

1. Use the Average Versions BRA page to identify which earning and deduction elements the systemconsiders for the average salary version.

Use this page to define the average salary calculation parameters for these elements.

2. Use the Averages page of the Union Parameters BRA component to associate, for a given union, theaverage salary version (identified in Step 1) that the system considers when calculating the averagesalary for members of that union.

You can select different earning and deduction elements for each run type.

When you run the payroll process, the system looks at the information you defined on the Averages pageto determine which earnings and deductions to consider when calculating the employee's average salary. Itthen looks at the Average Version BRA page for the specific calculation rules.

The Averages Report

After you run the payroll process, you can generate the Averages report (GPBRME01) to view thedetailed calculations the system performed to compute employees' average salary. You can produce thereport for selected establishments, departments, employees, or groups.

To produce the Averages report, the payroll process must store detailed results in two writable arrays:MD WA MEDIAS ENC stores header information for the report and MD WA MEDIAS stores details. Asdelivered, both writable arrays are configured to store payroll results. If you do not want to produce theAverages report, you should set the value of variable MD VR DETALHE MED to false (0) to prevent thesystem from populating the writable arrays. The variable is set to true (1) by default. Storing results canaffect system performance. To generate the Average report, MD VR DETALHE MED must be set to 1when the payroll process is run.

PrerequisitesThe earnings and deductions that you use to pay average salary must have a calculation rule of Amount,where the amount is calculated by the average salary resolution formula, MD FM VALOR MEDIA.

Copyright © 1988, 2022, Oracle and/or its affiliates. 101

Defining Average Salary Rules Chapter 6

To define that an Average to be resolved belongs to the 13th salary calculation, use the SupportingElement Overrides page of the Earnings or Deductions component to set variable MD VR MEDIA 13 to 1(one). This setting enables the system to prorate the amount according to the number of months worked.

Viewing Delivered ElementsThe PeopleSoft system delivers a query that you can run to view the names of all delivered elementsdesigned for Brazil. Instructions for running the query are provided in the "Understanding How to ViewDelivered Elements" (PeopleSoft Global Payroll) topic.

Understanding Average Salary Setup

This topic provides examples of:

• Average setup with retroactive processing.

• Maternity average setup.

• Vacation and paid vacation average setup.

Example: Average Setup with Retroactive ProcessingTo set up a salary average with retroactive processing:

1. Specify elements that need retroactive processing on the Average Version BRA Page . In thisexample, enter setup for the HORA EX D50 and HORA REMUNER elements for the KRHED50 Daverage version.

102 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 6 Defining Average Salary Rules

This example illustrates the salary average setup (HORA EX D50) with retro processing on theAverage Versions BRA page.

This example illustrates the salary average setup (HORA REMUNER) with retro processing on theAverage Versions BRA page.

2. Insert HORA EX D50 as earning for the BR RETRO retro process definition on the "Retro ProcessOverrides Page" (PeopleSoft Global Payroll). Make sure the Forward option is selected.

Copyright © 1988, 2022, Oracle and/or its affiliates. 103

Defining Average Salary Rules Chapter 6

This example illustrates the addition of the HORA EX D50 element to the Retro Process Overridespage.

3. Insert a positive input for the HORA EX D50 element on the "One Time (Positive Input)Page" (PeopleSoft Global Payroll) for a month (for example, October).

In this example, enter 16 as the unit number (hour) in the Earnings and Deductions: MainComponents section.

4. Run the regular payroll for that month. Review the results.

Note: Access the Calendar Group Results page to verify that the unit value of 16 (entered as positiveinput) is processed.

After the results are verified and they look good, finalize the payroll.

5. Now, modify the positive input that was previously entered to generate the corresponding retro.

This time, change the unit (hours) for HORA EX D50 from 16 (previously entered) to 10 on the "OneTime (Positive Input) Page" (PeopleSoft Global Payroll) .

6. Review the retro trigger that exists for that month.

Verify that the retro trigger has been added as a row for the employee on the "Retro Page" (PeopleSoftGlobal Payroll).

7. Run the payroll for the next month and verify the results.

Suppose that the retro is for the month of October, you need to run the regular payroll for November.

After running the payroll, access the Calendar Group Results page to verify that -6 hours of unitadjustment for HORA EX D50 is processed and has been forwarded to same HORA EX D50 element.

After the results are verified and they all look good, finalize the payroll.

8. Run the payroll for the following month and verify the results.

104 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 6 Defining Average Salary Rules

Suppose that the retro is for the month of October, you need to run the regular payroll for Decemberin this step.

After running the payroll, access the Calendar Group Results page to verify that the MED HED50 13element has taken into account retro processing for HORAS EX D50 and the amount has been paid.

Here is the summary of the calculation:

October Incidence: 16 hours

November incidence that belongs to October: -6 hours

Calculation With Retroactive Processing

(October hours * Hourly RT * PCT) + (Retro October hours * Hourly RT * PCT) = Result

(16 * 63.636363 * 150%) + (-6 * 63.636363 * 150%) /12 = 79.54545

Example: Maternity Average SetupTo set up maternity salary averages, specify all the elements (for example, HORA EX D50, HORA EXD100, and so on) that need them on the Average Version BRA Page, as illustrated in this screenshot:

This example illustrates an example of a maternity leave average setup on the Average Versions BRApage.

Note: Be sure to select the MD DT LIC MAT INI element (maternity begin date) as the date from elementfor every element row. The system needs to indicate the maternity begin date from the accumulators andthe value must appear in the payroll results.

Copyright © 1988, 2022, Oracle and/or its affiliates. 105

Defining Average Salary Rules Chapter 6

Example: Vacation and Paid Vacation Average SetupTo set up a vacation and paid vacation salary average:

1. Enter vacation leave on the Vacation Acquis Prd-Sched BRA Page.

In this example, enter 20 vacation days, and 10 credit days.

2. Verify that KRCOMISS F and KRPREMIO F average versions are defined on the Average VersionBRA Page.

3. Verify that KRCOMISS F and KRPREMIO F average versions are referenced on the Averages Page(union parameters) for the vacation payroll run type.

This example illustrates the example of adding vacation average versions on the Averages page forunions.

4. Calculate regular payroll for months of January through April, including the COMISSAO element(commissions).

Verify the COMISSAO calculation results:

• January: 3000

• February: 100

• March: 1000

• April: 0

5. Calculate vacation payroll.

Verify the MED ABONO and MED FERIAS calculation results:

COMISSAO: 4100

PREMIO: 27500

MED COM FER: 4100/12 = 341.67/30*20 = 227.78

MED PREMIO F: 27500/5 = 5500 /30*20 = 3666.66

MEDIA ABONO: ( 341.67+5500) = 5841.67/30*10=1947.22

106 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 6 Defining Average Salary Rules

MEDIA FERIAS: 227.78+3666.66 = 3894.44

Defining Average Salary Rules

To define average salary rules, use the Average Versions BRA (GPBR_AVG_VERSION) component andthe Union Parameters BRA (GPBR_UNION_PARMS) component.

This topic discusses how to define average salary rules.

Pages Used to Define Average Salary Rules

Page Name Definition Name Usage

Average Version BRA Page GPBR_AVG_VERSION Identify the earning and deductionelements that are used within the averagesalary calculations. Also, define theaverage calculation parameters for theseelements.

Averages Page GPBR_AVERAGES Define the earning and deductionelements considered by the system foraverage salary calculations for a givenunion.

Average Version BRA PageUse the Average Versions BRA page (GPBR_AVG_VERSION) to identify the earning and deductionelements that are used within the average salary calculations.

Also, define the average calculation parameters for these elements.

Navigation:

Set Up HCM > Product Related > Global Payroll & Absence Mgmt > Framework >Organizational > Average Versions BRA > Average Version BRA

Copyright © 1988, 2022, Oracle and/or its affiliates. 107

Defining Average Salary Rules Chapter 6

This example illustrates the fields and controls on the Average Version BRA page.

Field or Control Description

Entry Type Select the type of element to include in the averages, forexample, Earnings or Deductions.

Element Name Select the earning or deduction element that is to beconsidered in the average salary calculations.

Average Calculation Period

Identify the period of time to consider for this earning or deduction element when calculating the averagesalary. The fields that appear in this group box vary depending on your selection in the Period Type field.

108 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 6 Defining Average Salary Rules

Field or Control Description

Period Type Select the type of period on which to base the average salarycalculations. Options are:

Acquisitive Period: Select to consider amounts that wereearned or deducted during the employee's current entitlementperiod. (The current entitlement period is often based on theemployee's service date.)

The entitlement period is built during the Vacation process (GPBR_VACN_AP), which includes GP rules and anApplication Engine process that updates the entitlementperiod. The record GPBR_VACN_AP stores entitlementperiod information and can be viewed on the VacationAcquisition Prd-Sched page.

Defined Period: Select to consider amounts that were earnedor deducted during the period defined by the From Date andTo Date fields.

Year: Select to consider amounts earned during the currentyear only. Use theTo Date and End Date fields to define whatportion of the current year to consider.

From Date This field appears when you select Defined Period in thePeriod Type field. Select one of the following options:

Before: Use values only from the very day before the currentperiod starts (based on the date in the Begin Date field).

Current: Use values from the current period being processed.

Defined: Enter a date in the Begin Date field to indicate thestart date.

Element Name: Select an element in the Date From Elementfield to derive the start date.

Begin Date This field appears when you select Defined Period in thePeriod Type field and Defined in the From Date field. Enterthe first date to take into account when selecting the amountsto include in the average calculation.

A begin date functions like historical rule. The begin dateis the first date the system takes into account; the processconsiders information from this date until the end date.

Note: Make sure that the specified begin date must be greaterthan (more recent), but not equal to or less than the period enddate.

Copyright © 1988, 2022, Oracle and/or its affiliates. 109

Defining Average Salary Rules Chapter 6

Field or Control Description

Date From Element This field appears when you select Element Name in the FromDate field.

Specify the element, such as a variable, formula, or date, toderive the first date to take into account when selecting theamounts to include in the average calculation.

To Date This field appears when you select Year or Defined Period inthe Period Type field. Select one of the following options:

Define the last date to be considered. Select one of thefollowing options:

Defined: Enter a date in the End Date field to indicate the lastdate.

Element Name: Select an element in the Date To Elementfield to derive the last date.

Months: Enter a number in the Nbr of Months field to derivethe last date.

End Date This field appears when you select Year or Defined Period inthe Period Type field and Defined in the To Date field. Enterthe last date to take into account when selecting the amounts toinclude in the average calculation.

An end date functions like historical rule. The end date is thelast date the system takes into account; the process considersinformation from the begin date until this date.

Date To Element This field appears when you select Element Name in the ToDate field.

Specify the element, such as a variable, formula, or date, toderive the last date to take into account when selecting theamounts to include in the average calculation.

Nbr of Months (number of months) This field appears when you select Months in the To Datefield. Enter the number of months from the begin date thatthe system is to consider when performing the average salarycalculations.

Average Type

Specify whether the amounts that are eligible for the average salary calculations should be adjusted. Thesystem makes these adjustments when it reads the values for each month. For example, if the system reads

110 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 6 Defining Average Salary Rules

the January results and needs to adjust those values, the new value for that month is the original valuetimes the adjustment factor for the month.

Field or Control Description

Average Type Identify which component(s) of the earning or deductionelement to adjust, if any. Options are Units, Amount, Percentage, and Units * Percentage.

Correct Indicate whether amounts should be adjusted for inflation:

Correct Amount: Select to have the system adjust the amounts.

Don't Correct: Select if you do not want the system to adjustfor inflation.

Index by Hourly Salary: If you select this option, the systemwill read the hourly rate as of the payment date of the earningor deduction to consider any changes not taken for the hourlyrate.

Reverse Sign: Select for the system to multiply the amounts by-1 (minus one).

Correct ID This field appears if you select Correct Amount in the Correctfield. Enter the code for the monthly inflation adjustment.

Note: A bracket stores correct IDs and their associatedadjustment factors. You must enter the exact correct ID in thisfield to have the system find and use the correct adjustmentfactor.

Copyright © 1988, 2022, Oracle and/or its affiliates. 111

Defining Average Salary Rules Chapter 6

Averages Calculation

Field or Control Description

Divider To calculate the average, the system can divide by a fixednumber or by the number of periods that you specify. Optionsare Worked Months and Months.

Months: Select to have the system divide the total earningor deduction amount that is eligible for the average salarycalculation by the number that you enter in the By field.

Worked Months: Select to have the system divide the totalearning or deduction amount only by the number of months inthe average period.

For example, if the average period is from 12/31 to 01/01 butthe employee was hired or terminated during this period oftime, then, instead of dividing the result by 12, the systemdivides by the proportion of months between the hire ortermination date.

By If you selected Months in the Divider field, enter the numberyou want the system to divide by.

Min Nbr Occurrences (minimum number occurrences) Specify the number of times during the defined period that thisearning or deduction must occur in order for it to be used inthe average salary calculation. For example, if you enter 3 inthis field and an employee receives a particular earning twiceduring the period, that earning will not be considered in theaverage salary calculations.

Enter 0 in this field to have the system always consider theearnings and deductions.

Take n Greater Enter the number of occurrences of the earning or deductionin the defined period that are to be used in the average salarycalculations. The system selects the amounts with the highestvalues (after adjusting for inflation, if you selected CorrectAmount in theCorrect field . For example, if you enter 5 inthis field for an earning element, the system averages the fivehighest earning amounts that were calculated for this elementduring the defined period.

Enter 0 (zero) in this field if you want the system to considerall earning and deduction amounts for the defined period.

Related LinksEntering Vacation Data and Updating Entitlement

112 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 6 Defining Average Salary Rules

Averages PageUse the Averages page (GPBR_AVERAGES) to define the earning and deduction elements considered bythe system for average salary calculations for a given union.

Navigation:

Set Up HCM > Product Related > Global Payroll & Absence Mgmt > Framework >Organizational > Union Parameters BRA > Averages

This example illustrates the fields and controls on the Averages page.

Average Calculations

Field or Control Description

Run Type Select the type of payroll process for which you want to definethe average version of the pay component.

For each run type, you can select a different set of earningand deduction elements to calculate using the average salarycalculation.

Note: You are not required to enter the same informationfor different run types. You can override the run type atthe calendar level, or any other level, according to yourrequirements. To enter override instructions, set the value ofvariable FP VR RUN TYPE to the desired run type.

Entry Type Select the type of element to consider in the average salarycalculations: earnings or deductions.

Target Element Select the name of the earning or deduction element.

Average Version Select the name of the set of parameters you defined on theAverage Version BRA page.

Copyright © 1988, 2022, Oracle and/or its affiliates. 113

Defining Average Salary Rules Chapter 6

Generating the Averages Report

This topic discusses how to run the Averages report.

Page Used to Generate the Averages Report

Page Name Definition Name Usage

Averages Report BRA Page GPBR_RC_AVG Report the detailed calculations thesystem performed to compute theaverage salary for employees in selectedestablishments, departments, or groups. You can also generate the report forselected employees.

Averages Report BRA PageUse the Averages Report BRA page (GPBR_RC_AVG) to report the detailed calculations the systemperformed to compute the average salary for employees in selected establishments, departments, orgroups.

You can also generate the report for selected employees.

Navigation:

Global Payroll & Absence Mgmt > Absence and Payroll Processing > Reports > Averages ReportBRA > Averages Report BRA

This example illustrates the fields and controls on the Averages Report BRA page.

114 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 6 Defining Average Salary Rules

Field or Control Description

Run Type Name Select the payroll run type.

Element List You can have the report include information for elements thatare used in the averages calculation. Use the Element ListBRA component to create an element list.

Sort ID Select a sort ID to specify the order in which informationshould print on the report. Define sort IDs using the Sort IDsBRA component.

Print Element List Description If you are using an element list, selecting this option causes thesystem to print the description of the element list on the report.

Begin Date and End Date For all calendars that fall within the dates you enter here, thesystem will print the elements in the selected element list.

Selection Criteria Choose a method of selecting employees for whom to generatethe report.

Exclude Data Select this check box to exclude data that matches the criteriayou enter in the Establishment Data, Department Data, or Employee Data group boxes (the group box that appearsdepends on the selection you make in theSelection Criteriafield).

Copyright © 1988, 2022, Oracle and/or its affiliates. 115

Defining Average Salary Rules Chapter 6

116 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 7

Setting Up Termination Pay

Understanding Terminations

The process used to trigger termination payments in Global Payroll for Brazil is based on the conceptof a termination version. A termination version is a collection of actions and reasons that can triggerspecific termination earnings and deductions. In Global Payroll for Brazil, both payees and terminationearnings and deductions are associated with termination versions. When you define a termination earningor deduction, you link it to a termination version. At the same time, when you terminate a payee, thepayee is automatically linked to the termination version that defaults from the termination action andthe reason for his termination. In this way, the system can identify and process only those earnings anddeductions associated with the same termination version.

Elements Used in the Termination Process

The following table identifies key elements of the termination process and explains how they worktogether to trigger termination pay:

Element Description

RC VR VER RESC EMP Delivered variable that contains the termination version (representing the terminationaction and reason) for a terminated payee.

Note: Termination versions are defined on the Termination Versions page.

RC VR RAZAO BAIXA Delivered variable that contains the termination reason.

WORKFORCE_SYNC Service operation that enables the delivered Global Payroll variables RC VR VERRESC EMP and RC VR RAZAO BAIXA to be inserted in the supporting elementoverride table at the payee level (thus associating a terminated payee with thetermination version that applies to his or her termination). The handler and associatedapplication class that inserts these variables is TERMINATION VERSION JOB.

RC GC VER RESCIS Generation control element that determines whether earnings or deductions shouldbe paid in response to a payee's termination. This element is based on the generationcontrol formula RC FM VER RESCI GC.

Copyright © 1988, 2022, Oracle and/or its affiliates. 117

Setting Up Termination Pay Chapter 7

Element Description

RC FM VER RESCI GC Formula that reads via an array element the earnings and deductions eligible for eachtermination version based on the setup pages. The system compares the earnings anddeductions for the termination version to the processing earning/deduction; if it finds amatch, that element (earning or deduction) is calculated for the employee's terminationprocess.

These elements are used to trigger termination pay, as outlined in the following steps:

1. When a payee is terminated or laid off and the appropriate action/reason codes are entered on theJob Data pages in PeopleSoft HR, the system uses the service operation WORKFORCE_SYNC toinsert the Global Payroll variables RC VR VER RESC EMP (containing the termination version) andRC VR RAZAO BAIXA (containing the termination reason) as supporting element overrides at thepayee level (Global Payroll & Absence Mgmt >Payee Data >Create Overrides >SupportingElements). The Begin Date and End Date equal the Termination Date to ensure that the systemprocesses termination earnings and deductions only in the correct segment.

In other words, the service operation links the payee to the termination version (the action and reasoncombination) that applies to his or her specific termination.

Note: The only actions capable of triggering the service operation used to insert the variables RC VRVER RESC EMP and RC VR RAZAO BAIXA in the supporting element override table at the payeelevel are TER (termination), LOF (layoff), and COM (completion).

2. Just as each terminated payee is linked to a termination version, each termination earning or deductionis linked to a termination version on the Termination Version Setup BRA - Earnings/Deductions page.

3. When a payee is terminated or laid off, Global Payroll for Brazil uses the generation control elementRC GC VER RESCIS (in combination with the formula RC FM VER RESCI GC) to include in theemployee's final payment only those earnings and deductions that are part of the same terminationversion associated with the payee in Step 1.

This is done by means of the following comparison:

• When you run a payroll, the generation control element (which is linked to each deliveredtermination earning or deduction on the Calculation page of the Earning/Deduction Definitioncomponent) checks the payee's termination version, as represented by the variables RC VR VERRESC EMP (containing the termination version).

• At the same time, the generation control element checks the termination versions associated witheach delivered termination earning and deduction element via an array element that reads theTermination Version Setup BRA - Earnings/Deductions page.

If the payee's termination version (represented by the variables RC VR VER RESC EMP) hasassociated an earning or deduction than it can be processed.

118 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 7 Setting Up Termination Pay

DSR Compensated Saturday and Indemnities EarningsGlobal Payroll for Brazil provides the ability to process compensated Saturday and indemnified DSRpayments using two new earnings:

• DSR SAB COM (compensated Saturday).

This earning pays an extra day of salary if the termination occurs on a Friday, and that Saturday isconsidered a compensation day in the employee’s work schedule.

• DSR INDENIZ (indemnified DSR).

This earning pays an extra day of salary for the weekly rest day that is granted to the employee after awhole week of work (Monday through Friday or Saturday).

To set up DSR SAB COM and DSR INDENIZ for payroll:

1. Add DSR SAB COM and DSR INDENIZ to the corresponding termination versions on the Earnings/Deductions Page.

2. Update bracket RC BR DSR ABS TYPE (Absences' Types for indem DSR) on the Bracket Data pageto specify absence types that are considered not worked and therefore should not be considered forDSR SAB COM and DSR INDENIZ payments. List the absence types and specify 1 as the returnvalue (which stands for true).

Update bracket FP BR DIA COMPENS (Compensated day-off) on the Bracket Data page to includecompensated Saturday, so that DSR SAB COM and DSR INDENIZ payments can be processedaccordingly. Add KR SABCOM and specify 1 as the return value.

3. Add DSR SAB COM and DSR INDENIZ to the corresponding accumulators on the "MembersPage" (PeopleSoft Global Payroll).

4. Add DSR SAB COM and DSR INDENIZ to the corresponding element group on the "Element GroupName Page" (PeopleSoft Global Payroll).

As delivered, these earnings are included in the KR EG RESCISA element group. If you use adifferent element group, add the earnings to it.

5. Add DSR SAB COM and DSR INDENIZ to the corresponding section on the "DefinitionPage" (PeopleSoft Global Payroll).

As delivered, these earnings are included in the KR RESCISAO PROV section. If you use a differentsection, add the earnings to it.

Methods to Calculate DSR SAB COM and DSR INDENIZ Earnings

Two variables are present that can be overridden at many levels to indicate if DSR SAB COM and DSRINDENIZ are to be calculated:

• RC VR CONTA SAB

• 10 - Pay Saturday (default value)

• 20 - Do not pay Saturday

Copyright © 1988, 2022, Oracle and/or its affiliates. 119

Setting Up Termination Pay Chapter 7

• RC VR SET DSR

• 10 - Pay DSR when termination is on Friday (default value)

• 20 - Do not pay DSR

By default, these variables are set to process DSR payments. However, if these earnings are not includedin the corresponding termination version, they are not going to be calculated.

Viewing Delivered ElementsThe PeopleSoft system delivers a query that you can run to view the names of all delivered elementsdesigned for Brazil. Instructions for running the query are provided in the "Understanding How to ViewDelivered Elements" (PeopleSoft Global Payroll) topic.

Setting Up Termination Versions

To define termination versions, use the Terminations (GPBR_TERM_ACTN_RSN) component.

This topic provides an overview of termination versions and discusses how to define termination versions.

Pages Used to Define Termination Versions

Page Name Definition Name Usage

Termination Versions Page GPBR_TERM_ACTN_RSN Define termination versions and thequalifying actions and reasons fortriggering termination pay.

Earnings/Deductions Page GPBR_TERM_VERSION Associate earnings and deductions with acorresponding termination version.

Understanding Termination VersionsGlobal Payroll for Brazil groups the qualifying actions and reasons for making termination paymentsinto termination versions. Different termination action and reason combinations trigger different sets ofspecial termination earnings and deductions. To define termination versions and then trigger the paymentsassociated with a termination version, you must do the following:

1. Define your termination versions on the Termination Versions page.

2. On the same page, define the associated actions/reasons that will trigger payment.

Termination versions are the combinations of actions/reasons that cause a group of terminationearnings or deductions to be processed.

3. On the Earning/Deductions page, associate each earning or deduction with a correspondingtermination version.

120 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 7 Setting Up Termination Pay

4. On the Job Data pages in PeopleSoft HR, specify termination actions such as Termination,Completion, or Layoff as the action and enter a corresponding reason.

When you specify a termination action as the action in combination with a qualifying reason,termination pay will be processed for the terminated or laid off employees—as long as the terminationor layoff action/reason combination is recognized, by generation control, as valid for triggeringtermination payments.

Labor Reform Update

On November 11, 2017, new labor rules on terminations were implemented as part of the Labor Reform.Under the new reform, employment contracts may be terminated at any time by the mutual consent ofemployers and employees. In the event that a mutually-agreed termination takes place, the employee issubject to reduced prior notice indemnification and FGTS, specifically:

• Half of the prior notice value, if indemnified.

• Half of the indemnification amount on the balance of the FGTS, in case of dismissal by the employerwithout just cause.

• Full of other labor sums.

With this type of termination, the employee is allowed to move up to 80% of the deposit value of his orher linked account in the FGTS. It does not, however, authorize receipt of unemployment insurance forthe employee.

To support terminations by common agreement, Global Payroll for Brazil:

• Delivers a new termination reason (Termination by Common Agreemen) in the Termination Reasondrop-down field and a new GRRF code (Term by Common Agreement) in the GRRF CODE drop-down field for customers to define their own termination versions.

Note: As a customer, you need to create a new reason for the TER (Termination) action on the"Action Reasons Page" (PeopleSoft Human Resources Administer Workforce). Then, create a new orupdate an existing termination version using these three values to support this termination type.

See Termination Versions Page

• Updates elements and rules for payment of this termination type to be processed correctly.

• AVISO PRE IN - the new value is 50% of the total amount calculated.

• IND COM-FGTS - the new value is 50% of the total amount calculated.

Note: As a customer, you need to update the RC FM FERIAS PROP formula (which is used tocalculate the FERIAS AV IN element) to include the new reason that you created for the terminationaction. The new reason populates the RC VR RAZAO BAIXA variable when an employee isterminated in the Job Data component.To update the RC FM FERIAS PROP formula, access the "Field-by-Field DefinitionPage" (PeopleSoft Global Payroll) and navigate to row 38. From the Field-by-Field Area section,select Character in the Entry Type 2 field, and enter your newly created action reason code in theCharacter Value 2 field. Save the changes and click the Validate button to validate the formula.Then, access the "Text Definition Page" (PeopleSoft Global Payroll) and view the formula text line byline. Verify that your new action reason code is displayed in line 38.

Copyright © 1988, 2022, Oracle and/or its affiliates. 121

Setting Up Termination Pay Chapter 7

• Updates the Termination Contract (TRCT) report to display appropriate values.

See Legal Codes by Process Type BRA Page and Legal Codes by Action Reason BRA Page

• Updates the CAGED run control page to support the Termination by Common Agreement type, andthe CAGED report to display the corresponding information, if configured.

See "CAGED File/Report BRA Page" (PeopleSoft Human Resources Administer Workforce)

• Updates the GRRF report to display appropriate values.

• Updates the SEFIP report to display appropriate values.

• Adds movement legal codes to associate with termination action and reason combinations for use inSEFIP reporting.

See Legal Movement Codes BRA Page

Termination Versions PageUse the Termination Versions page (GPBR_TERM_ACTN_RSN) to define termination versions and thequalifying actions and reasons for triggering termination pay.

Navigation:

Set Up HCM > Product Related > Global Payroll & Absence Mgmt > Terminations > TerminationVersion Setup BRA > Termination Versions

This example illustrates the fields and controls on the Termination Versions page.

Note: (For terminations by common agreement) Global Payroll for Brazil delivers a termination reason(Termination by Common Agreement) and GRRF code (Term by Common Agreement) to supportterminations that are mutually agreed by employers and employees.

Field or Control Description

Termination Version Displays the name of the termination version you are defining.

Version - Action/Reason Definition

Use the fields in the Version - Action/Reason group box to define the termination action/reasoncombinations that make up the termination version.

122 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 7 Setting Up Termination Pay

Note: A single termination version can consist of many different action/reason combinations—as long asall the combinations trigger the same set of termination earnings or deductions.

Field or Control Description

Action Specify the action that triggers termination pay in combinationwith a specific reason. Values are:

COM (Completion)

LOF (Layoff)

TER (Termination)

TWB (Terminated with Benefits)

TWP (Terminated with Pay)

Copyright © 1988, 2022, Oracle and/or its affiliates. 123

Setting Up Termination Pay Chapter 7

Field or Control Description

Reason Specify the reason that triggers termination pay in combinationwith a specified action. Values for each action are:

• For COM Action: BMC (Board Member TermCompleted), DEA (Death), DIS (Disability), EOA (End ofAssignment), INV (Involuntary), RED (Staff Reduction), RET (Retirement), UNS (Unsatisfactory Performance), and VOL (Voluntary).

• For LOF Action: RED (Staff Reduction), SEA (SeasonalClosure), SLO (Strike/Lock-out), and TMP (TemporaryClosure).

• For TER Action: ATC (Agreed Term. of Apprent ofCDD), ATT (Attendance), BNK (Employer Bankruptcy), CDE (Closing Down of Establishment), CHI (Child/House Care), CIT (Completion of Int Cpny Trans), CON (Misconduct), DEA (Death), DIS (Dishonesty), DSC (Discharge), EAB (Employer's Anticipated Breach), EAC (End of Apprenticeship Contract), EES (Dissatisfied w/Fellow Employee), EFT (End of Fixed-Term Contract), ELI (Elimination of Position), EOD (End of Demand), EPP (Employer's End Probation Time), ERT (EarlyRetirement), FAM (Family Reasons), FRE (End ForeignEmployment AUS), GMI (Gross Misconduct), HEA (Health Reasons), HRS (Dissatisfied with Hours), ILL (Illness in Family), INS (Insubordination), JOB (JobAbandonment), LOC (Dissatisfied with Location), LTC (Legal Termination of Contract), LVE (Failure to Returnfrom Leave), MAR (Marriage), MIS (Misstatement onApplication), MUT (Mutual Consent), OBS (BecomeSelf-Employed), OTP (Resignation-Other Position), PAB (Payee's Anticipated Breach), PAY (Dissatisfied withPay), PCD (Premises Closed), PER (Personal Reasons), PIT (Permanent Int Cpny Transfer), POL (Dissatisfiedw/Comp. Policies), PPO (Pension Payee Off), PPP (Payee's End Probation Time), PRM (Dissatisfied w/Promotion Opps), PTD (Partial/Total Disability), RAT (Retired from Affiliate), RED (Staff Reduction), REF (Refused Transfer), REL (Relocation), RES (Resignation), RET (Return to School), RKM (Release Kenmu), RLS (Release), RWU (Receivership or Wind-Up), SUP (Dissatisfied with Supervision), TAF (Transferto Affiliate), TAR (Tardiness), TMP (End TemporaryEmployment), TRA (Transportation Problems), TYP (Dissatisfied w/Type of Work), UFC (UnforeseenCircumstances), UNS (Unsatisfactory Performance), VIO (Violation of Rules), VSP (Voluntary SeparationProgram), and WOR (Dissatisfied w/Work Conditions).

124 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 7 Setting Up Termination Pay

Field or Control Description

• For TWB Action: TWB (Terminated With Benefits).

• For TWP Action: TWP (Termination With Pay).

Termination Reason Select an applicable termination reason. This information isused in some Brazilian reports (such as GRFC).

GRRF CODE Select a GRRF code for the specified action and reasoncombination, if applicable.

Values are:

Contract Termination

Mutual Fault/Force Majeure

Not Applicable (default)

Other Termination Reasons

Term Domestic Payee Unfair

Term Employer Decision Unfair

Term by Common Agreement

Earnings/Deductions PageUse the Earnings/Deductions page (GPBR_TERM_VERSION) to associate earnings and deductions witha corresponding termination version.

Navigation:

Set Up HCM > Product Related > Global Payroll & Absence Mgmt > Terminations > TerminationVersion Setup BRA > Earnings/Deductions

This example illustrates the fields and controls on the Earnings/Deductions page.

Copyright © 1988, 2022, Oracle and/or its affiliates. 125

Setting Up Termination Pay Chapter 7

Field or Control Description

Entry Type Select whether you are entering an Earnings or a Deductionelement.

Element Name Select the element to associate with this termination version.

126 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 8

Defining Earnings

Calculating Earnings

Global Payroll for Brazil enables you to calculate:

• Base compensation

• Bonuses and premiums

• Additional earnings

• Overtime

Calculating Base CompensationTo calculate earnings for employees, the system uses the following earning elements:

Salary

The amount paid depends upon the employee category and is calculated for the payment period.

This table describes the elements that the system uses to calculate salary:

Earning Element Description

SALARIO MENS Contains the monthly salary for accumulation monthly rate from Job record.

SALARIO Used to pay salary for monthly employees.

SALARIO SAFR Used to pay salary for agricultural workers.

HORASNORMAIS Used to pay labor hours according to a planned work schedule for hourly employees.

DSR HR NOR Used to pay rest day hours according to a planned work schedule.

Note: Delivered earning elements that include the abbreviation MEN, such as PERIC MEN (hazardousbonus monthly) are used to calculate other earnings or deductions that are based on the monthly amounteven though the employee does not receive the entire monthly payment.

Copyright © 1988, 2022, Oracle and/or its affiliates. 127

Defining Earnings Chapter 8

Commission

Payment of commissions are required only upon conclusion of the transaction to which they refer.Termination of employment does not halt the payment of a commission. Commissions are payablemonthly, or within three months of the settlement agreement. To calculate commissions, the system usesthe COMISSAO earning, which is populated by positive input for each employee.

DSR Commission - Regarding Weekly Rest

For commissions corresponding to Sundays and holidays, the system uses the earning DSR COMISS topay the estimated commission, and the DSR COMMISSAO accumulator and FP FM DSR formula.

Minimum Guaranteed

The minimum guaranteed salary is either defined by the Labor Collective Agreement and the professionalcategory, or by the minimum wage. The difference between the salary earned and the minimumguaranteed salary must be paid by the organization and not compensated in future payments.

Formula FP FM MIN GAR compares the commission with the minimum guaranteed value specified onthe Union Parameters BRA Page. If the commission is less than the minimum the system adjusts earningMIN GARANTID with the value needed to reach the minimum.

Cost Allowances and Travel Expenses

Cost allowances and travelling expenses may be granted and will be taxed when they exceed 50 percentof the salary value. This table describes earnings for Global Payroll for Brazil:

Earning Description

DIARIAS VIAG This earning is used to pay daily amounts in case of trips. Receive days (as units) throughPositive Inputs. Formula FP FM DIARIAS checks if the calculated amount is greater than50% of employee salary. In this case, put zero to this amount and keep the value in variableFP VR DIARIAS>50%. This earning is nontaxable.

DIARIAS>50% This earning is used to pay daily amounts in case of trips. It receives its value from variableFP VR DIARIAS>50%. This earning is taxable.

AJUDA CUSTO Earning to pay the cost allowances. This value comes from positive input for each employee.

Calculating Bonuses and PremiumsGlobal Payroll for Brazil enables you to create bonuses, replacement bonuses, and position compensationbonuses.

The bonus earning uses the formula FP FM BONUS to calculate its final amount. This formula applies toa percentage based on variable FP VR % BONUS over the employee remuneration and checks the limitvalue from variable FP VR LIMITE BONUS.

128 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 8 Defining Earnings

The replacement bonus dummy earning GRAT SUB MEN is populated by positive input for eachemployee. This element stores the monthly amount and can be used in some accumulators. The earningGRATIF SUBS is used to pay the replacement bonus. This value can be prorated.

The position compensation bonus dummy earning is populated by positive input for each employee. Thiselement stores the monthly amount and can be used in some accumulators. The earning GRATIF FUNC isused to pay the position compensation bonus. This value can be prorated.

The system uses the earning PREMIO to calculate premiums. Its value is determined by positive input foreach employee.

Calculating Additional EarningsWorking under risky conditions can merit extra pay. Percentages may vary according to union andcollective agreements. This table lists the allowance types and the formulas and elements used for each:

Type of Allowance Calculation Formula Elements Used

Additional Allowance for HazardousLabor

Calculation Base * 0,30 The system calculates these earningsonly for employees with hazard levelsspecified on the Payee Parameters page:

• Generation Control FP GCPERICULOS

• Dummy Earning PERIC MEN (Calculates and stores the monthlyamount. This earning can be used inaccumulators.)

• Earning PERICULOSIDA (Used tomake payments.)

• Accumulator PERICULOSIDADE (Calculation base. This value can beprorated.)

Accumulator ACUM PERICULOS (Defines the Calculation Base usedto obtain the earnings PERIC MENand PERICULOSIDA amount.)

Copyright © 1988, 2022, Oracle and/or its affiliates. 129

Defining Earnings Chapter 8

Type of Allowance Calculation Formula Elements Used

Additional Allowance for UnhealthyLabor

Level 1: Minimum Wage * 0,10

Level 2: Minimum Wage * 0,20

Level 3: Minimum Wage * 0,40

The system calculates these earningsonly for employees with unhealthy laborlevels specified on the Payee Parameterspage:

• Generation control FP GCINSALUBR

• Dummy earning INSALU MEN (Calculates and stores the monthlyamount. This earning can be used inaccumulators.)

• Earning INSALUBRIDAD (Used tomake payments. This value can beprorated.)

• Variable FP VR MIN NAC (Used tostore the national minimum wage.)

• Bracket FP BR % INSALUB (Usedto convert the Payee Parameter pageto a percentage.)

Night Shift Night Shift Hours * Hour Value * 0,20 Earning ADIC NOTURNO: (This is aUnit*Rate*Percent earning.)

• The units should be entered throughpositive input.

• The rate is defined by the hourlyrate.

• The percent is informed directly inthe earning definition

130 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 8 Defining Earnings

Type of Allowance Calculation Formula Elements Used

Length of Service Annual: Value of Annuity * YearsWorked

Biennium: Value of Biennial * (YearsWorked/2)

Quinquennium: Value of Quinquennium* (Years Worked/5)

Length of service can be calculated inmany ways. This payment is optional. The PeopleSoft template includes aquinquennium example.

• Dummy earning QUINQUENMEN (Calculates and stores themonthly amount. This earning canbe used in accumulators.)

• Earning QUINQUENIO (Usedfor payments. This value can beprorated.)

• Formula FP FM QUINQUENIO (Used to obtain the units to be paid. The formula divides the length ofservice duration element (FP DRTEMPO SERV) by 5.)

• Bracket FP BR QUINQUENIO (Used to obtain the percent in thevariable FP VR 5 QUINQUENIOaccording to the Union Code on theJob Data table.)

Transfer Calculation Base * Percentage ofTransfer

Earning ADIC TRANSF (This is aBase*Percent earning that applies25% over the accumulator ACUM ADTRANSF.)

Standby Employee Paid on a percentage basis. Earning SOBREAVISO (This is aUnit*Rate*Percent earning that receivesthe units through positive input. Thesystem uses the variable FP VR PCTSOBREAV to apply an hourly rate to thepayment 0.)

Calculating OvertimeThe system uses the allowances described in this table to calculate overtime:

Copyright © 1988, 2022, Oracle and/or its affiliates. 131

Defining Earnings Chapter 8

Type of Allowance Calculation Formula Elements Used

Weekday Overtime Monthly Calculation Base / MonthlyBase Hours * Quantity of Overtime * 1,50

Earnings HORA EX D50%, HORAEX D70%, HORA EXD100%, HORAEX N50%, HORA EX N70%, HORAEXN100% (These earnings areUnit*Rate*Percent earnings. Units areentered through positive input. Rateis defined by the formula FP FM VRHR>HE, which divides the accumulatorACUM HORAS EXT by StandardHours. Our template uses monthlystandard hours. The percent is storeddirectly in the earning definition.)

Sunday and Holiday Overtime Monthly Calculation Base / MonthlyBase Hours * Quantity of Overtime * 2,00

• Earning DSR ADC HS (This is aBase*Percent earning.)

• DSR accumulator

• Formula FP FM CONTA HORAS (Preprocess formula.)

• Formula FP FM DSR (Calculatesthe percentage.)

Defining Salary Advances

Salary advance is usually paid at the 10th or 15th of the month. The advance is based on 40 percent of themonthly salary and the number of days worked during the month. The remainder of the monthly salary(the balance) is then paid on the 5th of the following month.

The monthly salary calculation varies by employee type:

• Monthly employees: 40 percent of minimum wage.

• Hourly employees: 40 percent of a 220-hour month at the hourly minimum wage.

• Commission Employees: 40 percent of average commissions.

The system uses the following information when processing salary advances:

• Employee HR information: Name, registration, hire date.

• Time management information: Absences, vacations.

Element Type Element Name Description

Process List KR PR AD QUINZ Process to advance payment.

132 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 8 Defining Earnings

Element Type Element Name Description

Section KR SE INIC QUIN Initialization section for income tax if it is regime decaixa.

Section KR SE REMUN MEN Monthly remuneration calculation of the advancedpayment calculation base.

Section KR SE ADIANTAMENTO Gets the advanced pay amount.

Section KR SE REC IR Calculates the income tax if it is a regime de caixa.

Earning ADIANTAMENTO Used to make payments. Applies the percent in AD VR %ADTO over the ACUM AD QUINZ.

Deduction DESC ADTO In payroll process, this deduction is used to discount theadvanced payment.

Accumulator ACUM AD QUINZ This is an advanced pay calculation base.

Variable AD VR OPCAO Taken from the Payee Parameter page.

Variable AD VR % ADTO Accepts the payee override from option in PayeeParameter page.

Salary Advances and TaxationIf the salary advance and the balance payment are made in the same month, the advance is not subjectto any type of tax deduction. The value will be paid in full according to the percentage set forth on theindicated salary. Taxes are deducted from the balance payment made at the end of the month.

If the salary advance and the balance payment are not made in the same month, the company is requiredto withhold income tax on the advance payment.

Related LinksUnderstanding Income Tax Withholding

Loading Batch Positive Input

You can use batch positive input to reduce time-consuming data entry in Global Payroll for Brazil. Forexample, you could enter and trigger bonuses for all of your employees using batch positive input, or youcould trigger mass deductions. Suppose that an employer has an agreement with a cell phone company toprovide half the employee population with a 50 percent discount rate on calls. Instead of entering each ofthe monthly cell phone invoices (deductions) for each employee, the cell phone company could generate aflat file with a layout that loads this invoice information using a batch process.

Copyright © 1988, 2022, Oracle and/or its affiliates. 133

Defining Earnings Chapter 8

This topic describes how to load the batch positive input.

Page Used for Loading Batch Positive Input

Page Name Definition Name Usage

Manage Pos Input via Batch BRA Page (manage positive input via batch BRApage)

GPBR_PI_BATCH Create batch positive input.

Manage Pos Input via Batch BRA PageUse the Manage Pos Input via Batch BRA (manage positive input via batch BRA) page(GPBR_PI_BATCH) to create batch positive input.

Navigation:

Global Payroll & Absence Mgmt > Absence and Payroll Processing > Prepare Payroll > ManagePos Input via Batch BRA > Manage Pos Input via Batch BRA

This example illustrates the fields and controls on the Manage Pos Input via Batch BRA page.

Warning! This process provides the ability to add, modify or remove a large amount of data in yoursystem. Exercise caution when you manipulate data using this batch process.

134 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 8 Defining Earnings

Field or Control Description

Clear Data Select this check box to delete data that was previously loadedusing the selected pay group, calendar ID, and batch code.

Important! You may use this option to delete data that wasloaded by mistake. However, do not select this option unlessyou are certain that the data specified needs to be removedfrom the system.

Pay Group Select the pay group for the batch process.

Calendar ID Select the calendar ID (not finalized) for the batch process. Available values are refined by the specified pay group.

The system validates the calendar ID, and disables the Runbutton if the selected calendar ID is finalized.

Action Type Select the action to be performed. Choose from the following:

Add

Do Not Process

Override

Resolve To Zero

This field appears if the Clear Data field is not selected.

Batch Code Enter the code that is used to identify the set of data to beloaded for this batch run. Enter this value for the batch processwhen the Clear Data option is not selected.

When the batch process is executed, it updates the batchcode by appending the word BATCH. For example, if youentered 123 as the batch code, the new batch code becomesBATCH123 after the process is completed. Should you needto delete the data loaded in batch code 123 in the future, look up the batch from the prompt using the new batch code (BATCH123).

Input Directory Specify the full location of the flat file containing the batchpositive input (flat file directory), including the name of theflat file.

This field appears if the Clear Data field is not selected.

Copyright © 1988, 2022, Oracle and/or its affiliates. 135

Defining Earnings Chapter 8

Field or Control Description

Output Directory Displays the name of the log file for the batch run. The namingconvention of the log file is OUTPUT_<batch code>.txt,and it is generated automatically to store any errors foundduring the batch process. The log file is available for reviewon the View Log/Trace page (PMN_CDM_INDEX) of thecorresponding process detail.

This field appears if the Clear Data field is not selected.

Flat File Layout for Batch Positive Input

When you create flat files for the batch positive input process, reproduce the following file definition:

Field Initial Position Length

EMPID 1 11

EMPL_RCD 12 3

PIN_NM 15 18

GP_UNIT 33 20

GP_AMT 53 20

GP_RATE 73 20

GP_PCT 93 11

PC_BASE 104 20

DEPTID 124 10

JOBCODE 134 6

Here is an example:

Field Example

EMPID GR0045

136 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 8 Defining Earnings

Field Example

EMPL_RCD 0

PIN_NM COMISIONES

GP_UNIT 12.58

GP_AMT 11.36

GP_RATE 10

GP_PCT 1.3

PC_BASE 25.36

DEPTID KR000

JOBCODE KR001

Note: This flat file definition applies to both earnings and deductions that you load using batch positiveinput.

Related Links"Understanding Positive Input" (PeopleSoft Global Payroll)

Copyright © 1988, 2022, Oracle and/or its affiliates. 137

Defining Earnings Chapter 8

138 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 9

Understanding Deductions

Understanding Deduction Types

In Brazil, two types of deductions are available:

• Before taxes reduces the net salary and the taxable gross for federal retention, or other taxes based onthe accumulators used. Examples are FALTA INJUSTIFICADA and DESC DSR.

• After taxes reduces the net salary. Examples are CLUBE, EMPRESTIMO, and FARMACIA.

Note: You define all deductions for Brazil in the Deductions (GP_DEDUCTION) component in the coreapplication.

Related LinksUnderstanding Income Tax Withholding"Understanding Earning and Deduction Elements" (PeopleSoft Global Payroll)

Using Batch Positive Input

You can use batch positive input to reduce time-consuming data entry in Global Payroll for Brazil. Forexample, you could trigger mass deductions. Assume that an employer has an agreement with a cellphone company to provide half the employee population with a 50 percent discount rate on calls. Insteadof entering each of the monthly cell phone invoices (deductions) for each employee, the cell phonecompany could generate a flat file with a layout that loads this invoice information using a batch process.

Setting up the flat file for batch positive input is discussed in "Defining Earnings."

Related LinksCalculating Earnings

Creating Deduction Elements

To ensure that new deduction elements you create are used correctly in other calculations, you need toknow which accumulators they should contribute to, since the value of the accumulated deductions iscritical to these other processes. The accumulator elements to which you will be adding your elements arethe same ones that Global Payroll for Brazil has created for the delivered deduction elements. These arelisted and described below:

Copyright © 1988, 2022, Oracle and/or its affiliates. 139

Understanding Deductions Chapter 9

• Any deduction that you want to contribute to the Net Pay should be included in the TOTALDESCONTOS N accumulator.

Note: Many deductions are only for demonstration purposes. These dummy deductions should not beincluded in TOTAL DESCONTOS N.

• Any deduction that you want to subtract from the taxable base for federal tax purposes should beincluded in the IR REN BRUTA accumulator, if it should reduce the calculation base, or in the IRDEDUÇÕES accumulator, if it is a legal income tax deduction.

Adding your new deductions to the proper accumulators ensures that the new element fits into the existinglogic and organization of Global Payroll for Brazil and that it is included in the correct calculations fortaxes, social security, and so forth.

Related Links"Overrides Available for Supporting Elements" (PeopleSoft Global Payroll)

Viewing Delivered Deduction Elements

This section discusses:

• General deductions.

• Process lists with deductions.

The PeopleSoft system delivers a query that you can run to view the names of all delivered elements thatare designed for Brazil. Instructions for running the query are provided in the "Understanding How toView Delivered Elements" (PeopleSoft Global Payroll) topic.

Note: The majority of the deduction elements for Brazil are defined as PeopleSoft Delivered/NotMaintained. This means that you can modify these elements to fit your needs and, when necessary, createyour own earnings using the delivered elements as your guide. You should not modify deduction elementsthat are defined as PeopleSoft Delivered/Maintained.

General DeductionsThe following table lists the general deductions for Brazil:

Deductions Description

EMPRESTIMO Loan's Portion

VALE TRANSP Transportation Ticket

IRRF Income Tax

140 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 9 Understanding Deductions

Deductions Description

FALTA INJUST Unpaid Absence

DESC DSR Lost Weekly Rest

FARMACIA Drugstore discount (Positive Input, Payee)

ASSMEDICAFUN Discount of medical attendance

T REFEIÇÃO Discount of ticket meal

CLUBE Discount of recreational club

SUPERMERCADO Supermarket Discount (Positive Input, Payee)

SEG VIDA Life insurance discount leaves used

1/2 FAL INJ Half Unpaid Absences

INSS INSS

CONTR SIND Union Contribution

CONTR ASSIS Union Assistance Contribution

CONTR CONF Union Confederation Contribution

MENS SIND Monthly Union Contribution

DESC ADTO Advance Payment - Payback

INDEM40% Indemn Art. 22

INDE Severance Pay

INSS 13º SAL INSS 13º Salary Contribution

DES ADIAN 13 13º Paid in Advance

PENSÃO ALIM Alimony Total

Copyright © 1988, 2022, Oracle and/or its affiliates. 141

Understanding Deductions Chapter 9

Deductions Description

DESC INS SLD Negative Balance Discount

LIQ FERIA Net Vacation

INSS FER PAG Paid INSS Vacation

IRRF FER PAG Paid Vacation IRRF

INSS FE DIF INSS Vacation Retro

IRRF FE DIF Vacation IRRF Retro

FER PENS BRU Paid Alimony

Process Lists with DeductionsA specific process list for deduction calculations does not exist. All defined process lists contain bothdeductions and earnings.

The following are the main sections used to calculate deduction elements for Brazil:

• KR ENCARGOS LEGAIS

• KR DESC ADIA QUINZ

• KR IMPOSTO RENDA

• KR AUSENCIAS FOL

• KR PENS ALIMENTIC

• KR OUTROS DESCTOS

Note: A list of delivered process lists used to calculate deductions and other elements can be found in theViewing Delivered Process Lists topic.

Related Links"Understanding Processing Elements" (PeopleSoft Global Payroll)

142 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 10

Creating Payslips

Understanding the Payslip Definition Process

In Brazil, companies have to provide a standard payslip that contains information such as the numberof worked days and wages. The payslip is delivered to employees depending on the payment frequency(monthly).

Note: In addition to the payroll payslip, Brazilian companies are required to provide their payees with avacation payslip. Global Payroll for Brazil is delivered with sample payroll and vacation payslips that youcan use as the basis for developing your own payslip formats.

You can define the criteria for printing your payslips so that they display exactly the information that yourequire. You can also prioritize the sort criteria and select the earnings, deductions, and calculation basesyou want included in the payslip.

To define payslips:

1. (Optional) Create a group if you want to use Group ID as a criterion for selecting employees whenyou generate payslips.

Each time you run the payslip process, the Group ID is refreshed.

See "Understanding Group Build" (Application Fundamentals).

2. Define the sort criteria for your payslip on the Sort ID BRA page.

3. Select the earnings, deductions, and calculation bases that you want included on the payslip on theElement Lists BRA page.

4. Generate the payslip from the Payslip Report page.

Note: The Sort IDs BRA Page and Element Lists BRA Page can be used for payslips. The Element ListsBRA page also runs the Payroll Results Register and the Financial Registry Report.

Related LinksSetting Up Utilities in Global Payroll for Brazil

Viewing Delivered ElementsThe PeopleSoft system delivers a query that you can run to view the names of all delivered elementsdesigned for Brazil. Instructions for running the query are provided in the "Understanding How to ViewDelivered Elements" (PeopleSoft Global Payroll) topic.

Copyright © 1988, 2022, Oracle and/or its affiliates. 143

Creating Payslips Chapter 10

Viewing Payslips

If you licensed PeopleSoft ePay, employees can view their payslips online using the self-service ViewPayslip transaction. To help resolve questions raised by employees about their payslips, the payrolladministrator can view employees' self-service payslips in an online view that replicates the employee'sview.

Related Links"Viewing Payslips Online" (PeopleSoft ePay)

Running the Payslip Report

This topic discusses how to generate the payslip report.

Page Used to Run the Payslip Report

Page Name Definition Name Usage

Create/Print Payslips BRA Page GPBR_RC_PAYSLIP Generate a payslip. Note that you mustfirst define the Group ID to generatea payslip. All groups selected in theGroup ID field will automatically be re-created during the payroll run.

Create/Print Payslips BRA PageUse the Create/Print Payslips BRA page (GPBR_RC_PAYSLIP) to generate a payslip.

Note that you must first define the Group ID to generate a payslip. All groups selected in the Group IDfield will automatically be re-created during the payroll run.

Navigation:

Global Payroll & Absence Mgmt > Payslips > Print Payslips BRA > Create/Print Payslips BRA

144 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 10 Creating Payslips

This example illustrates the fields and controls on the Create/Print Payslips BRA page.

Field or Control Description

Calendar Group ID and Calendar ID Select the calendar group ID and then select the calendar.

Vacations and Run Type Select to indicate this is a vacations payslip and then select therun type. When selected, the Calendar ID field becomes theRun Type field.

Format ID Select the Format ID. This value is defined on the ElementLists BRA page and defines the elements listed in the payslip.

Sort ID Select the Sort ID. This value is defined on the Sort ID BRApage.

Message Enter the text for a message that you want to appear on theprinted payslips.

Calendar List Option Select a method for selecting employees for whom to create apayslip.

Establishment ID, Group ID, and EmplID Based on the selection you make in the Calendar List Optionfield, one of these fields appears. Enter the criteria that youwant to use to select employees.

Related LinksElement Lists BRA PageSort IDs BRA Page

Copyright © 1988, 2022, Oracle and/or its affiliates. 145

Creating Payslips Chapter 10

146 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 11

Managing Off-Cycle Payments for Brazil

Understanding Off-Cycle Processing

This section discusses:

• The off-cycle process.

• Types of off-cycle transactions.

• Viewing delivered elements.

The Off-Cycle ProcessOff-cycle processing refers to processing payments and making corrections to payroll results outside ofthe normal payroll schedule. Off-cycle transactions are usually made to correct previous payments, entermanual payments, or make early termination payments that cannot wait until the next scheduled payroll.

Types of Off-Cycle TransactionsThe four types of off-cycle transactions are:

1. Manual payments

Manual payments enable you to enter payments that you have calculated and paid outside of thepayroll system. An example is paying a new hire with a manual check because their pay details werenot entered in time for the normal pay run.

2. Corrections

Corrections enable you to correct results of any finalized payroll. An example is reversing a sick leavepayment when workers compensation should have been paid.

3. Unscheduled payments

Unscheduled payments enables you to enter one-time payments that fall outside the normal payrollprocess. Examples include one-time bonuses or expense reimbursement.

4. Advances

Advances enables you to pay payees before their normally scheduled pay run. An example is salarydue on termination.

Copyright © 1988, 2022, Oracle and/or its affiliates. 147

Managing Off-Cycle Payments for Brazil Chapter 11

Viewing Delivered ElementsThe PeopleSoft system delivers a query that you can run to view the names of all delivered elementsdesigned for Brazil. Instructions for running the query are provided in the "Understanding How to ViewDelivered Elements" (PeopleSoft Global Payroll) topic.

Recording Manual Payments for Brazil

This section discusses how to enter manual payments.

Entering Manual PaymentsWhen entering manual payments for Brazilian payees, you should manually calculate all calculationsoutside the system and then enter them. Consider these points when entering manual payments:

• Selecting the Period (Calendar) Paid and Payment Date values on the Period Calendar tab of theManual Payments page.

The selection of the period paid and payment date need to be considered carefully. When selectingthe period paid, it is recommended that you select the previous finalized calendar or the currentopen calendar. The selection of the payment date directly affects how elements are accumulated. Forexample, if you have an accumulator that accrues based on period end date, the payment date may notupdate the accumulator balances at the right time.

• Selecting processing controls on the Manual Payments page.

The Period Begin Date and Period End Date values should appear by default after you select Period(Calendar) Paid. You should not change these dates because the delivered Brazil rules were designedto calculate using whole periods, and they may not automatically segment if a partial period isentered.

The run type is provided by default from the Period (Calendar) Paid selection, and you should usethe default. To ensure that the payee's manual payment is processed by the system, select the AllowDuplicates check box for the run type; otherwise, the payee may not be processed again if the systemdetects that they were already processed in the period.

Selecting Stop Regular Resolution enables you to stop the resolution of all elements on the process listexcept the elements entered into the manual payment. If you decide to allow regular resolution, youwould need to perform an analysis to understand the effect on your supporting elements.

If using the Limited Element Set, you must ensure that all elements calculate independently of pre- orpost-processing formulas, as these do not resolve during off-cycle processing.

Note: Manual payments are used to record monetary values only; absence accumulators will not beupdated using this method.

148 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 11 Managing Off-Cycle Payments for Brazil

Entering or Reversing Payroll Results for Brazil

This section provides an overview of corrections and provides examples of how to make corrections usingthe Brazilian delivered rules.

CorrectionsThe Corrections page of the Off-Cycle Requests component (GP_OFFCYCLE_SETUP) is used when youneed to change finalized results, usually due to a user error. This method uses period-to-date logic builtinto the Brazilian delivered statutory rules.

The following areas need to be considered when entering corrections:

• All earnings and deductions need to have period-to-date logic applied.

• This method is used to correct pay accumulators only. Absence accumulators will not be corrected.

Making Unscheduled Payments for Brazil

You use the Unscheduled Payments page of the Off-Cycle Requests component(GP_OFFCYCLE_SETUP) to make one-time payments that are processed outside of the on-cycle payroll.Examples include bonuses and expense reimbursements. This method uses period-to-date logic, which isbuilt into the Brazilian-delivered statutory rules, when it calculates.

You should consider these points when entering unscheduled payments:

• All earnings and deductions need to have period-to-date logic applied.

• When selecting the period paid, you should select the previous finalized calendar or the current opencalendar.

• This method is used to record monetary values only. Absence accumulators will not be updated.

Issuing Advance Payments for Brazil

You use the Advance Payrolls page of the Off-Cycle Requests component (GP_OFFCYCLE_SETUP)when you want to pay an employee before their normal on-cycle pay run. For example, an employeeis terminating employment with your organization, and the termination payment needs to be paidimmediately and not in the next on-cycle pay run. When you make advance payments:

• Always select the next open calendar, as skipping calendars may update accumulators incorrectly.

• Absence accumulators will calculate automatically for the calendar group selected.

Note: Advance Payroll does not replace Pay in Advance functionality used for Brazilian absences.

Copyright © 1988, 2022, Oracle and/or its affiliates. 149

Managing Off-Cycle Payments for Brazil Chapter 11

150 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 12

Processing Banking

Understanding the Banking Process for Brazil

The banking business process in PeopleSoft Global Payroll is optional. If you decide to use the bankingbusiness process, start by defining pages in the core application and continue with processing in GlobalPayroll for Brazil. Before running the banking process for Brazil, you must set up basic bankinginformation in the core application, such as:

• Defining bank addresses.

• Identifying source banks and linking source banks to pay entities.

• Defining recipients.

• Defining payee bank accounts.

• Specifying net pay elections.

• Defining deposit schedules.

• Defining centralization data.

Note: The information below only discusses the banking process for Global Payroll for Brazil, whichoccurs after you've set up the banking information in the core application.

After running a payroll, funds are sent to the bank, along with instructions for payment. The bank needsto know who is going to be paid, how much they are to be paid, and which bank the wages are paid to.This information is extracted from the core application and stored in the Brazilian payroll files, based ona list of payees corresponding to those in the last payroll run. A file is created with a line for each payee,containing a name, bank account number and amount of money. This file is sent to the bank that thendistributes the funds.

Viewing Delivered ElementsThe PeopleSoft system delivers a query that you can run to view the names of all delivered elementsdesigned for Brazil. Instructions for running the query are provided in the "Understanding How to ViewDelivered Elements" (PeopleSoft Global Payroll) topic.

Defining Recipients

To define deduction recipients and to select recipients' deposit schedules, use the Deduction RecipientsBRA (GPBR_RECIPIENT) component.

Copyright © 1988, 2022, Oracle and/or its affiliates. 151

Processing Banking Chapter 12

Pages Used to Define Recipients

Page Name Definition Name Usage

Recipient Information Page GPBR_RECIP_INFO Enter basic personal information ofdeduction recipients.

Define Deduction Recipients Page RECIPIENT Define general and individual recipientsfor deductions.

Recipient Deposit Schedule Page RECIPIENT_DEP_INFO Select recipients' deposit schedule.

Recipient Information PageUse the Recipient Information page (GPBR_RECIP_INFO) to enter basic personal information ofdeduction recipients.

Navigation:

Set Up HCM >Product Related >Global Payroll & Absence Management >Banking >DeductionRecipients BRA

This example illustrates the fields and controls on the Recipient Information page.

Personal Information

Use this section to enter basic personal information of individuals who receive alimony payment throughpayroll. Information entered here is used in eSocial reporting.

Field or Control Description

Name Enter the full name of the recipient.

152 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 12 Processing Banking

Field or Control Description

Date of Birth Enter the birth date of the recipient.

National ID Type and National ID Select a national ID type, and enter the corresponding ID forthe selected type.

Enter one or more rows of national ID for the recipient. Supported national ID types include:

CAIXA

CPF - Person Registry (required)

CTPS - Work Card

Civil Registry ID

Foreigner ID

General Registry

Health National Card

Militar Certificate

NIT Number

New Born ID

PASEP or PIS

Voter Registration Card

Primary ID Select to indicate that the corresponding national ID is theprimary ID of the recipient.

Related Links"Define Deduction Recipients Page" (PeopleSoft Global Payroll)"Recipient Deposit Schedule Page" (PeopleSoft Global Payroll)

Define Deduction Recipients PageUse the Define Deduction Recipients page (RECIPIENT) to define general and individual recipients fordeductions.

Navigation:

Set Up HCM >Product Related >Global Payroll & Absence Management >Banking >DeductionRecipients BRA

Copyright © 1988, 2022, Oracle and/or its affiliates. 153

Processing Banking Chapter 12

See "Define Deduction Recipients Page" (PeopleSoft Global Payroll).

Recipient Deposit Schedule PageUse the Recipient Deposit Schedule page (RECIPIENT_DEP_INFO) to define general and individualrecipients for deductions.

Navigation:

Set Up HCM >Product Related >Global Payroll & Absence Management >Banking >DeductionRecipients BRA

See "Recipient Deposit Schedule Page" (PeopleSoft Global Payroll).

Creating Bank Reporting Formats

This topic discusses how to create bank reporting formats.

Pages Used to Create Bank Reporting Formats

Page Name Definition Name Usage

Layout Definition Page GPBR_LAYOUT Create new bank reporting layouts fordifferent EFTs.

Layout Criteria Page GPBR_LAYOUT_DEF Create the structure and hierarchy forbank reporting layouts. You can defineheaders, details and trails records as wellas field positions and length for eachrecord type.

Field Definition Page GPBR_LAYOUT_SEC Modify the information in an existingfield in a layout definition row.

Characters Replacement Page GPBR_LAYOUT_REP Define the characters that need to bereplaced in the bank reporting layout.

Centralization Data BRA Page CENTRALIZATION_BRA Group establishments to obtaincentralized data for supported processes.

Layout Definition PageUse the Layout Definition page (GPBR_LAYOUT) to create new bank reporting layouts for differentEFTs.

Navigation:

154 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 12 Processing Banking

Set Up HCM > Product Related > Global Payroll & Absence Mgmt > Reports > Payment FileLayout BRA > Layout Definition

This example illustrates the fields and controls on the Layout Definition page.

Field or Control Description

Layout ID Displays the unique identifier for the layout.

Description Enter a description for the layout.

Layout Criteria PageUse the Layout Criteria page (GPBR_LAYOUT_DEF) to create the structure and hierarchy for bankreporting layouts.

You can define headers, details and trails records as well as field positions and length for each recordtype.

Navigation:

Set Up HCM > Product Related > Global Payroll & Absence Mgmt > Reports > Payment FileLayout BRA > Layout Criteria

Copyright © 1988, 2022, Oracle and/or its affiliates. 155

Processing Banking Chapter 12

This example illustrates the fields and controls on the Layout Criteria page.

Rows Definition

Field or Control Description

Row Sequence Enter the sequence to process the row during the EFT layoutprocess

Row Length Enter the number of positions, or characters, that the rowcontains, based on you bank layout specifications

Calculated Length Displays the number of positions based on the fields identifiedin the Fields Definition region. This value is automaticallycalculated when you save the layout definition, and when youmake a change in theFields Definition region.

Description Enter a description that identifies this row in the EFT layout.

Times to Reproduce Enter the number of times you need to repeat the current rowin your EFT layout.

156 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 12 Processing Banking

Field or Control Description

Query Name Enter a query that extracts the required information for thecurrent row.

Note: Most bank layouts in Brazil are very similar, so youshould be able to reuse the provided ITAU layout queries.

See PeopleTools: Query

Row Type Specify whether this is a Header, Detail, or Trail row.

Select Header to indicate that the row is a heading row for theEFT.

Select Detail to indicate that the row is part of the body of theEFT.

Select Trail to indicate that the row is used for totals.

Populate Fields Click to populate the fields coming from the query. This optionautomatically fills in the information in the Fields Definitionregion based on the query definition.

Fields Definition

Use the fields in this region to enter the detail for each column on an EFT layout. This grid isautomatically populated with the selected fields in the query, however you can add user fields.

Field or Control Description

Sequence Enter the order to print the field.

Field Name Click a Field Name link to access the Field Definition pageand modify an existing field.

Note: You can also use the Main, Details, and Agent tabsin the Fields Definition region to access the informationprovided on the Field Definition page.

Alignment Select to align field information to the left or right.

Field Definition PageUse the Field Definition page (GPBR_LAYOUT_SEC) to modify the information in an existing field in alayout definition row.

Copyright © 1988, 2022, Oracle and/or its affiliates. 157

Processing Banking Chapter 12

Navigation:

Click a field name link on the Layout Criteria page.

Note: You can also use the Main, Details, and Agent tabs in the Fields Definition region of the LayoutCriteria page to access the information provided on the Field Definition page.

This example illustrates the fields and controls on the Field Definition page.

Field Details

Field or Control Description

Start Position Increments the last defined position by one and displays thatvalue.

158 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 12 Processing Banking

Field or Control Description

Field Length Enter the number of characters for this field based on the EFTlayout definition.

Field Type Select the field type. Valid values are: Character, Date, DateTime, Image, Long Char, Numeric, Signed Number, and Time.

Break Data Select to use this field as a break to generate subtotals.

String Properties

Field or Control Description

Pad Char (pad characters) Enter a value to use when the system fills an remaining blankpositions.

Upper Case Select to convert the string in this field to upper case text.

Trim Spaces Select to remove blank spaces from this field.

Value

Field or Control Description

Source Select the source for your field. Select Agent Value to obtainthe value for this field from the sum of a count of other fields. The system displays the Agent and Agent Count fields. UseAgent Count to count the number of occurrences. Agent Sumsums the value of the field.

Select Conversion to convert one value to another. You mustenter the conversion values.

Select Field Data to indicate that the value for this field isobtained from the query.

Select User Default to provide a default field value.

Characters Replacement PageUse the Characters Replacement page (GPBR_LAYOUT_REP) to define the characters that need to bereplaced in the bank reporting layout.

Copyright © 1988, 2022, Oracle and/or its affiliates. 159

Processing Banking Chapter 12

Navigation:

Set Up HCM > Product Related > Global Payroll & Absence Mgmt > Reports > Payment FileLayout BRA > Characters Replacement

This example illustrates the fields and controls on the Characters Replacement page.

Field or Control Description

From Value and To Value List the values you want to replace in the From Value fieldand the values you want the system to use in theTo Valuefield.

Centralization Data BRA PageUse the Centralization Data BRA page (CENTRALIZATION_BRA) to group establishments to obtaincentralized data for supported processes.

Navigation:

Set Up HCM > Product Related > Workforce Administration > Centralization Data BRA

This example illustrates the fields and controls on the Centralization Data BRA page.

Field or Control Description

Process Type Displays the type of process that you selected for datacentralization. Options include CAGED Process, EFT BankLayout, MANAD Process, PIS Process and SEFIP Process.

160 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 12 Processing Banking

Field or Control Description

Centralizer Enter the name of the establishment that creates centralizeddata for reporting purposes.

(For SEFIP process) The centralizer (establishment) and itsassociated establishments that you select must have CNPJ asthe inscription type.

Centralization Option

Field or Control Description

Use Centralization Select to use centralization and generate one single SEFIPreport for all establishments listed on this page, which have thesame first eight digits of CNPJ as the centralizer.

This option is useful for companies with many establishments, which would benefit from generating one centralized SEFIPreport rather than many individual reports, one for eachestablishment.

Use Grouping Select to use centralization and generate one single SEFIPreport for all establishments listed on this page.

Not Using Select to not use centralization. The process generates a SEFIPreport for each listed establishment.

Centralized Data

Field or Control Description

Establishment ID Enter the IDs of all establishments from which the centralizercollects data.

Defining the Banking Process

To define the banking process, use the Banks (BANK_EC) component.

This topic provides an overview of the banking process and discusses how to define banking in GlobalPayroll for Brazil.

Copyright © 1988, 2022, Oracle and/or its affiliates. 161

Processing Banking Chapter 12

Pages Used to Define Banking in Brazil

Page Name Definition Name Usage

"Branch Table Page" (ApplicationFundamentals)

BANK_BRANCH_EC Define bank branch data.

Run Payment Prep Process BRA Page (run payment preparation process BRApage)

GPBR_RC_PAYMENT Launch the PS Job that populates the GP_PAYMENT and GPBR_PAYMENTrecords.

Create EFT Payment File BRA Page GPBR_RC_EFTBANK Launch the process that builds the flatoutput file (EFT) and generate a report.

Understanding the Banking ProcessTo process banking in Global Payroll for Brazil, you complete these steps:

1. Launch the Payment Preparation BRA process (GPBR_PMT), a PS Job, from the Run Payment PrepProcess BRA page.

The job runs the Global Payment Banking process (GP_PMT_PREP) and populates the GPBRPAYMENT output table.

2. Launch the process to build the EFT file and generate the banking report on the Payment FileGeneration page.

An SQR, called GPBRBA01, is run. An EFT file is generated, containing the details of each paymentfrom the payroll run. The EFT file is sent to the bank so that the funds can be transferred to payees'bank accounts. This SQR also generates a report with payment details for validation purposes. Youcan review and store the payment details.

Run Payment Prep Process BRA PageUse the Run Payment Prep Process BRA (run payment preparation process BRA) page(GPBR_RC_PAYMENT) to launch the PS Job that populates the GP_PAYMENT and GPBR_PAYMENTrecords.

Navigation:

Global Payroll & Absence Mgmt > Payment Processing > Prepare Payment Process BRA > RunPayment Prep Process BRA

162 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 12 Processing Banking

This example illustrates the fields and controls on the Run Payment Prep Process BRA page.

Note: The fields on the Run Payment Prep Process BRA page in Global Payroll for Brazil are thesame as on the Run Payment Prep Process page in the core application, except that an additional field(Clear Data) appears on the Run Payment Prep Process BRA page. For more information about the RunPayment Prep Process page, refer to the "Run Payment Prep Process Page" (PeopleSoft Global Payroll)topic.

Field or Control Description

Clear Data Click when you want to recalculate the Brazilian bankingprocess. If you click this button, you can clear the GPBRPAYMENT output table and fill it again if the calculationchanges.

Finalize Select only if you are absolutely sure that this process isgenerating the information for all the eligible payees. Selectingthis check box turns on an indicator field in the CalendarGroup record.

Related Links"Understanding Banking" (PeopleSoft Global Payroll)

Create EFT Payment File BRA PageUse the Create EFT Payment File BRA page (GPBR_RC_EFTBANK) to launch the process that buildsthe flat output file (EFT) and generate a report.

Navigation:

Global Payroll & Absence Mgmt > Payment Processing > Create Payment File BRA > Create EFTPayment File BRA

Copyright © 1988, 2022, Oracle and/or its affiliates. 163

Processing Banking Chapter 12

This example illustrates the fields and controls on the Create EFT Payment File BRA page.

Field or Control Description

Calendar Group ID Select the calendar group ID for which you want to generate apayment file.

Calendar ID Select a calendar ID to print only one specific calendar ID, likea vacations or 13th salary calendar, within a calendar groupID.

Pay Entity Select the pay entity for which you want to generate a paymentfile.

Bank Code Select the bank for which you want to generate an EFT file.

Create EFT File Click to create the EFT file.

Payment Date Enter the date of the payment.

Beneficiary Historic Specify the type of transaction being sent to the bank.

File Name Specify the name of the EFT file.

Note: You must populate the GP PAYMENT table and the GPBR PAYMENT table before you can launchthis SQR, which generates the flat file for banking along with a printed report of payment details.

Related LinksGlobal Payroll for Brazil Reports: A to Z

164 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 13

Processing Alimony

Understanding Alimony Deductions

In Global Payroll for Brazil, you perform these setup tasks to support the calculation of alimonydeductions in payroll: identifying dependents, setting up banking data for payment recipients, linkingof dependents and banking information, and assigning alimony elements and relevant element valuesto employees for payroll calculation. For employees that have the same type of alimony for more thanone recipient , the system generates separate rows of deductions in the calculation results, one for eachrecipient.

Entering Alimony Information

Here is an example of entering alimony information for an employee:

1. Enter personal profile information of the employee’s dependents on the "Dependent Information -Personal Profile Page" (PeopleSoft Human Resources Administer Workforce). In this example, theemployee has two child dependents.

Copyright © 1988, 2022, Oracle and/or its affiliates. 165

Processing Alimony Chapter 13

This example illustrates the fields and controls on the Personal Profile page (1 of 2).

This example illustrates the fields and controls on the Personal Profile page (2 of 2).

Note: Be sure to specify the CPF number for each dependent. It is required for legal reports such asIREN and DIRF reports (collective health plan information).

2. Create one or more deduction recipients as needed. A deduction recipient contains the bank accountinformation for individuals to receive payments, as well as the corresponding deposit schedule.Specify this information on the "Define Deduction Recipients Page" (PeopleSoft Global Payroll) and"Recipient Deposit Schedule Page" (PeopleSoft Global Payroll).

166 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 13 Processing Alimony

This example illustrates the fields and controls on the Define Deduction Recipients page.

This example illustrates the fields and controls on the Recipient Deposit Schedule page.

3. Associate deduction recipients with employee’s dependents on the Recpnt/Benef Relationship BRAPage. A deduction recipient can be linked to one dependent (in a case where the dependent has hisor her own bank information) or more dependents (in a case where dependents are children of anemployee and the deduction recipient contains bank information of the employee’s ex-spouse whotakes care of the children).

This example illustrates the fields and controls on the Recpnt/Benef Relationship BRA page.

Copyright © 1988, 2022, Oracle and/or its affiliates. 167

Processing Alimony Chapter 13

This information is used in the IREN report.

4. Associate alimony deduction elements with deduction recipients on the "Add Deduction RecipientsPage" (PeopleSoft Global Payroll). In this example, use PENS LIQ BAS and PEN LIQ BAS2 (Gross-Net Alimony Base) for employee’s two deduction recipients.

This example illustrates the fields and controls on the Add Deduction Recipients page.

This example illustrates the fields and controls on the Add Deduction Recipients page.

5. Select and assign values in each added alimony element for your dependents on the "ElementAssignment By Payee Page" (PeopleSoft Global Payroll) and "Element Detail Page" (PeopleSoftGlobal Payroll).

In this example, select PENS LIQ BAS and PEN LIQ BAS2.

168 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 13 Processing Alimony

This example illustrates the fields and controls on the Element Assignment By Payee page.

Assign these values on the Element Detail page:

Element Name: PENS LIQ BAS

Recipient Tag: 1 (the deduction recipient for the first dependent)

Calculation rule percent: Numeric

Calculation rule amount: 25

Add element FP VR DEP PENS, and enter 01 as the character value, which is the ID of the firstdependent.

Copyright © 1988, 2022, Oracle and/or its affiliates. 169

Processing Alimony Chapter 13

This example illustrates the fields and controls on the Element Assignment By Payee - Element Detailpage.

Assign these values for the other element on the Element Detail page:

Element Name: PEN LIQ BAS2

Recipient Tag: 2 (the deduction recipient for the second dependent)

Calculation rule percent: Numeric

Calculation rule amount: 30

Add element FP VR DEP PENS , and enter 02 as the character value, which is the ID of the seconddependent.

170 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 13 Processing Alimony

This example illustrates the fields and controls on the Element Assignment By Payee - Element Detailpage.

6. Run the payroll calculation and review the results. Note that separate rows are displayed for thealimony deductions that are calculated, one for each of the employee’s dependents.

Copyright © 1988, 2022, Oracle and/or its affiliates. 171

Processing Alimony Chapter 13

172 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 14

Working With eSocial

Understanding eSocial

eSocial is a nationwide program that is led by the Brazilian government to streamline the transmission ofHR and payroll-related information from companies to the government in a centralized framework.

Currently, companies doing business in Brazil are required to run and submit multiple reports to differentgovernment institutions. These reports capture employment-related data such as employment relationship,hiring, compensation, work hours, absence, terminations, payroll and labor obligations, social securitypayments and other fiscal impacts. Targeted for different agencies for different purposes, these reportscontain duplicate and sometimes dated information.

eSocial is a central system to which all Brazilian businesses are required to report their employment-related and work-related information on a timely manner. It:

• Consolidates companies’ labor, social security, and tax information into one single system.

All employment-related and work-related information is stored in a central location, which lowersmaintenance costs, increase efficiency and minimizes data discrepancy issues.

• Eliminates report errors and increases productivity.

Employers are obligated to provide timely updates to the eSocial system to avoid penalties. Toeliminate potential data entry errors, paper forms are no longer supported. Data transmission is donesolely electronically to the central system, allowing only the most current information to be availableto government agencies that need it.

• Allows the government to conduct audits more easily.

Because all employment-related and work-related data is transmitted online to the eSocial system, itbecomes easier for the government to monitor employers and make sure that they are fulfilling laborand social security obligations, inspect employment records, and conduct audits more frequently.

The eSocial architecture simplifies the processing of employment information for the Braziliangovernment and businesses. By digitizing data transmission and maintaining data in a centralizedsystem, eSocial is expected to replace a number of reports (for example, CAT, CTPS, SEFIP, RAIS,CAGED, MANAD and so on) that employers otherwise need to run and submit to respective governmentauthorities for compliance. Employers report their payroll, labor, social security, and fiscal information toeSocial as relevant events occur. Government entities have access to information that is relevant to theirscope of work and functions, for example:

• Secretaria da Receita Federal do Brasil (RFB) - Brazilian Internal Revenue Service.

Example of information accessible to this entity: Social security contributions and tax withholding.

• Ministério do Trabalho e Emprego (MTE) - Ministry of Labor and Employment.

Copyright © 1988, 2022, Oracle and/or its affiliates. 173

Working With eSocial Chapter 14

Example of type of information accessible to this entity: Labor rights and benefits.

• Ministério da Previdência Social - Ministry of Social Security.

Example of type of information accessible to this entity: Employment bonds and contribution bonds.

• Instituto Nacional do Seguro Social (INSS) - Social Security Administration.

Example of type of information accessible to this entity: Employment bonds and contribution bonds.

• Caixa Econômica Federal (CEF) - Federal Bank – Unemployment Insurance Fund Bureau.

Example of type of information accessible to this entity: Guarantee Fund for Length of Service(FGTS).

Delivered eSocial Enhancements in Global Payroll for BrazilGlobal Payroll for Brazil provides these features and functionality to support eSocial reporting:

• New pages and updates to existing pages in Human Resources and Global Payroll to capture allinformation required by eSocial.

• Identification of transactions in the HCM system that must be reported to eSocial, and the processingof transaction information in preparation for the creation of event-specific files.

See Understanding Events and Identifying Events

• Generation of XML report files for identified events based on government-approved event layouts.

See Creating XML Outputs for Events

• Development of web services to submit reports to eSocial and receive report results from eSocial.

See Submitting XML Outputs and Requesting Results

• Development of a monitoring tool that keeps track of the progress of submitted events, identify errorsthat occur during the process cycle and take appropriate actions.

See Monitoring eSocial Events

Events and File LayoutsEmployers are often required to report to eSocial when certain transactions are saved in eSocial-mappedcomponents in their payroll, HR, or even financial systems. The government has identified a list of eventsand published layout specifications for them. Event layouts are report templates that are used to generateXML reports for events.

Global Payroll for Brazil supports the reporting of events that are specific to payroll and HR.

Events are grouped into these high-level categories:

• Basic table events. They include the initial loading, as well as ongoing updates of tables that identifythe employer, employees, employment relationships and so on.

174 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 14 Working With eSocial

For example, loading or update of employer data, job codes, establishments, work shifts and timelabor, and so on.

• Non-periodic events or labor events.

These are labor-related legal facts between the employer and employees that do not occur on apredefined schedule.

For example, hires, rehires, personal data changes, absence, and so on.

• Periodic events.

These are events that occur on a regular basis.

For example, monthly payroll, 13th salary, social security contribution withholding, and so on.

• Totaling events.

These are PeopleSoft queries that are used to query social security contribution and incometax withholding information of employees and employers that was reported successfully to thegovernment through periodic events.

• Termination events.

They are a subset of non-periodic events, and are used to report information related to terminations ofemployees and non-employees.

Please refer to the Understanding Events topic for more information about events that are delivered foreSocial reporting.

eSocial ImplementationOracle delivers a quick start guide (in Portuguese) that walks customers through the process of setting upand implementing eSocial. This document is available for download on My Oracle Support (document ID1526487.1), and will be updated as deemed necessary.

Video: Image Highlights, PeopleSoft HCM Update Image 18, eSocial Basic Setup and Batch Processes(1)

Video: Image Highlights, PeopleSoft HCM Update Image 19, eSocial Events, Web Services, andMonitoring Tool (2)

Video: Image Highlights, PeopleSoft HCM Update Image 23: eSocial Delivery of Periodic Events (3)

Video: Image Highlights, PeopleSoft HCM Update Image 24: eSocial Events Monitor Enhancements (4)

Video: Image Highlights, PeopleSoft HCM Update Image 29: eSocial Health and Safety Events (5)

Video: Image Highlights, PeopleSoft HCM Update Image 37: eSocial S-1070 Event for Global PayrollBrazil (6)

Video: Image Highlights, PeopleSoft HCM Update Image 38: Simplified eSocial (S1.0) (7)

Copyright © 1988, 2022, Oracle and/or its affiliates. 175

Working With eSocial Chapter 14

Setup Preparation

Customers perform these tasks to prepare for the implementation of eSocial:

1. eSocial main setup.

This includes setup steps for activating the eSocial functionality in Global Payroll for Brazil, enablingthe events that customers wish to report to the Brazilian government through eSocial, as well asidentifying companies and establishments to be included in the program.

See Setting Up eSocial

2. Legal code mappings.

This includes the mappings of various setup codes (for example, country, address, dependent type,ethnic group, and so on) between and the PeopleSoft and eSocial systems.

See Setting Up eSocial

3. Initial data loading.

This includes the transmission of data about the employer, basic tables, as well active and inactiveemployees and non-employees. This data must be loaded in the eSocial environment before any laboror periodic events can be submitted.

Initial data is loaded by running a batch process on the eSocial Initial Data Loading page.

See Identifying Events

In Production

Upon the implementation of the eSocial functionality, PeopleSoft is responsible for reporting to theBrazilian government any eSocial event that occurs for each company included in the program. Theseevents are mostly labor-related (for example, hiring, rehiring, termination, absence, contract change, andpersonal data change) and payroll-related (for example, compensation and miscellaneous payment), witha few that are defined for supporting the data transmission process and running queries. The schedules forsubmitting data are different based on the nature of the events, as regulated by the government.

At a high level, the process to support ongoing eSocial reporting includes these tasks:

1. Record labor and other non-periodic events as they occur. Run batch process to collect and processevent information, before it is populated to staging tables.

Run batch processes regularly to record and process periodic events.

See Identifying Events

2. Run batch process to generate XML outputs based on staging tables.

See Identifying Events

3. Send XML outputs to the government of Brazil through third-party programs.

See Submitting XML Outputs and Requesting Results

4. Monitor eSocial events.

176 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 14 Working With eSocial

See Monitoring eSocial Events

Setting Up eSocial

This topic discusses how to set up eSocial in Global Payroll for Brazil.

Pages Used to Set Up eSocial

Page Name Definition Name Usage

eSocial Parameters BRA Page GPBR_ESOCIAL_PARAM Activate the eSocial functionality onyour PeopleSoft system.

eSocial Register Number BRA Page ES_RC_REGN_BRA Populate eSocial registration numbers foremployees.

ASO Exam Procedure Page GPBR_ESOC_ASO Update employee record numbers onASO exam results.

Import Historical Data BRA Page GPBR_RC_EVT_HIST Load data that was accepted by theGovernment into the PeopleSoft system.

XML Batch Group Definition Page GPBR_XMLBATCH_GRP Define XML batch groups andsubgroups.

Events Setup Page GPBR_EVENT_SETUP Specify basic setup information forevent layouts to be included in eSocialreporting.

Events Activation Page GPBR_EVNT_ACTIVTN Activate events to be processed byPeopleSoft HCM Global Payroll forBrazil.

Basic Table Events Page GPBR_EVENT_SEQNO_B Specify the order in which basic tableevents are transmitted to eSocial.

Non Periodic Events Page GPBR_EVENT_SEQNO_N Specify the order in which non-periodicevents are transmitted to eSocial.

Periodic Events Page GPBR_EVENT_SEQNO_P Specify the order in which periodicevents are transmitted to eSocial.

Company Parameters Page GPBR_COMP_PARAM Activate companies for eSocialreporting.

Copyright © 1988, 2022, Oracle and/or its affiliates. 177

Working With eSocial Chapter 14

Page Name Definition Name Usage

SetID Group Page GPBR_SETID_GROUP Associate companies with setIDs forbasic table event processing.

XML Options Page GPBR_COMP_PARAM2 Specify XML file options for companies.

Software Providers Page GPBR_SOFTW_PROV Define software providers and contactinformation.

Address Type Page GPBR_ADDR_TYPE Map PeopleSoft and eSocial addresstypes.

Address Format Page GPBR_ADDR_FMT Map PeopleSoft and eSocial addressterms.

Timecard Type Page GPBR_TIMECARD_CODE Map PeopleSoft and eSocial timecardtypes.

Dependents Page GPBR_DEP_INF_CODE Map PeopleSoft and eSocial dependenttypes.

Ethnic Groups Page GPBR_ETHNIC_GROUP Map PeopleSoft and eSocial ethnicgroup codes.

Education Level Page GPBR_EDUCATIO_CODE Map PeopleSoft and eSocial educationlevels.

Marital Status Page GPBR_MARITAL_CODE Map PeopleSoft and eSocial maritalstatuses.

Visa and Permits Page GPBR_VISA_CODE Map PeopleSoft and eSocial visa orpermit types.

Labor Category Legal Codes Page GPBR_LBR_CAT_CODE Define labor category legal codes.

Labor Regime Page GPBR_LABOR_REGIME Associate employee classifications withlabor-specific codes and information.

Termination Legal Codes Page GPBR_TERM_CODE Define eSocial termination codes.

Hire Action/Reason Page GPBR_HIR_ACT_REA Identify all hiring actions and reasons, and corresponding events to be used toreport to the eSocial system.

178 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 14 Working With eSocial

Page Name Definition Name Usage

Termination Action/Reason Page GPBR_TER_ACT_REA Identify all termination actions andreasons, and corresponding events to beused to report to the eSocial system.

Other Action/Reason Page GPBR_OTH_ACT_REA Identify all actions and reasons related tocontract changes that need to be reportedto the eSocial system.

Absence Legal Codes Page GPBR_ABS_CODE Define eSocial absence codes.

Absence Take and Reason Page GPBR_ABS_TAKE_REA Map PeopleSoft and eSocial absencecodes.

Country and Nationality Cd Bra Page ES_COUNTRY_TBL_BRA Map country codes with RFB and RAISnationality codes.

INSS Tax Incidence Code Page GPBR_SOC_PREV_CD Define INSS tax codes.

Income Tax Incidence Code Page GPBR_INC_TAX_CD Define income tax codes.

Wage Type Code Page GPBR_WAGE_CODE Define wage type codes.

Wage Types Table Page GPBR_WAGE_TYPE Assign wage type as well as otherincidence codes to accumulator elementsfor use in eSocial reporting.

Run Types Page GPBR_RUN_TYPE Specify run types, eSocial events, and other needed information forcorresponding payroll elements.

Health Data Page GPBR_HLTH_WAGE Specify health plan setup for payrollevent reporting.

Exemption Proceedings Page GPBR_PROCEED_DT Define the wage type proceeding detailsfor companies.

eSocial Diagnostic Procedures Page GPBR_ESOC_CODE Define diagnostic procedure codes.

Hazard Agent Code BRA Page HAZ_AGENT_TBL_BRA Define hazard agent codes.

Hazard Factor Table Page HAZARD_FACTOR_BRA Define codes.

Special Activities Page ACTIVITIES_BRA Define special activity codes.

Copyright © 1988, 2022, Oracle and/or its affiliates. 179

Working With eSocial Chapter 14

Understanding SetID and Company Mapping

Important! The setID and company mapping logic is no longer used as a result of the inactivation ofS-1030 and S-1050 reports in the S1.0 version.

Businesses in Brazil are required to report data to the eSocial system by company. This mechanism worksfine with periodic and non-periodic events, but not with events for basic tables (for example, Job CodeTable and Work Shift Code), which are keyed by setID in PeopleSoft HCM.

To bridge the gap between setID-based data and the company-based reporting requirement, and ensurethat basic table data can be transmitted to eSocial properly, the system provides the SetID Group Pageto map between setIDs and companies. When a basic table change occurs, the system uses this mappinginformation to identify the companies that this change impacts, and generates appropriate events forimpacted companies for eSocial processing.

SetID and Company Mapping Example

This example describes how the PeopleSoft system determines what (and for which companies) data getssubmitted to the eSocial environment, when a job code is updated in PeopleSoft.

In this imaginary PeopleSoft HCM system, there are three different setIDs, four business units, and threecompanies. This diagram illustrates how they are linked together to support business processes of thecompanies:

Job codes are keyed by setID in the Job Code Table (JOB_CODE_TBL); they are available in all threesetIDs:

180 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 14 Working With eSocial

Suppose that job code 1000 is used in all three setIDs to represent different job positions, as illustrated inthis table:

If a user updates job code 1000, the PeopleSoft system needs to identify to which companies this job codechange applies based on the setID, and send the correct job code information to eSocial accordingly.

As an implementer, you establish the association between companies and setIDs on the SetID GroupPage. When a setID-keyed basic table data is updated, the system can find out from the mapping on thispage a list of companies to which the update pertains.

Back to the job code example, suppose that the mapping is already defined on the SetID Group pagebased on the setID and company mapping diagram, and a user has updated job code 1000 for the SHAREsetID. The system accesses the setID and company mapping page and concludes that this job code updateneeds to submitted for two companies: KRI and KRC. When the staging table loading application engineprocess (GPBR_ES_XML) runs, this event is split and loaded to staging tables for both KRI and KRC.

In the information that is sent to eSocial, the corresponding setID is added to the job code as prefix toavoid duplicate keys, as illustrated in this table:

Company eSocial Job Code eSocial Description

KRI SHARE.1000 Manager I

KRC SHARE.1000 Manager I

As mentioned earlier in this example, the KRC company is associated with two setIDs: SHARE andKRSI2, each of which is linked to job code 1000 but with different job descriptions. If a change is madeto the description of job code 1000 for both setIDs, the corresponding setID is added to the job code asprefix in each data row that is sent to eSocial to avoid duplicate keys, as illustrated in this table:

Company eSocial Job Code eSocial Job Description

KRC SHARE.1000 Manager II

KRC KRSI2.1000 President II

Related LinksSetID Group Page

Copyright © 1988, 2022, Oracle and/or its affiliates. 181

Working With eSocial Chapter 14

Understanding Action and Reason SetupThe Job Data component is where hiring, terminations, and other contract-related updates take place.When the component is saved, a trigger is run to identify information that may have to be reported toeSocial. PeopleSoft provides the eSocial Actions and Reasons component for customers to identify theactions that need to be submitted to eSocial, according to their business processes.

Use this component to provide the specifics for each action, so that the trigger can determine whether ajob data change has to be sent to eSocial, or which event to use based on the individual (employee or non-employee) on whom the action performed. For example, when a hiring action is saved, the S-2200 eventthat is invoked for hiring an employee is different from the one (S-2300) for hiring a non-employee.

Any actions pertaining to hiring, terminations, and contract-related updates must be set up properly in theeSocial Actions and Reasons component to be included for eSocial processing.

Related LinksHire Action/Reason PageTermination Action/Reason PageOther Action/Reason Page

Setting Up eSocialSetting up eSocial includes steps to activate the eSocial functionality, activate events for eSocialreporting, identify companies to be included in the program, and map various PeopleSoft and eSociallegal codes. These steps can be roughly categorized into these groups:

• Installation setup

• One time setup.

• Main setup

• Legal code setup

Installation Setup

Activate the eSocial functionality on the eSocial Parameters BRA Page.

Activate the Administrative and Legal Proceedings functionality for S-1070 event reporting on the "Adm/Legal Proceedings Parameters BRA Page" (PeopleSoft Human Resources Administer Workforce). This isrequired if you wish to process S-1070 reports in Global Payroll for Brazil.

One Time Setup

• Populate eSocial registration numbers for employees on the eSocial Register Number BRA Page

• Update employee record numbers on ASO exam results on the ASO Exam Procedure Page. This isrequired for S-2220 event reporting.

• Populate legal proceeding information that has already been submitted to the Government on theImport Historical Data BRA Page, before the activation of the S-1070 event in the PeopleSoft system.This is required for S-1070 event reporting.

182 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 14 Working With eSocial

Main Setup

1. Define XML batch groups and subgroups on the XML Batch Group Definition Page.

2. Define eSocial events on the Events Setup Page.

3. Activate events to be processed by PeopleSoft HCM Global Payroll for Brazil on the EventsActivation Page.

4. Categorize eSocial events and sequence them on the Basic Table Events Page, Non Periodic EventsPage, and Periodic Events Page.

5. Activate companies for eSocial reporting and override system-level defaults (if applicable) forcompanies on the Company Parameters Page.

6. Associate companies with setIDs for basic table event processing on the SetID Group Page.

7. Set up company’s XML options on the XML Options Page.

8. Define software providers on the Software Providers Page.

Legal Code Setup

1. Map PeopleSoft and eSocial address terms on the Address Type Page and Address Format Page.

2. Map PeopleSoft and eSocial timecard types on the Timecard Type Page.

3. Map PeopleSoft and eSocial dependent types on the Dependents Page.

4. Map PeopleSoft and eSocial ethnic group codes on the Ethnic Groups Page.

5. Map PeopleSoft and eSocial education levels on the Education Level Page.

6. Map PeopleSoft and eSocial marital statuses on the Marital Status Page.

7. Map PeopleSoft and eSocial visa or permit types on the Visa and Permits Page.

8. Define labor category legal codes on the Labor Category Legal Codes Page.

9. Associate employee classifications with labor-specific codes and information on the Labor RegimePage.

10. Define termination legal codes on the Termination Legal Codes Page.

11. Identify all hiring, termination, and other contract-related actions and reasons, and correspondingevents to be used to report to the eSocial system on the Hire Action/Reason Page, Termination Action/Reason Page, and Other Action/Reason Page.

12. Define absence legal codes on the Absence Legal Codes Page.

13. Map PeopleSoft and eSocial absence codes on the Absence Take and Reason Page.

14. Map country codes with RFB and RAIS nationality codes on the Country and Nationality Cd BraPage.

Copyright © 1988, 2022, Oracle and/or its affiliates. 183

Working With eSocial Chapter 14

15. Set up wage types tables on the INSS Tax Incidence Code Page, Income Tax Incidence Code Page,Wage Type Code Page, Wage Types Table Page, Run Types Page, Health Data Page, and ExemptionProceedings Page.

eSocial Parameters BRA PageUse the eSocial Parameters BRA page (GPBR_ESOCIAL_PARAM) to activate the eSocial functionalityon your PeopleSoft system.

Navigation:

Set Up HCM > Install >Country Specific >eSocial Parameters BRA

This example illustrates the fields and controls on the eSocial Parameters BRA page.

Field or Control Description

Enabled Select to activate the eSocial functionality in your PeopleSoftinstallation.

If selected, eSocial events can be launched in several mappedHCM components. eSocial events will not be launched if thisfield is not selected.

Environment Type Select the type (test or production) of environment on whicheSocial is running. Values are:

Production

Restrict Production

Important! It is strongly recommended that you use theProduction option on production environments.

The selected environment type is used the value of the<tpAmb> tag, which is required for XML files that are createdfor eSocial events.

eSocial Register Number BRA PageUse the eSocial Register Number BRA page (ES_RC_REGN_BRA) to populate eSocial registrationnumbers for employees.

Navigation:

184 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 14 Working With eSocial

Set Up HCM >Product Related >Global Payroll & Absence Mgmt >eSocial BRA >One TimeSetup >eSocial Register Number

This example illustrates the fields and controls on the eSocial Register Number BRA page.

Run the eSocial Register Number BRA application engine (ES_RNUM_BRA) to populate eSocialregistration numbers for employees on the "(BRA) Additional Information BRA Page" (PeopleSoftHuman Resources Administer Workforce) before the initial data loading processes.

Field or Control Description

Company Select a company to assign eSocial register numbers to theiremployees.

Note: Only companies with DRT Number as the selectedeSocial number method on the "(BRA) Company Details BRAPage" (Application Fundamentals) are available for selection.

eSocial Number Method Displays the company’s selected eSocial number method, which is DRT Number.

Start Numbering From This field is left blank.

ASO Exam Procedure PageUse the ASO Exam Procedure page (GPBR_ESOC_ASO) to update employee record numbers on ASOexam results.

Navigation:

Set Up HCM >Product Related >Global Payroll & Absence Mgmt >eSocial BRA >One TimeSetup >ASO Exam Procedure

Copyright © 1988, 2022, Oracle and/or its affiliates. 185

Working With eSocial Chapter 14

This example illustrates the fields and controls on the ASO Exam Procedure page.

Companies use the ASO exam results BRA component to record employees’ medical exam results andtrack their occupational health. Prior to implementing the S-2220 event in eSocial to report employees’occupational health information to the Government, you need to run a one-time process to updateemployee record numbers in exam results as needed, so that the exam information can be processedproperly.

The Employee Record process checks to make sure that, for each company that is included on the runcontrol page, each ASO exam result created for the company's employee is associated with the correctemployee record number, and update as necessary. If the employee of an ASO exam result has morethan one employee record, a duplicate ASO exam result will be created for each of his or her additionalemployee record number. Suppose that the employee has two employee records and is associated withthree exam results. When the process runs, it generates a duplicate for each of the three exam results forthe additional employee record, and populates the corresponding employee record number on all six examresults. It is the company’s responsibility to review and clean up these exam result records before the go-live date of the health and safety events.

Note: Run the Employee Record process only once for companies that implement the S-2220 event.Nothing happens when you rerun the process for the same company.

Field or Control Description

All Companies or Company Click to include all companies that are enabled for eSocialreporting on the Company Parameters Page in the employeerecord process.

Alternatively, you can add one or more companies manuallyby inserting rows to this page. Only eSocial-enabledcompanies are available for selection.

Active Select to include active employees in the process.

186 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 14 Working With eSocial

Field or Control Description

Inactive and From Select to include inactive employees (whose HR status is set toInactive, for example, terminated employees) in the process.

When selected, specify the date from when employees, whobecame Inactive, will be included in the process.

Related Links"ASO Exam Results BRA Page" (PeopleSoft Human Resources Monitor Health and Safety)"Biological Monitor Result BRA Page" (PeopleSoft Human Resources Monitor Health and Safety)

Import Historical Data BRA PageUse the Import Historical Data BRA page (GPBR_RC_EVT_HIST) to load data that was accepted by theGovernment into the PeopleSoft system.

Navigation:

Set Up HCM >Product Related >Global Payroll & Absence Mgmt >eSocial BRA >ImportHistorical Data BRA >Import Historical Data BRA

This example illustrates the fields and controls on the Import Historical Data BRA page.

Running the Load Historical Data Process

Global Payroll for Brazil delivers support for the S-1070 event (Administrative and Legal Proceedings)after the initial eSocial implementation in PeopleSoft. For customers who wish to switch the reporting ofS-1070 events from their current systems over to Global Payroll for Brazil, they need to first import theproceeding information (that is, the historical data that was already sent and accepted by the Governmentin the legacy system) to the PeopleSoft system before activating the S-1070 event.

Run the Load eSocial Event Historical (GPBR_EVT_HST) process to load the historical data ofcompanies from text files into the PeopleSoft system. This process inserts rows of Government-accepted

Copyright © 1988, 2022, Oracle and/or its affiliates. 187

Working With eSocial Chapter 14

proceeding information to driver and cross-reference tables. After the data import is completed, activatethe S-1070 event to begin reporting of administrative and legal proceeding information using thePeopleSoft system.

Load eSocial Event Historical is a two-part process: Process Data (prepare and load data into the stagingtable) and Finalize (load final data into the driver and cross-reference tables). Here are the high-levelsteps for importing historical proceeding data for a company:

1. Select the Process Data option and Add action on the Import Historical Data BRA page to insert datarows from the specified text file to the staging table for the selected company and the S-1070 event.Run the data import process.

2. Review the process result.

Click the View Log/Trace link on the Process Detail page for the process instance to locate thelog file. The log shows the total number of processed rows, the numbers of valid and invalid rowsidentified, and error details pertaining to invalid rows. Correct the issues reported and run the processagain. You can select the Process option and Override action to replace rows of a specific batch codein the staging table. If data rows were added by mistake, use the Delete action to remove them.

3. Repeat steps 1 and 2 until all historical data rows are added to the staging table successfully (all batchcodes are valid).

4. Select the Finalize option for the company and the S-1070 event. Run the process to insert all rows ofvalid batch codes to the driver and cross-reference tables.

5. After the Finalize option is run successfully, the run control page becomes read-only and the dataimport process is considered done for the company. The system prevents you from running theprocess again for the same company and event using a new run control ID.

Generated S-1070 events are available for review on the eSocial Events Monitor Page.

Refer to the S-1070 - Administrative and Legal Proceedings topic for more information about enablingthe S-1070 event reporting in PeopleSoft.

Example of Text File Layout for S-1070 Data Import

The GPBR_EVT_HST process loads historical data from a text file to the PeopleSoft system. Enter a rowin the text file for each proceeding that the Government already accepted and provided a receipt number.This table lists the required values (and their lengths) that the process expects in a data row:

Required Field Value Value Length

Proceeding Type 1

(For example, 1 for Administrative, 2 for Judicial, 3 for Benefit Number - INSS, and 4 for FAP – Process before 2019

Proceeding Number Up to 21

188 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 14 Working With eSocial

Required Field Value Value Length

Action 3

(For example, ADD, UPD, or DEL)

Status Enter GSUC as the value

Receipt Number Up to 40

Date 8

(Format: DDMMYYYY)

Here is the format of a historical data row:

X,NNNNNNNNNNNNNNNNNNNNN,ADD,GSUC,NNNNNNNNNNNN,DDMMYYYY

This example demonstrates the format of the text file that is expected from the Import Historical Dataprocess.

Considerations for the historical data text file:

• Each row of data (for example, proceeding type, proceeding number, and date) you entered in the textfile must match its record on the "Administrative/Legal Proceedings BRA Page" (PeopleSoft HumanResources Administer Workforce) and is the same data that was accepted by the Government.

• Enter rows preferably in chronological order.

• The date should be equal to or later than the eSocial on PeopleSoft date that is specified for theassociated company.

• Do not enter more than one row for the same proceeding number with the ADD action in a given yearand month period.

• For each row with the DEL action, another row for the same proceeding number and period witheither the ADD or UPD action must also exist in the text file.

• Do not enter duplicate rows; they invalidate the data import process.

Copyright © 1988, 2022, Oracle and/or its affiliates. 189

Working With eSocial Chapter 14

• Do not enter rows for the same proceeding number and period in multiple text files.

Parameters

Field or Control Description

Run Click to initiate the GPBR_EVT_HST process to prepare orfinalize the loading of Government-accepted proceeding datainto the PeopleSoft system.

Processing Option Select what you like to do with your data in batch files.

Values are:

Finalize: Select to load data of valid batch codes from thestaging table into driver and cross-reference tables. Thesystem checks to make sure that all batch codes are in factvalid before finalizing the process. If invalid batch codes areidentified for the selected company and event, the data importprocess cannot run until the batch files are fixed and validated.

Note: After the Finalize option has completed successfully, thedata import process cannot be run again for the same companyand event.

Process Data: Select to process data of the specified batchcode with the selected action type.

Action Type Select the process action. This field appears if the selectedprocessing option is Process Data.

Values are:

Add: Select to add rows from the text file to the staging table. When selected, enter a batch code to be used to identify thegroup of rows to be added.

Delete: Select to remove previously uploaded rows from thestaging table. When selected, specify a batch code in the BatchCode field to identify the group of rows to be removed.

Override: Select to replace previously uploaded rows in thestaging table with rows from the text file. When selected, specify a batch code in the Batch Code field to identify therows to be replaced with the rows in the uploaded text file. Usethis option if you fixed issues reported in the previous run andwant to import updated data.

190 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 14 Working With eSocial

Field or Control Description

Company Select the company for which historical data will be loadedinto the PeopleSoft system.

After all batch codes of a company and event code have beenfinalized successfully, you can no longer select the samecompany and event code combination in a new run control.

Event Code Select the S-1070 event, which is currently the only eventenabled for the data import process.

Only events that have the Import Historical Data optionselected on the Events Setup Page are available for selection.

After all batch codes of a company and event code have beenfinalized successfully, you can no longer select the samecompany and event code combination in a new run control.

Load Status Displays the data loading status of the specified batch code.The field appears when the specified action type is Override orDelete.

Batch Code This field appears if the selected processing option is ProcessData.

(For the Add action) Enter a code (maximum of 15 characters)that will be used to identify the batch of historical data to beadded to the PeopleSoft system.

(For the Override or Delete action) Specify the code toidentify the batch of historical data to be overridden orremoved.

Deleted batch codes can be reused.

Select File and File Name Click the Select File button to select and upload a text file thatincludes rows of historical data to be loaded into the system. The file extension must be .txt.

The name of the uploaded file is displayed in the File Namefield.

Both fields appear if the selected action type is Add orOverride.

Copyright © 1988, 2022, Oracle and/or its affiliates. 191

Working With eSocial Chapter 14

Batch Codes to Finalize

This section appears if the processing option is set to Finalize, and at least one batch file has beenprocessed. It lists the batch codes that are associated with the specified company and event code, and theirdata load information.

Field or Control Description

Batch Code A company can have multiple batch codes if it has a largequantity of historical data and prefers to manage the import inbatches.

Load Status Displays the data load status of the corresponding batch code.

Values are:

Valid: all rows of the batch code were loaded into the stagingtable, and were validated successfully.

Invalid: all rows of the batch code were loaded into the stagingtable, but at least one row failed the validation.

Finalized: all rows of the batch code were loaded into thedriver and cross-reference tables successfully.

Total Rows Valid and Total Rows Invalid Displays the total counts of rows that passed and failed thevalidation.

XML Batch Group Definition PageUse the XML Batch Group Definition page (GPBR_XMLBATCH_GRP) to define XML batch groupsand subgroups.

Navigation:

Set Up HCM >Product Related >Global Payroll & Absence Mgmt >eSocial BRA >MainSetup >XML Batch Group Definition

192 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 14 Working With eSocial

This example illustrates the fields and controls on the XML Batch Group Definition page.

Use this page to define subgroups for XML batch groups that are provided by the PeopleSoft system.Each event is associated with an XML batch group and subgroup for delivery purposes.

Events Setup PageUse the Events Setup page (GPBR_EVENT_SETUP) to specify basic setup information for event layoutsto be included in eSocial reporting.

Navigation:

Set Up HCM >Product Related >Global Payroll & Absence Mgmt >eSocial BRA >MainSetup >Events Setup

This example illustrates the fields and controls on the Events Setup page.

Copyright © 1988, 2022, Oracle and/or its affiliates. 193

Working With eSocial Chapter 14

The Brazilian government has published a set of event layouts for use in eSocial reporting. These eventlayouts are delivered and grouped into four categories on this page. In addition to category grouping andthe override level allowed, some of these layouts are selected to be included in the initial data loadingprocess. The event setup also contains parameters to be used for generating XML outputs in the XMLReport Framework, and packaging them for delivery.

Events Data

Field or Control Description

Event Code Displays the code of the event layout.

Effective Date Displays the effective date of the event.

In the future, if the government makes updates to an event, for example, inactivate an event or change the release version, PeopleSoft delivers the update with a new effective-dated rowfor the corresponding event.

Effective Status Select the effective status for the event layout. MostPeopleSoft-delivered events are set as Active.

Only active events are available for further setup on the EventsActivation Page.

Version Enter the version for the event. This value is used in XML as anamespace.

Category Select the category to which this event layout belongs. Valuesare:

Basic Table

Non Periodic

Periodic

Termination

Totaling

Initial Event Select to classify this event as an initial event and include it inthe initial data loading process.

194 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 14 Working With eSocial

Field or Control Description

Override Level Select the override level supported by this event setup.

Values are Company and Establishment.

Events can be configured further at the company orestablishment level on the Company Parameters Page.

Allowed after period closed Select to allow the transmission of data that is identified bythis event to the government even after the pertinent periodhas been closed (which is indicated by the submission of theS-1299 - Closing Periodic Events event).

Import Historical Data Select to allow driver history to be loaded for thecorresponding event on the Import Historical Data BRA Page,before the activation of the event.

Note: This option is currently applicable to the S-1070 eventonly. Do not select it for other events. This field appears whenthe event status is set to Inactive.

XML Framework Data

Field or Control Description

XML Set Enter the name of the XML set table in the XML ReportFramework for this event layout version.

Template Type Enter the template that is used to fill out the layout in the XMLReport Framework.

Exclusion Template Type Enter the template that is used to generate exclusions for thisevent layout. This field appears if the selected event categoryis Periodic.

XML Batch Options

Use this section to link the event with a batch group and subgroup. When XML outputs are generated,PeopleSoft packages them in batches and deliver them to the third-party system using web services. Abatch can contain up to 50 (predefined by the government) XML outputs of the same group type for anygiven company.

Copyright © 1988, 2022, Oracle and/or its affiliates. 195

Working With eSocial Chapter 14

Field or Control Description

XML Batch Group Select a batch group type for the event. Values are:

Initial and Basic Tables Events

Non-Periodic Events

Periodic Events

XML Batch Subgroup Specify a batch subgroup for the event.

Subgroups for XML batch groups are defined on the XMLBatch Group Definition Page.

Related LinksCompany Parameters Page

Events Activation PageUse the Events Activation page (GPBR_EVNT_ACTIVTN) to activate events to be processed byPeopleSoft HCM Global Payroll for Brazil.

Navigation:

Set Up HCM >Product Related >Global Payroll & Absence Mgmt >eSocial BRA >MainSetup >Events Activation

196 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 14 Working With eSocial

This example illustrates the fields and controls on the Events Activation page.

Customers may choose to process eSocial events using more than one system, for example, sendingemployer data from an ERP Financials system, and Payroll-related information from various Payrollsystems. Use this page to activate events to be submitted to the eSocial environment through PeopleSoftHCM Global Payroll for Brazil.

The system prepopulates on this page all active events that are defined on the Events Setup Page. Youcan update the information as necessary. Events and statuses specified here are system-level defaults forall companies that are enabled for eSocial; you can override them at the company-level for individualcompanies on the Company Parameters Page.

Important! It is the customer’s responsibility to add an effective-dated row for the new version andremove eSocial events that are no longer supported from the Events Activation page.

Field or Control Description

Event Code and Description Enter the code of an event to be activated. Active eventsthat are defined on the Events Setup page are available forselection.

The corresponding event description is displayed after anevent code is selected.

Copyright © 1988, 2022, Oracle and/or its affiliates. 197

Working With eSocial Chapter 14

Field or Control Description

Event Status Select Active to include the event in eSocial reporting usingPeopleSoft.

Select Inactive to exclude it from eSocial reporting usingPeopleSoft.

Basic Table Events PageUse the Basic Table Events page (GPBR_EVENT_SEQNO_B) to specify the order in which basic tableevents are transmitted to eSocial.

Navigation:

Set Up HCM >Product Related >Global Payroll & Absence Mgmt >eSocial BRA >MainSetup >Events Sequence by Category

This example illustrates the fields and controls on the Basic Table Events page.

Note: Events are submitted to the eSocial system by category in this order: Basic Table, Non Periodic,and Periodic. For each category, events are assigned a sequence number to indicate the order in whichthey are sent. If there are two events to be submitted in the same batch, the event with a smaller sequencenumber has to be sent before the event with a larger number.

The system prepopulates on this page all basic table events that are defined on the Events Setup Page. Youcan update the information as necessary.

198 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 14 Working With eSocial

Field or Control Description

Event Code and Description Enter the code of an event to be included in the Basic Tablecategory. Active events that belong to the Basic Table categoryare available for selection.

The corresponding event description is displayed after anevent code is selected.

Sequence Number Enter the sequence number for the event, which is used in thebatch processing logic. The smaller the number, the higherpriority the event has in the event submission sequence withinits category.

Non Periodic Events PageUse the Non Periodic Events page (GPBR_EVENT_SEQNO_N) to specify the order in which non-periodic events are transmitted to eSocial.

Navigation:

Set Up HCM >Product Related >Global Payroll & Absence Mgmt >eSocial BRA >MainSetup >Events Sequence by Category

This example illustrates the fields and controls on the Non Periodic Events page.

Copyright © 1988, 2022, Oracle and/or its affiliates. 199

Working With eSocial Chapter 14

Non Periodic is the second category to be submitted to eSocial.

The system prepopulates on this page all non-periodic events that are defined on the Events Setup Page.You can update the information as necessary.

Field or Control Description

Event Code and Description Enter the code of an event to be included in the Non Periodiccategory. Active events that belong to the Non Periodic orTermination category are available for selection.

The corresponding event description is displayed after anevent code is selected.

Sequence Number Enter the sequence number for the event, which is used in thebatch processing logic. The smaller the number, the higherpriority the event has in the event submission sequence withinits category.

Periodic Events PageUse the Periodic Events page (GPBR_EVENT_SEQNO_P) to specify the order in which periodic eventsare transmitted to eSocial.

Navigation:

Set Up HCM >Product Related >Global Payroll & Absence Mgmt >eSocial BRA >MainSetup >Events Sequence by Category

This example illustrates the fields and controls on the Periodic Events page.

Periodic is the third category to be submitted to eSocial.

The system prepopulates on this page all periodic events that are defined on the Events Setup Page. Youcan update the information as necessary.

200 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 14 Working With eSocial

Field or Control Description

Event Code and Description Enter the code of an event to be included in the Periodiccategory. Active events that belong to the Periodic categoryare available for selection.

The corresponding event description is displayed after anevent code is selected.

Sequence Number Enter the sequence number for the event, which is used in thebatch processing logic. The smaller the number, the higherpriority the event has in the event submission sequence withinits category.

Company Parameters PageUse the Company Parameters page (GPBR_COMP_PARAM) to activate companies for eSocial reporting.

Navigation:

Set Up HCM >Product Related >Global Payroll & Absence Mgmt >eSocial BRA >MainSetup >Company Parameters

This example illustrates the fields and controls on the Company Parameters page (1 of 2).

Copyright © 1988, 2022, Oracle and/or its affiliates. 201

Working With eSocial Chapter 14

This example illustrates the fields and controls on the Company Parameters page (2 of 2).

Use this page to activate all companies that have to report data to the eSocial environment. If a companytakes the default setup that is defined on the Events Activation Page, you only need to set the companystatus to Enabled and specify both eSocial on PeopleSoft and Adhere to eSocial dates.

Note: In addition to the company setup performed in the Company Parameters component, be sure to alsoverify that only one establishment is selected as the headquarters unit for each company that is enabled foreSocial reporting.

See Also "Establishment Address Page" (Application Fundamentals)

Field or Control Description

Company Displays the company to which the eSocial dates and eventrules applies.

202 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 14 Working With eSocial

Field or Control Description

eSocial on PeopleSoft Enter the date the company began to report data to eSocialusing PeopleSoft.

This date cannot be updated after the initial data loadingprocess has run.

The implementation of eSocial is done in phases. The eSocialon PeopleSoft date is also used as the go-live date for basictable events, which is set to January 1, 2018 as delivered.

Note: The eSocial on PeopleSoft date and Adhere to eSocialdate are the same for customers who implement eSocialreporting on their existing PeopleSoft HCM Global Payrollfor Brazil system. For new customers, these dates can bedifferent. The eSocial on PeopleSoft date is the date wheneSocial processing begins and events are being reported. It isan important date as it is used to control the eSocial historicaldata regarding rectification events.

Adhere to eSocial Enter the date the company is required to report data toeSocial (using PeopleSoft or not). This date is either earlierthan or equal to the eSocial on PeopleSoft date.

This date cannot be updated after the initial data loadingprocess has run.

Non Periodic Go Live Date Enter the date that the company begins the creation andsubmission of non-periodic events to the government.

The implementation of eSocial is done in phases. The currentgo-live date for non-periodic events is set to March 1, 2018.

Periodic Go Live Date Enter the date that the company begins the creation andsubmission of periodic events to the government.

The implementation of eSocial is done in phases. The currentgo live date for periodic events is set to May 1, 2018.

Health/Safety Go Live Date Enter the date that the company begins the creation andsubmission of health and safety events to the government. These events are currently not supported in Global Payroll forBrazil; they are scheduled to be released in future images.

The implementation of eSocial is done in phases. Theproposed go-live date for health and safety events is set to July1, 2019.

Copyright © 1988, 2022, Oracle and/or its affiliates. 203

Working With eSocial Chapter 14

Company Event Rules

Field or Control Description

Effective Date and Company Status Enter the effective date of the company status that is selectedon the Company Status field. The default value for theeffective date is today's date. The effective date should beearlier than the eSocial on PeopleSoft date and the Adhere toeSocial date.

Overrides by Company

Use this section to enter, if available, any event exceptions for the company listed. For example, if thecompany decides to not use the PeopleSoft HCM system to submit employer data (which is currently anactive event at the system level), enter the S-1000 Employer Data event here and set its status to Inactive.

If the company takes the system-level defaults that are specified on the Events Activation Page withoutexceptions, do not fill out this section.

Overrides by Establishment

Use this section to enter, if available, any event exceptions for the establishment listed. For example, thecompany may use the PeopleSoft HCM system to submit wage type data for most of its establishments,and a legacy system for a couple other establishments from previous acquisitions. In this case, add arow for each establishment with the exception. Enter the S-1010 Wage Types Table event here and setits status to Inactive. Furthermore, if the company has an establishment that does not use the PeopleSoftHCM system for eSocial reporting, add a row for this establishment and disable it in this section.

If all company establishments take the system-level defaults that are specified on the Events ActivationPage without exceptions, do not fill out this section.

Note that establishment overrides do not apply to all events. For example, they are not applicable toS-1280, S-1298, and S-1299 events, which are company-based.

SetID Group PageUse the SetID Group page (GPBR_SETID_GROUP) to associate companies with setIDs for basic tableevent processing.

Navigation:

Set Up HCM >Product Related >Global Payroll & Absence Mgmt >eSocial BRA >MainSetup >Company Parameters

204 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 14 Working With eSocial

This example illustrates the fields and controls on the SetID Group page.

Note: This page is not used. The setID and company mapping is no longer required as a result of theinactivation of S-1030 and S-1050 reports in the S1.0 version.

Use this page to associate companies with setIDs. The mapping is needed when PeopleSoft submits basictable data to eSocial, some of which is keyed by SetID.

Information entered on the SetID Group page pertains to basic table events only.

Field or Control Description

Record Group ID Enter the record group ID for the basic table data that is keyedby SetID. A record group is a set of control tables and viewsfor a given setup data, for example, job codes and work shiftcodes.

SetID Data

Use this section to specify the setIDs with which the company associates to access the basic table dataspecified in the Record Group ID field.

Related LinksUnderstanding SetID and Company Mapping

XML Options PageUse the XML Options page (GPBR_COMP_PARAM2) to specify XML file options for companies.

Copyright © 1988, 2022, Oracle and/or its affiliates. 205

Working With eSocial Chapter 14

Navigation:

Set Up HCM >Product Related >Global Payroll & Absence Mgmt >eSocial BRA >MainSetup >Company Parameters

This example illustrates the fields and controls on the XML Options page.

File Type Options

Field or Control Description

Output Type Select the output type of XML files (for archiving in adatabase or specific directory).

If String is selected, XML output (in the form of string) isgenerated and inserted into the XMLGF_STRNG_TBL record.

If File is selected, XML output (in the form of file) isgenerated and stored in the specified file output directory.

File Output Specify the directory where generated XML files are stored. This directory needs to have the right permission for filestorage, and is required if the selected output type is File.

This directory path needs to end with either “\” or “/”.

206 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 14 Working With eSocial

Batch Options

Field or Control Description

Max Events per Batch ID (maximum events per batch ID) Enter the maximum number of XML outputs that can beincluded in a batch to be delivered to the eSocial system. Based on the document provided by the government, thisnumber is 50. You can modify this limit to anything under 50if necessary.

Software Providers PageUse the Software Providers page (GPBR_SOFTW_PROV) to define eSocial software providers andcontact information.

Navigation:

Set Up HCM >Product Related >Global Payroll & Absence Mgmt >eSocial BRA >MainSetup >Software Providers

This example illustrates the fields and controls on the Software Providers page.

Use this page to enter the contact information of your eSocial software vendors, in case they need to becontacted, for example, as a result of eSocial event layout changes from the government.

Field or Control Description

Software Provider Displays the 3-digit code for the software provider.

Copyright © 1988, 2022, Oracle and/or its affiliates. 207

Working With eSocial Chapter 14

Field or Control Description

Description Enter the software provider name.

CNPJ Number Enter the CNPJ (national ID) for the software provider.

Contact Name, Telephone, and Email ID Enter the name, phone number and email address of thecontact person for the software provider.

Company Data

Use this section to enter all companies that use products of the software provider.

Address Type PageUse the Address Type page (GPBR_ADDR_TYPE) to map PeopleSoft and eSocial address types.

Navigation:

Set Up HCM >Product Related >Global Payroll & Absence Mgmt >eSocial BRA >Legal CodeSetup >Address Type

208 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 14 Working With eSocial

This example illustrates the fields and controls on the Address Type page.

Address Format PageUse the Address Format page (GPBR_ADDR_FMT) to map PeopleSoft and eSocial address terms.

Navigation:

Set Up HCM >Product Related >Global Payroll & Absence Mgmt >eSocial BRA >Legal CodeSetup >Address Format

Copyright © 1988, 2022, Oracle and/or its affiliates. 209

Working With eSocial Chapter 14

This example illustrates the fields and controls on the Address Format page.

Field or Control Description

Address Edit Page Defaults to EO_ADDR_BRA_SEC page, which is thedelivered secondary page used to enter person’s addressinformation for the country of Brazil.

Field Name Displays a field that is used to store address information.

eSocial Address Tags Select the xml tag name under which the address field valuewill be reported to the eSocial system.

210 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 14 Working With eSocial

Timecard Type PageUse the Timecard Type page (GPBR_TIMECARD_CODE) to map PeopleSoft and eSocial timecardtypes.

Navigation:

Set Up HCM >Product Related >Global Payroll & Absence Mgmt >eSocial BRA >Legal CodeSetup >Timecard Type

This example illustrates the fields and controls on the Timecard Type page.

Use this page to map timecard types that the eSocial system expects with the ones that are maintained inPeopleSoft.

Field or Control Description

Timecard Type Select a timecard type that is used in PeopleSoft.

eSocial Code Select the corresponding eSocial code to map to the selectedPeopleSoft timecard type.

These codes are referenced on the "Additional Info - Brazil Page" (PeopleSoft Human ResourcesAdminister Workforce).

Dependents PageUse the Dependents page (GPBR_DEP_INF_CODE) to map PeopleSoft and eSocial dependent types.

Navigation:

Copyright © 1988, 2022, Oracle and/or its affiliates. 211

Working With eSocial Chapter 14

Set Up HCM >Product Related >Global Payroll & Absence Mgmt >eSocial BRA >Legal CodeSetup >Dependents

This example illustrates the fields and controls on the Dependents page.

Use this page to map dependent relationship codes that the eSocial system expects with the ones that aremaintained in PeopleSoft. eSocial codes are more descriptive than PeopleSoft ones. On this page, specifyapplicable attributes to “modify” PeopleSoft codes if necessary, and pair them with matching eSocialcodes.

Field or Control Description

Relationship Select a dependent relationship value (relationship toemployee) that is used in PeopleSoft.

Student Select to add the student attribute to the dependent relationshipselected in this row.

Older Than and Younger Than Enter, if applicable, the age limit attribute for the selecteddependent relationship selected in this row.

212 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 14 Working With eSocial

Field or Control Description

eSocial Code Select the corresponding eSocial relationship to map tothe selected dependent relationship along with any addedattributes.

Ethnic Groups PageUse the Ethnic Groups page (GPBR_ETHNIC_GROUP) to map PeopleSoft and eSocial ethnic groupcodes.

Navigation:

Set Up HCM >Product Related >Global Payroll & Absence Mgmt >eSocial BRA >Legal CodeSetup >Ethnic Groups

This example illustrates the fields and controls on the Ethnic Groups page.

Field or Control Description

Ethnic Group Specify an ethnic group code that is available under theselected regulatory region in PeopleSoft. The correspondingethnic group description is displayed after a code is selected.

eSocial Code Select the corresponding eSocial code to map to the selectedethnic group.

Copyright © 1988, 2022, Oracle and/or its affiliates. 213

Working With eSocial Chapter 14

Education Level PageUse the Education Level page (GPBR_EDUCATIO_CODE) to map PeopleSoft and eSocial educationlevels.

Navigation:

Set Up HCM >Product Related >Global Payroll & Absence Mgmt >eSocial BRA >Legal CodeSetup >Education Level

This example illustrates the fields and controls on the Education Level page.

Field or Control Description

Education Level Select an education level in PeopleSoft.

eSocial Code Select the corresponding eSocial code to map to the selectededucation level.

GRRF Education Code Select the code that is currently used in legal reports providedby PeopleSoft HCM to map to the selected education level.

214 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 14 Working With eSocial

Marital Status PageUse the Marital Status page (GPBR_MARITAL_CODE) to map PeopleSoft and eSocial marital statuses.

Navigation:

Set Up HCM >Product Related >Global Payroll & Absence Mgmt >eSocial BRA >Legal CodeSetup >Marital Status

This example illustrates the fields and controls on the Marital Status page.

Field or Control Description

Marital Status Select a marital status in PeopleSoft.

eSocial Code Select the corresponding eSocial code to map to the selectedmarital status.

Visa and Permits PageUse the Visa and Permits page (GPBR_VISA_CODE) to map PeopleSoft and eSocial visa or permittypes.

Navigation:

Set Up HCM >Product Related >Global Payroll & Absence Mgmt >eSocial BRA >Legal CodeSetup >Visa/Permits

Copyright © 1988, 2022, Oracle and/or its affiliates. 215

Working With eSocial Chapter 14

This example illustrates the fields and controls on the Visa and Permits page.

Field or Control Description

Visa/Permit Type Specify a visa or permit type that is available under theselected regulatory region in PeopleSoft. The correspondingdescription is displayed after a code is selected.

eSocial Code Select the corresponding eSocial code to map to the selectedvisa or permit type.

Labor Category Legal Codes PageUse the Labor Category Legal Codes page (GPBR_LBR_CAT_CODE) to define labor category legalcodes.

Labor category legal codes need to be associated with employee classifications for eSocial processing.

Navigation:

Set Up HCM >Product Related >Global Payroll & Absence Mgmt >eSocial BRA >Legal CodeSetup >Labor Category Legal Codes

216 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 14 Working With eSocial

This example illustrates the fields and controls on the Labor Category Legal Codes page.

Use the page to define labor category legal codes that are expected by eSocial.

Field or Control Description

Description and Long Description Enter the short and long descriptions for the listed laborcategory legal code.

Labor Regime PageUse the Labor Regime page (GPBR_LABOR_REGIME) to associate employee classifications with labor-specific codes and information.

Navigation:

Set Up HCM >Product Related >Global Payroll & Absence Mgmt >eSocial BRA >Legal CodeSetup >Labor Regime

This example illustrates the fields and controls on the Labor Regime page.

Copyright © 1988, 2022, Oracle and/or its affiliates. 217

Working With eSocial Chapter 14

Use this page to associate labor category codes with employee classifications. This information is used toidentify the appropriate events to be submitted in regards to employer-employee relationships, as well asother specific attributes.

Field or Control Description

Employee Classification Select an employee classification to be included in eSocialprocessing. Employee classes that are created for the BRAsetID on the Employee Class page are available for selection.

See Also "Defining Additional Employment SetupData" (PeopleSoft Human Resources Administer Workforce)

In order for employees to be included in eSocial reporting, their employee classifications must be set up on this page.

eSocial Code Select a labor category legal code to associate with theselected employee classification.

Labor category legal codes are defined on the Labor CategoryLegal Codes Page.

Work Type Select an applicable labor law for the selected employeeclassification. Values are CLT, Not Available, and RJP. Thevalue is used to identify if the employee classification is foremployees (if CLT or RJP is selected) or non-employees (ifNot Applicable is selected).

Social Security Select, if applicable, a social security type for the selectedemployee classification. Values are Not Applicable, RGPS,RPPS, and RPSE.

Nature of Activity Select if the selected employee classification applies toURBAN or RURAL employees, or Not Applicable.

Termination Legal Codes PageUse the Termination Legal Codes page (GPBR_TERM_CODE) to define eSocial termination codes.

Navigation:

Set Up HCM >Product Related >Global Payroll & Absence Mgmt >eSocial BRA >Legal CodeSetup >Termination Legal Codes

218 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 14 Working With eSocial

This example illustrates the fields and controls on the Termination Legal Codes page.

Field or Control Description

eSocial Code Displays the eSocial code of the termination mentioned in thedescriptions.

Define termination codes on this page in accordance with thetermination reasons that are available on Table 19 from theBrazilian Government.

Employee Category Displays whether the termination legal code is defined forEmployee or Non-Employee.

Termination Process Select whether or not payment calculation is required forthe termination legal code. For terminations with paymentcalculation, the termination payment amount is includedin each of their termination events to be submitted to thegovernment.

See Also eSocial Termination Events Page

Hire Action/Reason PageUse the Hire Action/Reason page (GPBR_HIR_ACT_REA) to identify all hiring actions and reasons, andcorresponding events to be used to report to the eSocial system.

Navigation:

Set Up HCM >Product Related >Global Payroll & Absence Mgmt >eSocial BRA >Legal CodeSetup >eSocial Action/Reason

Copyright © 1988, 2022, Oracle and/or its affiliates. 219

Working With eSocial Chapter 14

This example illustrates the fields and controls on the Hire Action/Reason page.

Use this page to specify the list of hiring actions and reasons that need to be submitted for eSocialprocessing, and corresponding events to be used based on employment relationship types, and whether ornot the reported employment is the first job for the hired individual.

Any hiring actions and reasons that are not set up on this page are excluded from eSocial reporting.

Field or Control Description

Action Select a hiring action in PeopleSoft. Typical values are HIR (Hire), XFR (Transfer), and REH (Rehire).

Reason Code Select a reason for the selected action.

If no reason is specified, the setup for this row applies to allreasons for the selected action.

Employee Indicator Select if the setup for this row applies to employees withemployment relationship, as specified on the Labor RegimeBRA page. Clear this option if it applies to non-employees.

eSocial Code Select the corresponding eSocial code to map to the selectedaction and reason.

First Job Select Y if the setup for this row applies to the firstemployment of hired individuals. If not, select N.

Event Code and Description Select an event to be used to submit hiring transactions of thecorresponding setup to the eSocial system.

Termination Action/Reason PageUse the Termination Action/Reason page (GPBR_TER_ACT_REA) to identify all termination actionsand reasons, and corresponding events to be used to report to the eSocial system.

Navigation:

220 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 14 Working With eSocial

Set Up HCM >Product Related >Global Payroll & Absence Mgmt >eSocial BRA >Legal CodeSetup >eSocial Action/Reason

This example illustrates the fields and controls on the Termination Action/Reason page.

According to the government’s requirements, terminations have to be reported by the seventh day of themonth following the termination date, by the termination payment date, or before the triggering of payrollevents, depending on information such as the nature of employment (employees and non-employees),termination reason and employment relationship. Use this page to specify all termination actions andreasons that need to be submitted to the eSocial system for employees and non-employees, and thecorresponding events to be invoked to handle those terminations. Any actions and reasons that are not setup on this page are excluded from eSocial reporting.

Field or Control Description

Action Select a termination action in PeopleSoft. Typical values areTER (Termination), and XFR (Transfer).

Reason Code Select a reason for the selected action.

If no reason is specified, the setup for this row applies to allreasons for the selected action.

Employee Indicator Select if the setup for this row applies to employees withemployment relationship. Clear this option if it applies to non-employees (for example, trainees or apprentices).

eSocial Code Select, if applicable, the corresponding eSocial terminationcode to map to the selected action and reason. This code isused by the system to identify if the event should be generatedonline (by saving an HCM component), or through a batchprocess when the termination amount paid to the employee is arequired information for the event.

See Also Termination Legal Codes Page.

Copyright © 1988, 2022, Oracle and/or its affiliates. 221

Working With eSocial Chapter 14

Field or Control Description

Event Code and Description Select an event to be used to submit termination transactionsof the corresponding setup to the eSocial system.

Other Action/Reason PageUse the Other Action/Reason page (GPBR_OTH_ACT_REA) to identify all actions and reasons relatedto contract changes that need to be reported to the eSocial system.

Navigation:

Set Up HCM >Product Related >Global Payroll & Absence Mgmt >eSocial BRA >Legal CodeSetup >eSocial Action/Reason

This example illustrates the fields and controls on the Other Action/Reason page.

Some contract changes, such as salary increase, promotions, transfers between establishments, workshifts, and so on must to be reported to the eSocial system before the triggering of payroll events or beforeabsence and termination events, depending on the nature of employment (employees and non-employees).Use this page to specify all contract-related actions and reasons that need to be submitted to the eSocialsystem for employees and non-employees, and the corresponding events to be invoked to handle thosetransactions. Any actions and reasons that are not set up on this page are excluded from eSocial reporting.

Field or Control Description

Action Select an action in PeopleSoft. Typical values are DTA (DataChange), PAY (Pay Rate Change) and XFR (Transfer).

222 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 14 Working With eSocial

Field or Control Description

Reason Code Select a reason for the selected action.

If no reason is specified, the setup for this row applies to allreasons for the selected action.

Employee Indicator Select this option if the setup for this row applies to employeeswith employment relationship. Clear this option if it applies tonon-employees.

Collective Agreement Indicator Select this option to use the setup for this row to generateevents to inform the Government of retroactive supplementarysalary amounts, which result from salary increases caused byone of these reasons: collective agreement, collective dispute, collective convention or law enforcement.

This option becomes editable on a row when an action, areason code, and the Employee Indicator field are selected. Note that this option can only be selected for one row on thispage.

Event Code and Event Description Select an event to be used to submit transactions of thecorresponding setup to the eSocial system.

Absence Legal Codes PageUse the Absence Legal Codes page (GPBR_ABS_CODE) to define eSocial absence codes.

Navigation:

Set Up HCM >Product Related >Global Payroll & Absence Mgmt >eSocial BRA >Legal CodeSetup >Absence Legal Codes

This example illustrates the fields and controls on the Absence Legal Codes page.

These codes are referenced on the Absence Take and Reason Page.

Copyright © 1988, 2022, Oracle and/or its affiliates. 223

Working With eSocial Chapter 14

Absence Take and Reason PageUse the Absence Take and Reason page (GPBR_ABS_TAKE_REA) to map PeopleSoft and eSocialabsence codes and specify reporting requirements for temporary absence types.

Navigation:

Set Up HCM >Product Related >Global Payroll & Absence Mgmt >eSocial BRA >Legal CodeSetup >Absence Take/Reason

This example illustrates the fields and controls on the Absence Take and Reason page.

Note: Absence codes can change in different eSocial versions. It is the customer’s responsibility to updatethe mapping on the Absence Take and Reason page as they see fit.

The Brazilian government requires that several types of absences be reported when they occur. Whenthese absences are entered or updated using the Absence Event BRA component or the Vacation LeaveBRA component, they are expected to be submitted to eSocial before the triggering of payroll eventsor termination events. They include, but not limited to, maternity leave, accident at work, illness leave,vacations, and so on.

Use this page to specify all absence types that need to be included for eSocial processing and respectivereporting requirements. Do not enter absence types that are not required for eSocial reporting, forexample, unjustified absence from work, or sick leave for less than three days.

Field or Control Description

Element Name Specify an absence take in PeopleSoft.

Absence Reason Specify the reason for the selected absence take. Absencereasons are associated with absence takes through absence taketypes on the Absence Take Types page (GP_ABS_TYPE).

If no reason is specified, the setup for this row applies to allreasons for the selected absence take.

224 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 14 Working With eSocial

Field or Control Description

Employee Select if the selected absence take and reason applies toemployees. Clear this option if it applies to non-employees.

eSocial Code Select the corresponding eSocial code to map to the selectedabsence take and reason.

These codes are defined on the Absence Legal Codes Page.

Days Before Enter the number of days, before the beginning of absence, that the selected absence event (for example, S-2230) needs tobe submitted to eSocial (for an early submission).

Event Code Select an event (for example, S-2230) to be used to submittransactions of the corresponding absence setup to the eSocialsystem by the closing of the period (the 7th day of the nextmonth) in normal circumstances.

Reported Duration Enter, for the selected absence take and reason, the minimumnumber of days for absences to be included for eSocialreporting by the closing of the period.

In other words, if an employee reports absence using theselected take and reason, and the number of absence days islower than the reported duration, the absence is not reported toeSocial.

Accrued Absence Days Enter, for the selected absence take and reason, the numberof accrued absence days to be reported to eSocial as soon asthis number is met, instead of waiting until the closing of theperiod.

Country and Nationality Cd Bra PageUse the Country and Nationality Cd Bra page (ES_COUNTRY_TBL_BRA) to map country codes withRFB and RAIS nationality codes.

Navigation:

• Set Up HCM >Product Related >Workforce Monitoring >Regulatory Requirements >Countryand Nationality Cd BRA

• Set Up HCM >Product Related >Global Payroll & Absence Mgmt >eSocial BRA >Legal CodeSetup >Country and Nationality Cd

Copyright © 1988, 2022, Oracle and/or its affiliates. 225

Working With eSocial Chapter 14

This example illustrates the fields and controls on the Country and Nationality Cd BRA page.

Use this page to map codes from the Country table to RFB and RAIS nationality codes. When the project(which includes the eSocial functionality) is applied, a batch process is executed automatically to convertRAIS nationality codes that were referenced in the Brazil (History) section of the "Add a Person orModify a Person - Regional Page" (PeopleSoft Human Resources Administer Workforce) to associatedcountry codes.

Field or Control Description

Country and Description Select a country code. Country codes are stored in theCOUNTRY_TBL table in PeopleSoft. The correspondingcountry description is displayed after a country code isselected.

RFB Country Code Enter a 3-digit numeric Secretaria da Receita Federal do Brasil(Department of Federal Revenue of Brazil) code to map to theselected country code.

RAIS Nationality Select a nationality code that is used in RAIS reports to map tothe selected country code.

INSS Tax Incidence Code PageUse the INSS Tax Incidence Code page (GPBR_SOC_PREV_CD) to define INSS tax codes.

Navigation:

Set Up HCM >Product Related >Global Payroll & Absence Mgmt >eSocial BRA >Legal CodeSetup >INSS Tax Incidence Code

226 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 14 Working With eSocial

This example illustrates the fields and controls on the INSS Tax Incidence Code page.

Global Payroll for Brazil delivers a list of social security incidence codes for use in eSocial reporting.

Income Tax Incidence Code PageUse the Income Tax Incidence Code page (GPBR_INC_TAX_CD) to define income tax codes.

Navigation:

Set Up HCM >Product Related >Global Payroll & Absence Mgmt >eSocial BRA >Legal CodeSetup >Income Tax Incidence Code

This example illustrates the fields and controls on the Income Tax Incidence Code page.

Global Payroll for Brazil delivers a list of income tax incidence codes for use in eSocial reporting.

An income tax code must be numeric only, 2 to 4 digits in length. If you add a code manually, the systemignores the zeros entered before the first positive integer, for example, 0320 will be treated as 320.

Wage Type Code PageUse the Wage Type Code page (GPBR_WAGE_CODE) to define wage type codes.

Navigation:

Set Up HCM >Product Related >Global Payroll & Absence Mgmt >eSocial BRA >Legal CodeSetup >Wage Type Code

Copyright © 1988, 2022, Oracle and/or its affiliates. 227

Working With eSocial Chapter 14

This example illustrates the fields and controls on the Wage Type Code page.

Global Payroll for Brazil delivers a list of wage type codes for use in eSocial reporting.

Wage Types Table PageUse the Wage Types Table page (GPBR_WAGE_TYPE) to assign wage type as well as other incidencecodes to accumulator elements for use in eSocial reporting.

Navigation:

Set Up HCM >Product Related >Global Payroll & Absence Mgmt >eSocial BRA >Legal CodeSetup >Wage Types Table >Wage Types Table

This example illustrates the fields and controls on the Wage Types Table page (1 of 2).

228 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 14 Working With eSocial

This example illustrates the fields and controls on the Wage Types Table page (2 of 2).

Wage Types Table Setup

Wage types table setup supports the processing of S-1010 Wage Event Table event reports. The S-1010event is responsible for initial loading earnings and deduction elements and other related information thatis used in payroll for companies, as well as tracking its data changes moving forward.

Wage types table setup consists of:

• Definition of INSS tax codes on the INSS Tax Incidence Code Page.

• Definition of income tax codes on the Income Tax Incidence Code Page.

• Definition of wage type codes on the Wage Type Code Page.

• Creation of wage types tables (referencing previously defined tax and wage type codes) on the WageTypes Table Page.

• Association of wage type tables and companies on the "(BRA) Company Details BRAPage" (Application Fundamentals).

Information entered in wage types tables (earnings and deduction elements) is not company-specific.To make this information available for eSocial reporting, it has to be linked to companies so that validwage type changes are submitted to the eSocial system for all impacted companies. Each wage typestable setup can be referenced by company on the Company Details BRA page.

• Entering tax exemption details for companies (if any) on the Exemption Proceedings Page.

To support eSocial reporting for the S-1010 event, Global Payroll for Brazil delivers theGPBR_ESOCIAL_COMPANY_SYNC service operation that is used to identify data changes that aremade to the Earnings and Deductions section of the Wage Types Table page after the completion ofthe initial loading process. Through Integration Broker, service operation messages will be triggeredon the Wage Types Table page, the Exemption Proceedings page, as well as in the Company BRA(COMPANY_TABLE_BRA) component when these online transactions are saved. Integration Brokertracks the online data changes that eSocial requires, and determines the appropriate actions (add, change,or delete) for the eSocial reports.

Copyright © 1988, 2022, Oracle and/or its affiliates. 229

Working With eSocial Chapter 14

When you save this component, the system validates that for each element that is associated with asuspended by judicial decision code value, additional judicial information is entered on the ExemptionProceedings page. It displays a warning message if the information is not available on that page.Suspended by judicial decision code values include:

• For INSS Tax Incidence: any 2-digit code that begins with 9

• For Income Tax Incidence: any 2-digit or 4-digit code that begins with 9

• For FGTS Incidence: any value that begins with Susp Judicial

Field or Control Description

Wage Tp Table ID (wage types table ID) Enter the identifier of the wage types table.

Wage types table IDs function like setIDs in the event splittingprocess for payroll events. They are associated with companieson the "(BRA) Company Details BRA Page" (ApplicationFundamentals).

Add Earnings/Deductions

Use this section to look up payroll elements by accumulator and enter default codes and properties.Matching accumulator elements are displayed on the Earnings and Deductions section, along with defaultcodes and properties.

Field or Control Description

Begin Date Enter the start date when this wage type code definitionbecomes valid.

The government can return an error for a submitted event thathas a retroactive date. If the begin date is earlier than the actualmonth and year, this system message appears:

Warning -- date out of range. The date entered is out of theactual month and year period. This is not normally true forthis date. Either acknowledge that the date is OK, or correctthe entered date.

Accumulator Element Specify an accumulator. Only accumulator elements areavailable for selection.

Wage Type Code Select a wage type code.

Wage Type Codes are defined on the Wage Type Code Page.

230 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 14 Working With eSocial

Field or Control Description

INSS Tax Incidence Select an INSS tax code.

INSS tax codes are defined on the INSS Tax Incidence CodePage.

Income Tax Type Select an income tax code.

Income tax codes are defined on the Income Tax IncidenceCode Page.

FGTS Incidence Select an FGTS code. Values are:

FGTS - 13th Salary

FGTS - Base

FGTS - Termination (Prior Notice)

Not Applicable

Susp Judicial (Prior Notice) (suspended by judicial decisionprior notice)

Susp Judicial 13th Salary

Susp Judicial Monthly

Add Earnings/Deductions Click to add matching accumulator elements to the Earningsand Deductions section.

Remove Earnings/Deductions Click to remove matching accumulator elements from theEarnings and Deductions section.

Selection Criteria

You can use this section to query payroll elements and wage type codes to which they are currentlymapped.

Results are displayed in the Earnings and Deductions section.

Earnings and Deductions: Map Elements

When you click the Add Earnings/Deductions button in the Add Earnings/Deductions section, thesystem populates the Earnings and Deductions section with all earning and deduction elements for theselected accumulator, and the wage type code that are specified in the Add/Remove Accumulatorsection. You can add or remove them manually as necessary.

Copyright © 1988, 2022, Oracle and/or its affiliates. 231

Working With eSocial Chapter 14

Field or Control Description

Entry Type Displays or enter either Deduction or Earnings.

Element Name Displays or enter payroll elements that need to be reportedon event S-1010. Available values are filtered by the selectedentry type.

Begin Date Displays or enter the start date when the selected wage typecode definition becomes valid. This date controls the availablevalues of the INSS Tax Incidence, Income Tax Type and FGTSIncidence fields.

A “date out of range” warning message appears if the enteredstart date is earlier than the current month and year.

Earnings and Deductions: Nature of Elements

The system populates this section with other codes and properties of the accumulator elements that arespecified in the Add Earnings/Deductions section. You can add or remove them manually as necessary.

Note: To specify an element for use in alimony calculation, select an alimony-specific value, for example,51, 52, 53, 54, or 55, as its income tax type.

Field or Control Description

Type Displays the nature of the element. Values are:

Deduction

Earning

Informative

Informative Deduction

Run Types PageUse the Run Types page (GPBR_RUN_TYPE) to specify run types, eSocial events, and other neededinformation for corresponding payroll elements. This information is used in compensation-related events,for example, S-1200, S-1210, S-2299 and S-2399. It does not apply to S-1010 event reports.

Navigation:

Set Up HCM >Product Related >Global Payroll & Absence Mgmt >eSocial BRA >Legal CodeSetup >Wage Types Table >Run Types

232 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 14 Working With eSocial

This example illustrates the fields and controls on the Run Types page.

Field or Control Description

Run Type Name Select a run type process. Results of selected run typeprocesses are reported to eSocial.

Total Earnings and Total Deductions Select accumulators to be used for total earnings and totaldeductions respectively.

Net Pay Element Select the net pay element for the selected run type process.

Event Code Select the eSocial event with which the corresponding run typeassociates.

(S-1200 and S-1210) When the Identify Calendars optionof the payroll event process is triggered for the S-1200 andS-1210 events, the system selects all applicable calendars forthe selected companies and competency period on the eSocialPayroll Events run control page.

(S-2299 and S-2399) Similarly, when the termination eventprocess is run on the eSocial Termination Events run controlpage, applicable calendars for payment are identified as well.

Based on the type (payroll or termination) of event processing, applicable calendars are finalized calendars that are linkedto run types, which are associated with the correspondingevents on the Run Types Page. A company is associatedwith wage types table setup (which contains run type setup)on the "(BRA) Company Details BRA Page" (ApplicationFundamentals).

See Also Processing Phases and Options

Payroll Tp (payroll type) Select if the payroll is done monthly, annually (for example, 13th salary), or not applicable.

Copyright © 1988, 2022, Oracle and/or its affiliates. 233

Working With eSocial Chapter 14

Field or Control Description

Payment Tp (payment type) Select the payment type. Values are:

N/A

Payroll

Term Non Empl (termination for non employees)

Termination

Vacation

Health Data PageUse the Health Data page (GPBR_HLTH_WAGE) to specify health plan setup for payroll event reporting.This information is used in compensation-related events, for example, S-1200, S-1210, S-2299 andS-2399. It does not apply to S-1010 event reports.

Navigation:

Set Up HCM >Product Related >Global Payroll & Absence Mgmt >eSocial BRA >Legal CodeSetup >Wage Types Table >Health Data

This example illustrates the fields and controls on the Health Data page.

Field or Control Description

Health Type Select Employee or Dependent.

Element Name Select an applicable deduction element.

Health Provider User Field # Select the user field number that is used to track the healthprovider for employee or dependent. This field is applicable toboth Dependent and Employee health types.

234 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 14 Working With eSocial

Field or Control Description

Dependent User Field # Select the user field number that is used to track the dependentnumber. This field is applicable only to the Dependent healthtype.

Exemption Proceedings PageUse the Exemption Proceedings page (GPBR_PROCEED_DT) to define the wage type proceeding detailsfor companies.

Navigation:

Set Up HCM >Product Related >Global Payroll & Absence Mgmt >eSocial BRA >Legal CodeSetup >Exemption Proceedings

This example illustrates the fields and controls on the Exemption Proceedings page.

Use this page to enter proceeding details for companies that have tax exemptions specified in theirelements on the Wage Types Table page. Data changes to this page, once validated, will be submitted toeSocial for the referenced company using the S-1010 event.

Copyright © 1988, 2022, Oracle and/or its affiliates. 235

Working With eSocial Chapter 14

Field or Control Description

Company Select a company. Only companies that are associated withthe listed wage types table ID on the Company BRA page areavailable for selection.

If you select a different company, the system prompts toconfirm if it can clear all the data entered for the old companyon this page. Enter the proceeding information for the newcompany.

Proceeding Definition

Field or Control Description

Court Order Type Select the court order type of the tax exemption. Values are:

FGTS

Income Tax - IRRF

Social Security-INSS

Union Contribution

Note: The Union Contribution court order type is no longerused in the eSocial S-1.0 version. The value can still be viewedin proceedings that were created before it became obsolete.

If you select a different court order type, the system prompts toconfirm if it can clear all the elements entered for the currentproceeding number.

Proceeding Type Enter the government proceeding type. This field is requiredif the selected court order type is Social Security-INSS. Valuesare:

Administrative

Judicial

236 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 14 Working With eSocial

Field or Control Description

Proceeding Number Select or enter the proceeding number of the tax exemption.

Note: The field prompt is available for use if the Enabledoption is selected on the "Adm/Legal Proceedings ParametersBRA Page" (PeopleSoft Human Resources AdministerWorkforce). Enter the number manually, if the option is notselected.

If the selected court order type is FGTS, proceeding numbersthat belong to the Judicial proceeding type and are created foreither Tax only or Tax and FGTS or FGTS only/TerminationSoc Cont become available for selection.

If the selected court order type is Income Tax - IRRF,proceeding numbers that belong to the Judicial proceedingtype and are created for Tax only or Tax and FGTS becomeavailable for selection.

If the selected court order type is Social Security-INSS,proceeding numbers that are created for Tax only or Tax andFGTS and the specified proceeding type become available forselection.

If the selected court order type is Union Contribution, enter theproceeding number manually.

You can add the same proceeding number to the system morethan once for different court order type and suspension codecombinations.

Proceedings are defined on the "Administrative/LegalProceedings BRA Page" (PeopleSoft Human ResourcesAdminister Workforce).

Extension of Decision Enter the decision extension type. This field becomes editableif the selected court order type is Social Security-INSS. Valuesare:

INSS Employer Cont. + Dis Ins.: The employer’s socialsecurity contribution plus discount of the insured.

INSS Employer Contribution: The employer’s social securitycontribution.

Copyright © 1988, 2022, Oracle and/or its affiliates. 237

Working With eSocial Chapter 14

Field or Control Description

Suspension Code Select or enter the applicable suspension code for the selectedproceeding number of the tax exemption. This code is requiredfor the Social Security-INSS and Income Tax - IRRF courtorder types.

Note: The field prompt is available for use if the Enabledoption is selected on the "Adm/Legal Proceedings ParametersBRA Page" (PeopleSoft Human Resources AdministerWorkforce). Enter the number manually, if the option is notselected.

If the selected court order type is Union Contribution, enter thesuspension code manually.

See Also "Administrative/Legal Proceedings BRAPage" (PeopleSoft Human Resources Administer Workforce).

Elements

Enter a minimum of one element.

Field or Control Description

Entry Type Enter the element type, Deduction or Earnings.

Element Name Specify an element. Elements of the specified entry type areavailable for selection based on these conditions:

• If the selected court order type is Social Security-INSS,elements with a 2-digit INSS tax incidence code thatbegins with 9 in the associated wage types table areavailable for selection.

• If the selected court order type is Income Tax - IRRF,elements with a 2-digit or 4-digit income tax type codethat begins with 9 in the associated wage types table areavailable for selection.

• If the selected court order type is FGTS, elements with anFGTS incidence value that begins with Susp Judicial inthe associated wage types table are available for selection.

See Also Wage Types Table Page.

238 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 14 Working With eSocial

Field or Control Description

Begin Date Enter the date when the corresponding element informationbegins to be validated for eSocial reporting. The current date isprepopulated if no element is chosen. If an element is selected, the system populates this field with the same begin date thiselement has on the Wage Types Table page.

eSocial Diagnostic Procedures PageUse the eSocial Diagnostic Procedures page (GPBR_ESOC_CODE) to define diagnostic procedurecodes.

Navigation:

Set Up HCM >Product Related >Global Payroll & Absence Mgmt >eSocial BRA >Legal CodeSetup >eSocial Diagnostic Procedures

This example illustrates the fields and controls on the eSocial Diagnostic Procedures page.

The system prepopulates this component with diagnostic procedure codes from table 27 in eSocial.Diagnostic procedure codes are referenced on the "Laboratory Exams BRA Page" (PeopleSoft HumanResources Monitor Health and Safety) to support worker health reporting using the S-2220 event.

Related LinksS-2220 - Worker Health Monitoring – ASO

Hazard Agent Code BRA PageUse the Hazard Agent Codes BRA page (HAZ_AGENT_TBL_BRA) to define hazard agent codes.

Navigation:

Copyright © 1988, 2022, Oracle and/or its affiliates. 239

Working With eSocial Chapter 14

Set Up HCM >Product Related >Workforce Monitoring >Health and Safety >Hazard AgentCodes BRA >Hazard Agent Codes BRA

This example illustrates the fields and controls on the Hazard Agent Codes BRA page.

The system prepopulates this component with hazard factor codes from table 24 in eSocial. These codesare used in work environment condition reporting using the S-2240 event.

Field or Control Description

Hazard Agent Code Displays the eSocial hazard agent code, which is 9 positions inlength.

Hazard Factor Table PageUse the Hazard Factor Table page (HAZARD_FACTOR_BRA) to define hazard factor codes.

Navigation:

Set Up HCM >Product Related >Workforce Monitoring >Health and Safety >Hazard FactorTable >Hazard Factor Table

240 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 14 Working With eSocial

This example illustrates the fields and controls on the Hazard Factor Table page.

Note: This page is not used.

The system prepopulates this component with hazard factor codes from table 23 in eSocial. These codesare used in work environment condition reporting using the S-2240 event.

While you can access the cloned Hazard Factor Table page (GPBR_HAZARD_FACTOR) from SetUp HCM >Product Related >Global Payroll & Absence Mgmt >eSocial BRA >Legal CodeSetup >Hazard Factor Table >Hazard Factor Table, it is recommended that you access this pageusing the Workforce Monitoring navigation.

Field or Control Description

eSocial Code Displays the code for the eSocial hazard factor, which is 9positions in length.

Hazard Type Specify the type of the hazard factor. Values are:

Biological Risk

Chemical Risk

Ergonomic Risk

Mechanical Risk

Other

Physical Risk

Copyright © 1988, 2022, Oracle and/or its affiliates. 241

Working With eSocial Chapter 14

Special Activities PageUse the Special Activities page (ACTIVITIES_BRA) to define special activity codes.

Navigation:

Set Up HCM >Product Related >Workforce Monitoring >Health and Safety >SpecialActivities >Special Activities

This example illustrates the fields and controls on the Special Activities page.

Note: This page is not used.

The system prepopulates this component with special activity codes from table 28 in eSocial. These codesare used in work environment condition reporting using the S-2240 event.

While you can access the cloned Special Activities page (GPBR_ACTIVITIES) from Set UpHCM >Product Related >Global Payroll & Absence Mgmt >eSocial BRA >Legal CodeSetup >Special Activities >Special Activities, it is recommended that you access this page using theWorkforce Monitoring navigation.

Understanding Events

This topic provides overviews of initial data loading, ongoing transaction reporting, driver and cross-reference tables, splitting of events, mapping process, stage table loading, processing options, and ways toidentify events for eSocial reporting.

Understanding Initial Data LoadingAfter the completion of eSocial setup (which includes the activation of eSocial functionality, theactivation, setup, and sequencing of initial events, the activation of participating companies, as well aslegal code mappings), the next step is to load PeopleSoft’s initial data.

242 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 14 Working With eSocial

Initial data refers to foundational data that is stored in setup tables. It includes information aboutcompanies, establishments, job codes, shifts, taxable locations, service takers, employees and non-employees, all of which is vital in supporting various labor and payroll transactions.

The initial loading of events is launched through run control pages. These events must be submitted forall participating companies before the implementation of eSocial. Going forward, initial loading eventsneed to be submitted, for example, when you activate a company (newly created or acquired), add newestablishments to a new company, or when a company starts using a new setID for basic tables, which isdefined on the SetID Group Page.

There are two initial load processes that need to be run, in this sequence:

1. Load basic table data

2. Load employee data

Initial Basic Table Data Loading

By default, the process includes the launching of these events:

• S-1000 - Employer Data

• S-1005 - Establishment and Building Site Table

• S-1010 - Wage Types Table

• S-1020 - Tax Location Table

Inactive initial events are not included in the eSocial Basic Tables Initial process.

Run this data loading process on the eSocial Basic Initial Page.

Initial Employee Data Loading

After the initial load process for basic table data is completed successfully, the next step is to sendinformation about employees, which, based on the run control setup, can include active employees withtemporary absence, employees who are fulfilling prior notice, as well as inactive employees who haverecently been terminated but are expecting payments from the employer. Any individual who was hiredon or after the company becomes active for eSocial reporting, as well as on or before the eSocial onPeopleSoft date specified for the company, his or her most current effective-dated employee data (inreference to the company’s eSocial on PeopleSoft date) will be reported to eSocial. Data for individualswho were hired after the eSocial on PeopleSoft date will be reported to eSocial using the S-2200 orS-2300 event.

Important! As delivered, future rows for employees and non-employees are not considered during theinitial employee data loading process. To support future rows, customers have to create their own triggersand launch them during S-2200 or S-2300 processing.

By default, the process includes the launching of these events:

• S-2200 - Employees Initial Loading and Hiring

• S-2300 - Workers who have no employment relationship – Begin

Copyright © 1988, 2022, Oracle and/or its affiliates. 243

Working With eSocial Chapter 14

Data changes for employees with employment relationship after the initial data load will be reported toeSocial through S-2200 event rectifications, S-2205, or S-2206 events, depending on when the changeswere made. For example, an employee (hire date: January 10th) was reported to eSocial through theS-2200 event. If a new effective-dated row is added today (May 1st) for this employee in the Job Datacomponent, this contract data change will be reported to eSocial using the S-2206 event. If a neweffective-dated row is also added today in the Personal Data component for the employee’s marital statuschange, this personal data change will be reported using the S-2205 event. However, if any of thesechanges is made in the row effective-dated January 10th, an S-2200 event (with the Rectification indicatorturned on) will be created to report to eSocial that the hiring data has been modified.

Similarly, data changes for workers with no employment relationship will be reported through S-2300event rectifications and the S-2306 event.

Important! As delivered, existing rows with a future date are not considered during the initial employeedata loading process. To support these rows, customers have to create their own triggers for S-2205,S-2206, or S-2306 to report the changes.

Run this data loading process on the eSocial Employee Initial Page.

Understanding Reporting of Ongoing Transactions and Event CategoriesAfter the initial data for participating companies is loaded and then transmitted to the eSocial environmentsuccessfully, eSocial is live. From now on, certain updates about companies and their employees in HCMneed to be reported to the Brazilian federal government through eSocial. The government identifies a listof events that companies need to capture and report to the eSocial system when they occur. These eventscollect information about companies, employees, as well as transactions that are performed regardingpayments to individuals, payroll and labor obligations, social security and other fiscal impacts, and mustbe submitted within the time-frame permitted by law. Depending on the nature of the events, some need tobe reported to eSocial almost as soon as they occur, while others can be processed periodically in a batch.

Events are grouped into these high-level categories:

1. Basic table events.

2. Non-periodic events.

3. Periodic events.

4. Totaling events.

5. Termination events.

Events are interdependent of one another, and there is a sequence in which they are launched by category,and within their own category. The sequence of events for each category is established in the EventsSequence by Category BRA component.

244 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 14 Working With eSocial

Important! eSocial accepts only one single register for any given data entry for the same period (monthand year) and company (represented by its sole headquarter establishment). In PeopleSoft, data rowsare controlled by effective date (day, month and year). When a basic table code (for example, job code)has more than one row with the same month and year in their effective dates (for example, September1st, 2016 and September 21st, 2016), the row with the most current effective date in the period will bereported to eSocial for that period if needed. Every time a new effective-dated row is entered in one ofthe basic tables in PeopleSoft, the system checks if the corresponding event for the same month and yearperiod has already been sent. If so, instead of triggering a new event for the new effective-dated row, achange event is invoked to update the data on the eSocial environment.

Basic Table Events

Basic table events build the foundation of data that companies need to set up and maintain in theeSocial system. These events record basic table data (such as job codes and work shifts) and employerinformation (such as identification of employers, its establishments and construction work sites). They areincluded in the initial data loading process.

After eSocial goes live, changes made to basic table and employer data on HCM component transactionsmust be sent to eSocial environment no later than the 7th day of the month following the updates, or priorto the transmission of any event that requires the changed information for validation, whichever comesfirst.

To ensure the proper handling of periodic and non-periodic events from employers and payrollcalculations going forward, it is important that the data that is loaded to the eSocial system be accurate atall times.

Refer to Global Payroll for Brazil eSocial Event Layouts for a list of system-delivered basic table events.

Non-Periodic Events

Non-periodic events, or labor events, are legal labor facts that can happen on any business day betweenan employer and its employees through HCM component transactions. Examples of non-periodic eventsinclude hiring, salary changes, accidents at work, absences and so on. These facts impact the granting ofrights, as well as the fulfillment of labor, social security and tax obligations.

Refer to Global Payroll for Brazil eSocial Event Layouts for a list of system-delivered non-periodicevents.

As these events occur and are confirmed, they need to be transmitted to the eSocial system shortly. Forexample:

• Information related to hiring employees or contract workers without employment relationship has tobe submitted by the end of the day immediately, prior to the commencement of service.

• Information related to accidents at work has to be submitted on the next work day following theoccurrence of the accident. In case of death, it needs to be reported immediately.

• Information related to the rest of the labor events must be sent either by the seventh day of thefollowing month after the change becomes effective, or before the submission of any periodic event(for example, payroll) that uses the updated labor information for validation, whichever comes first.

Copyright © 1988, 2022, Oracle and/or its affiliates. 245

Working With eSocial Chapter 14

Note: If the termination payment date by when an event needs to be submitted is a bank holiday, thework day immediately preceding this bank holiday becomes the new submission due date.

Periodic Events

Periodic events are legal labor facts that occur on a predefined schedule. Examples of periodic eventsinclude payments related to payroll, calculation of social security contributions and income taxes.Companies need to report earnings and deductions paid to their employees and non-employees throughpayroll, according to the predefined wage types codes. These codes indicate whether or not paymentsare taxable, or have impacts on averages for vacations, 13th salary and terminations, among others. Theymust also report compensation amounts regarding payroll exemption on each establishment to composethe INSS (Social Security Tax) calculation basis.

Since periodic events typically occur as batch processes in the background, they are captured for eSocialreporting through run control pages.

In general, periodic events need to be reported to eSocial by the 7th day of the month following theiroccurrences. Companies can generate tax payment forms to collect payments only after these events aresubmitted.

Note: If the date by when an event needs to be submitted is a bank holiday, the work day immediatelypreceding this bank holiday becomes the new submission due date.

Refer to Global Payroll for Brazil eSocial Event Layouts for a list of system-delivered periodic events.

Totaling Events

Totaling events provide summaries of compensation-related calculations to companies after thesubmission of their employees’ compensation data to the Brazilian government. They are returned fromthe eSocial environment of the government, after events (such as S-1200, S-1210, S-1299, and S-2299)are received and processed successfully.

Refer to Global Payroll for Brazil eSocial Event Layouts for a list of system-delivered totaling events foreSocial, and how they are run to retrieve the information requested.

Termination Events

Termination events are a subset of non-periodic events. They are used to report information relatedto terminations, which can happen on any business day between employers and employees (or non-employees).

In general, termination-related information has to be submitted on the next work day following thetermination date, if the termination is planned (for example, tendering of a work notice, or end of a fixedterm contract).

In all other cases, termination information needs to be sent to the eSocial system no later than 10 calendardays following the termination date.

Note: If the termination payment date by when an event needs to be submitted is a bank holiday, the workday immediately preceding this bank holiday becomes the new submission due date.

Refer to Global Payroll for Brazil eSocial Event Layouts for a list of system-delivered termination events.

246 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 14 Working With eSocial

Related LinkseSocial Basic Table Event PageeSocial Non Periodic Event PageeSocial Payroll Events Page

Driver and Cross-Reference TablesThe driver and cross reference tables record and control all events to be submitted to the eSocialenvironment. Every XML file generated for an eSocial event is based on a record from the driver table,and the cross-reference table for the record’s event. These two records contain the same two keys (driversequence and driver split sequence) that uniquely identify a transaction in PeopleSoft.

The set of driver tables consist of:

• The driver table

The driver table stores general information about the identified event, such as driver sequence, action,status, timestamps, different IDs (Protocol, Batch, Receipt and Event) and so on.

• Cross reference tables

A cross reference table is present for each supported event layout. Cross reference tables store keyinformation about the data being added, changed or deleted on components. Each table has at least thesame key structure as its base HCM table.

Driver and cross-reference tables contain only references to retrieve all the information needed togenerate XML files for eSocial events that occurred. Their records can be added, updated, or deleted as aresult of:

• Online transactions - when a transaction is saved in an eSocial-mapped component, a subscriptionmessage is fired, containing the transaction information needed for eSocial reporting. Records areadded to the driver and corresponding cross-reference tables based on the component and subscriptionmessage content.

• Batch processing, which are:

• Initial data loading, which inserts driver and cross-reference records.

• Mapping process and staging table loading, which update record statuses.

• XML file generation, which update record statuses.

• Status update from web service

PeopleSoft receives status updates regarding file submissions from eSocial environment through aweb service. Status information is updated in driver records as a result.

The driver table is the key element in driving the eSocial process flow; it is also the basic table that isused for the monitoring tool.

Copyright © 1988, 2022, Oracle and/or its affiliates. 247

Working With eSocial Chapter 14

Splitting of Events for Multiple Impacted CompaniesIn PeopleSoft HCM, certain data is organized in ways that are different from how the eSocialenvironment collects information, which is by company. Subsequently, when an update of such dataoccurs and it triggers an insertion of a row in the driver and cross-reference tables, the system needs to dothe same for all companies that use the updated information. The splitting of the row (creating new ones)ensures that the correct number of entries are loaded to staging tables, which are later used to generateXML files for all impacted companies.

The splitting of events applies to these types of data:

• Information that is keyed by setID, such as basic table data.

See the Understanding SetID and Company Mapping topic for more information.

• Employee data that is keyed by employee ID.

An example of it is employee’s personal data. An employee may have jobs with different companiesand while job data is keyed by employee record number (which corresponds to a company), personaldata isn’t. When the employee updates his or her personal information, the updated information needsto be sent to all companies where he or she has a contract.

• Payroll elements, which can be used by multiple companies.

Note: Splitting of events is handled as part of the initial data loading and online transaction processes.

Mapping ProcessAs an important part of the eSocial functionality, the mapping process:

• Gathers the one-to-one field values that are required by eSocial event reporting, based on the inputprovided in the driver and cross-reference tables.

• Extracts all the information required for the events to be reported, and populates it to correspondingstaging records.

After the mapping process is finalized, a call can be made to the XML generation AE process tocreate XML outputs for event data found in staging tables.

• Updates driver rows with corresponding statuses based on the options selected on the run control pageand data being processed.

The mapping process is triggered when the Prepare Data option is selected on run control pages thatprocess eSocial events. For more information, see Processing Phases and Options.

Loading Staging TablesStaging tables are a set of database tables that are designed based on the event layouts published by thegovernment. They are used to store the event information that the system uses to generate XML files.

Here are the high-level steps to load processed event data to staging tables for XML file generation,which is part of the mapping process:

248 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 14 Working With eSocial

1. Identify rows from the driver record that match run control parameters, and insert them to theTemporary record.

2. Clean up staging records. Check and remove any existing, irrelevant data rows (from previousprocesses) from the staging records, which are also available in the Temporary record.

3. Insert data from PeopleSoft application records and the Temporary record to corresponding stagingrecords.

The eSocial functionality can access data a lot quicker from staging tables than from the originalPeopleSoft transaction tables, posing as little impact as possible on performance.

4. Update the row statuses:

a. For rows that are added to staging tables successfully, row status is set to MAPP in Temporary anddriver records.

b. For rows that cannot be added to staging tables, row status is set to ERRM in Temporary anddriver records.

c. For rows that have XMLs created successfully, row status is set to XCRT in Temporary and driverrecords.

5. Generate log file entries for data rows that are not added to staging records successfully.

Related LinksSubmitting XML Outputs and Requesting Results

Processing Phases and OptionsGlobal Payroll for Brazil creates eSocial events for reporting using application engine (AE) processes thatare launched from run control pages. Built for initial data loading and specific event categories, these runcontrol pages support a list of processing phases and options:

• Prepare Data

The Prepare Data option looks for new, modified, and deleted information, and creates driver datafor it. The mapping process takes all the driver records (which are in the RDY status and do not haveXML files generated for them yet) that meet the criteria listed on the run control page, and loads theprocessed data to staging tables. For rows that are loaded to staging tables successfully, their driverrecord status is updated to MAPP; for those that are not loaded successfully, their driver record statusis changed to ERRM instead.

Note: In the case of initial data loading, the processes first identify the information from PeopleSoftHCM-based records that meet the criteria listed on the run control pages and include references indriver and cross-reference tables, before processing the information and loading it to staging tables.

After verifying the results, users may perform this step again if changes occur, or if issues are fixedand they need to be reflected in the data.

Copyright © 1988, 2022, Oracle and/or its affiliates. 249

Working With eSocial Chapter 14

For example, after performing the Prepare Data step, a user adds new job codes to the company. Aseach new job code is added, the system creates a new driver record. When the user performs this stepagain, the process identifies these new driver records and includes them.

The Prepare Data step can be run multiple times, initially for the entire selection of events (ortransactions) and companies on the run control page, and subsequently for those with changes orfixes.

This option is selected and becomes unavailable for edits if the Reprocess option is selected. Itbecomes unavailable for edits if the Delete option is selected.

• Reprocess

Use this option to process again all pending entries (in the RDY status) that meet the criteria listed onthe run control page. Users may use it occasionally, for example, when a change of parameter or dataimpacts all the events but a new driver record is not created to reflect the change.

Note: The Reprocess option works differently for initial loading processes. When the Reprocessoption is selected for loading initial basic table or employee data, the mapping process takes driverrows that are generated for initial data loading (GPBR_ORIG_ESOC equal to I), and are in the RDY,MAPP, ERRM, or XERR (error occurred in the XML generation) status, but do not have XML filesgenerated for them yet.

This option becomes unavailable for edits if the Delete option is selected.

• Create XML

If users are satisfied with the mapping process result, they can select this option to generate theXML outputs for driver data rows (in the MAPP row status) that are inserted to staging tables. Whenselected, the status of all driver records that meet the criteria listed on the run control page is updatedto SUCC. A call is then made to invoke the XML generation application engine (AE) program(GPBR_GEN_XML) to create XML outputs for those matching data rows. After the AE process iscompleted, the status for each processed driver record is updated to XCRT.

This option becomes unavailable for edits if the Delete option is selected.

See Also Creating XML Outputs for Events

• Skip Data in Error

This option is available for selection if the Create XML option is selected. When Skip Data in Erroris selected, the Create XML process ignores records that are in the "error" status, and continues withthe creation of XML files for those that are clean. It gives users the option to generate XML filesfor error-free records and send files to eSocial first if they choose to do so, and work on the skippedrecords later.

Note: (For S-1299 events) If both Create XML and Skip Data in Error options are selected for acompany on the eSocial Period Controls Page, and the company happens to have calendar groups thataren’t finalized or events that aren’t submitted successfully for the specified period, no XML file willbe created for that company and the selected event.

If Skip Data in Error is not selected but Create XML is, the process stops if error is found in any datarecord included in the Create XML process.

250 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 14 Working With eSocial

This option becomes unavailable for edits if the Delete option is selected.

• Delete

This option deletes the initial load data rows that were inserted in the driver, cross reference, andstaging tables through the Prepare Data or Reprocess option.

This option is available if none of the other options are selected. When the Delete option is selected,all other options are no longer editable.

Customers choose this option if they discover that wrong setIDs were linked to companies on theSetID Group page by mistake.

• Identify Calendars

As the first step for generating payroll events, this option selects all calendars that match the selectioncriteria on the run control page. Calendar information is used in the mapping process for payrollevents. In order to be used in payroll event processing for companies, calendars must be:

• Finalized.

• Associated with run types that are configured on the Run Types Page for the payroll events(S-1200 and S-1210).

• Within the competency period specified on the run control page.

For S-1200 events, employers submit detailed payroll wage types by employee and accrualmonth. A calendar is included if the begin date and end date of the period ID match the specifiedcompetency period.

For S-1210 events, employers submit net payments by employee or non-employee and paymentdate. A calendar is included if the payment date falls within the specified competency period.

When companies handle cash basis, vacation, termination, advance and any other off-cyclepayments, it is normal that the actual payment date does not fall within the period to which thepayment pertains. Therefore, it is possible to see calendars being processed in two periods, oneby competency and the other by payment date. In an example where both the period ID andpayment date of a payroll entry fall within the specified competency period, the system generatesboth S-1200 and S-1210 events; if the period ID falls outside and the payment date within thecompetency period, only the S-1210 event is generated.

The Identify Calendars option is specific to S-1200 and S-1210 events. When either event isselected, the system automatically selects the other event, the Identify Calendars option, as wellas the Validate Elements option. The Identify Calendars option can be processed with ValidateElements option alone, or together with other options (such as Prepare Data or Reprocess).

If the Reprocess option is selected for S-1200 and S-1210 events, the system selects the PrepareData option automatically.

• Validate Elements

This option validates if all accumulator elements (either Total Earnings or Total Deductions) that areentered on the Run Types Page are also set up on the Wage Types Table Page. Information is logged,if accumulator elements on the Run Types page cannot be found on the Wage Types Table page, or if

Copyright © 1988, 2022, Oracle and/or its affiliates. 251

Working With eSocial Chapter 14

the Wage Types Table page contains more elements than the accumulators that are defined on the RunTypes page.

The Validate Elements option is specific to S-1200 and S-1210 events. The system automaticallyselects this option when both events are selected on the eSocial Payroll Events page.

• Validate Calendar and Events

This option validates, for the competency period and companies selected on the eSocial PeriodControls Page, if all associated calendar groups are in the 70 (Finalized) or 75 (Finalized with Bank)calculation status and that all events have been submitted successfully before the request to closethe period can be processed. If there are calendar groups that are not finalized or events that are stillawaiting receipt numbers from the government, an S-1299 event cannot be created. A PDF report withinformation about pending calendar groups and events is generated for company administrators toreview and take actions accordingly.

The system automatically selects this option if the Prepare Data, Reprocess or Create XML optionis selected on the eSocial Period Control page.

• Cancel Data

This option deletes the existing mapping (driver and staging tables) for matching data rows that donot already have generated XML outputs. After the cancelation process is completed, the status ofimpacted rows is changed to RDY.

The Cancel Data option does not apply to S-1200, S-1210, S-1280, S-1298, S-1299, S-2299, andS-2399 events.

HCM Transaction Data Retrieved For eSocial EventsTypically, the lifecycle of an eSocial event begins when a user saves a transaction online in an eSocial-mapped component, such as Job Data, Job Code, Company, Establishment, and so on. The save actioncreates a trigger in the system that determines if the saved transaction is subject to eSocial reporting and ifso, with which event code to report it.

After that, the mapping process comes in to prepare data for the event. This process extracts all theinformation that is required to create the event, and populates tags (fields) accordingly. It also makes surethat future rows are not processed if their effective dates do not fall within the period currently assessedby eSocial.

Once the mapping process is completed, the event is ready for another process where an XML outputfor the event gets generated. Lastly, the XML output is submitted to a third-party program and then thegovernment of Brazil through web services.

This table lists the eSocial events, their event types (basic table and non-periodic), and the HCMcomponent pages from which data is retrieved to generate corresponding events (when transactions aresaved):

252 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 14 Working With eSocial

Event Layout - Report Name EventType

Components to Collect Event Data

S-1000 - Employer Data BasicTable

• Establishment Table Brazil (ESTAB_TBL_BRA)

• Set Up HCM >Product Related >WorkforceAdministration >Establishment BRA >Establishment Address

• Set Up HCM >Product Related >WorkforceAdministration >Establishment BRA >Additional Info - Brazil

• Company BRA (COMPANY_TABLE_BRA)

• Set Up HCM >Foundation Tables >Organization >CompanyBRA >Company Location

• Set Up HCM >Foundation Tables >Organization >CompanyBRA >Phones

• Set Up HCM >Foundation Tables >Organization >CompanyBRA >Company Details BRA

S-1005 - Establishment andBuilding Site Table

BasicTable

• Timecard Type (GPBR_TIMECARD_CODE)

Set Up HCM >Product Related >Global Payroll and AbsenceMgmt >eSocial BRA >Legal Code Setup >Timecard Type

• Establishment Table Brazil (ESTAB_TBL_BRA)

• Set Up HCM >Product Related >WorkforceAdministration >Establishment BRA >Establishment Address

• Set Up HCM >Product Related >WorkforceAdministration >Establishment BRA >Additional Info - Brazil

S-1010 - Wage Types Table BasicTable

• Wage Types Table (GPBR_WAGE_TYPE)

Set Up HCM >Product Related >Global Payroll & AbsenceManagement >eSocial BRA >Legal Code Setup >Wage TypesTable

• Exemption Proceedings (GPBR_PROCEED_DET)

Set Up HCM >Product Related >Global Payroll & AbsenceManagement >eSocial BRA >Legal Code Setup >ExemptionProceedings

Copyright © 1988, 2022, Oracle and/or its affiliates. 253

Working With eSocial Chapter 14

Event Layout - Report Name EventType

Components to Collect Event Data

S-1020 - Tax Location Table BasicTable

• Establishment Table Brazil (ESTAB_TBL_BRA)

• Set Up HCM >Product Related >WorkforceAdministration >Establishment BRA >Establishment Address

• Set Up HCM >Product Related >WorkforceAdministration >Establishment BRA >Additional Info -Brazil. Click the Judicial Gathering Data link.

• Brazil Service Taker (GPBR_SERVICE_TAKER)

Set Up HCM >Product Related >Global Payroll & AbsenceMgmt >Framework >Organizational >Service TakersBRA >Service Takers BRA

S-1030 - Job Code Table BasicTable

Important! This eSocial report is no longer required and therefore has beeninactivated in the S-1.0 version.

Job Code Table (JOB_CODE_TBL)

Set Up HCM >Foundation Tables >Job Attributes >Job CodeTable >Job Code Profile

S-1050 - Work Shift and TimeLabor Table

BasicTable

Important! This eSocial report is no longer required and therefore has beeninactivated in the S-1.0 version.

• Shifts (SCH_SHIFT)

• Set Up HCM >Product Related >Time and Labor >ScheduleConfigurations >Schedule Shifts >Shift

• Set Up HCM >Product Related >Global Payroll & AbsenceMgmt >Schedules >Schedule Shifts >Shift

• Schedule Definition (SCH_DEFINITION)

Set Up HCM > Product Related > Global Payroll & AbsenceMgmt > Schedules > Definitions > Definition

S-1060 - Workplace Table BasicTable

Important! This eSocial report is no longer required and therefore has beeninactivated in the S-1.0 version.

Workplace Table BRA (WORKPLACE_BRA)

Workforce Monitoring >Health and Safety >Define HazardousEnvironments >Workplace Table BRA >Workplace Table BRA

S-1070 - Administrative andLegal Proceedings

BasicTable

Administrative/Legal Proceedings BRA (LEGAL_PROC_BRA)

Set Up HCM >Product Related >Workforce Administration >Admin/Legal Proceedings BRA >Administrative/Legal Proceedings BRA

254 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 14 Working With eSocial

Event Layout - Report Name EventType

Components to Collect Event Data

S-2200 - Employees InitialLoading and Hiring

Non-periodic

• Job Data (JOB_DATA)

• Workforce Administration >Job Information >Job Data (allpages except Salary Plan)

• Workforce Administration >Job Information >Job Data. Clickthe Employment Data link.

• Personal Data (PERSONAL_DATA)

Workforce Administration >PersonalInformation >Biographical >Update Person Detail (all pages)

• Additional Names (NAMES_OTHER)

Workforce Administration >PersonalInformation >Biographical >Additional Names

• Personal Information BRA (PERSONAL_INFO_BRA)

Workforce Administration >PersonalInformation >Biographical >Personal Information BRA >PersonalInformation BRA

• Disabilities BRA (DISABILITY_BRA)

Workforce Administration >PersonalInformation >Disability >Disabilities BRA >Disabilities BRA

• Establishment BRA (ESTAB_TBL_BRA)

• Set Up HCM >Product Related >WorkforceAdministration >Establishment BRA >Establishment Address

• Set Up HCM >Product Related >WorkforceAdministration >Establishment BRA >Additional Info - Brazil

• City Codes BRA

Set Up HCM >Product Related >Workforce Administration >CityCodes BRA >City Codes BRA

• eSocial Action and Reason (GPBR_ESOC_ACT_REA)

Set Up HCM >Product Related >Global Payroll & AbsenceMgmt >eSocial BRA >Legal Code Setup >eSocial Action andReason >Hire Action and Reason

• Labor Regime (GPBR_LABOR_REGIME)

Set Up HCM >Product Related >Global Payroll & AbsenceMgmt >eSocial BRA >Legal Code Setup >Labor Regime

• Ethnic Groups (GPBR_ETHNIC_GROUP)

Set Up HCM >Product Related >Global Payroll & AbsenceMgmt >eSocial BRA >Legal Code Setup >Ethnic Groups

Copyright © 1988, 2022, Oracle and/or its affiliates. 255

Working With eSocial Chapter 14

Event Layout - Report Name EventType

Components to Collect Event Data

• Education Level (GPBR_EDUCATIO_CODE)

Set Up HCM >Product Related >Global Payroll & AbsenceMgmt >eSocial BRA >Legal Code Setup >Education Level

• Marital Status (GPBR_MARITAL_CODE)

Set Up HCM >Product Related >Global Payroll & AbsenceMgmt >eSocial BRA >Legal Code Setup >Marital Status

• Absence Take and Reason (GPBR_ABS_TAKE_REA)

Set Up HCM >Product Related >Global Payroll & AbsenceMgmt >eSocial BRA >Legal Code Setup >Absence Take andReason

• Address Type (GPBR_ADDR_TYPE)

Set Up HCM >Product Related >Global Payroll & AbsenceMgmt >eSocial BRA >Legal Code Setup >Address Type

• Dependents (GPBR_DEP_INF_CODE)

Set Up HCM >Product Related >Global Payroll & AbsenceMgmt >eSocial BRA >Legal Code Setup >Dependents

• Dependent and Beneficiary Information (W3EB_PERS_DTA_SMRY)

Self Service >Benefit >Dependent/Beneficiary Info

• Dependent Information (DEPEND_BENEF)

Workforce Administration >Personal Information >PersonalRelationships >Dependent Information (all pages except Address)

• Additional Information BRA (ADDL_INFO_BRA)

• Workforce Administration >Job Information >AdditionalInformation BRA >Additional Information BRA

• Workforce Administration >Job Information >AdditionalInformation BRA >Additional Contract Data

• Define Payee Parameters BRA (GPBR_PAYEE_PARM)

Global Payroll & Absence Mgmt >Payee Data >Define PayeeParameters BRA

• Absence Event Entry - Brazil (GPBR_ABSENCE_ENTRY)

Global Payroll & Absence Mgmt >Payee Data >MaintainAbsences >Absence Event BRA

• Unions (UNION_TABLE)

Set Up HCM >Product Related >WorkforceAdministration >Labor Administration >Unions >Unions >UnionLocation

• Schedule Shifts (SCH_DEFINITION)

256 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 14 Working With eSocial

Event Layout - Report Name EventType

Components to Collect Event Data

Set Up HCM >Product Related >Global Payroll & AbsenceMgmt >Schedules >Definitions >Schedule Shifts

• Assign Work Schedule (GP_SCH_ASSIGN)

Global Payroll & Absence Mgmt >Payee Data >CreateOverrides >Assign Work Schedule >Assign Work Schedule

• Country and Nationality Cd BRA (ES_COUNTRY_TBL_BRA)

Set Up HCM >Product Related >WorkforceMonitoring >Regulatory Requirements >Country and NationalityCd BRA

• ASO Medical Exam Results BRA (ASO_EXAM_RSLT_BRA)

Workforce Monitoring >Health and Safety >Record Medical ExamResults >ASO Exam Results BRA

Copyright © 1988, 2022, Oracle and/or its affiliates. 257

Working With eSocial Chapter 14

Event Layout - Report Name EventType

Components to Collect Event Data

S-2205 - Personal Data Changes Non-periodic

• Personal Data (PERSONAL_DATA)

Workforce Administration >Personal Information >Modify aPerson (all pages)

• Personal Information BRA (PERSONAL_INFO_BRA)

Workforce Administration >PersonalInformation >Biographical >Personal Information BRA >PersonalInformation BRA

• City Codes BRA

Set Up HCM >Product Related >Workforce Administration >CityCodes BRA >City Codes BRA

• eSocial Action and Reason (GPBR_ESOC_ACT_REA)

Set Up HCM >Product Related >Global Payroll & AbsenceMgmt >eSocial BRA >Legal Code Setup >eSocial Action andReason >Hire Action and Reason

• Labor Regime (GPBR_LABOR_REGIME)

Set Up HCM >Product Related >Global Payroll & AbsenceMgmt >eSocial BRA >Legal Code Setup >Labor Regime

• Ethnic Groups (GPBR_ETHNIC_GROUP)

Set Up HCM >Product Related >Global Payroll & AbsenceMgmt >eSocial BRA >Legal Code Setup >Ethnic Groups

• Education Level (GPBR_EDUCATIO_CODE)

Set Up HCM >Product Related >Global Payroll & AbsenceMgmt >eSocial BRA >Legal Code Setup >Education Level

• Marital Status (GPBR_MARITAL_CODE)

Set Up HCM >Product Related >Global Payroll & AbsenceMgmt >eSocial BRA >Legal Code Setup >Marital Status

• Absence Take and Reason (GPBR_ABS_TAKE_REA)

Set Up HCM >Product Related >Global Payroll & AbsenceMgmt >eSocial BRA >Legal Code Setup >Absence Take andReason

• Address Type (GPBR_ADDR_TYPE)

Set Up HCM >Product Related >Global Payroll & AbsenceMgmt >eSocial BRA >Legal Code Setup >Address Type

• Dependents (GPBR_DEP_INF_CODE)

Set Up HCM >Product Related >Global Payroll & AbsenceMgmt >eSocial BRA >Legal Code Setup >Dependents

• Disabilities BRA (DISABILITY_BRA)

258 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 14 Working With eSocial

Event Layout - Report Name EventType

Components to Collect Event Data

Workforce Administration >PersonalInformation >Disability >Disabilities BRA >Disabilities BRA

• Dependent Information (DEPEND_BENEF)

Workforce Administration >Personal Information >PersonalRelationships >Dependent Information (all pages except Address)

• Country and Nationality Cd BRA (ES_COUNTRY_TBL_BRA)

Set Up HCM >Product Related >WorkforceMonitoring >Regulatory Requirements >Country and NationalityCd BRA

• Dependent and Beneficiary Information (W3EB_PERS_DTA_SMRY)

Self Service >Benefit >Dependent/Beneficiary Info

Copyright © 1988, 2022, Oracle and/or its affiliates. 259

Working With eSocial Chapter 14

Event Layout - Report Name EventType

Components to Collect Event Data

S-2206 - Employment ContractChanges

Non-periodic

• Job Data (JOB_DATA)

• Workforce Administration >Job Information >Job Data (allpages except Salary Plan)

• Workforce Administration >Job Information >Job Data. Clickthe Employee Data link.

• Personal Data (PERSONAL_DATA)

Workforce Administration >Personal Information >Modify aPerson (all pages)

• Additional Information BRA (ADDL_INFO_BRA)

• Workforce Administration >Job Information >AdditionalInformation BRA >Additional Information BRA

• Workforce Administration >Job Information >AdditionalInformation BRA >Additional Contract Data

• Labor Regime (GPBR_LABOR_REGIME)

Set Up HCM >Product Related >Global Payroll & AbsenceMgmt >eSocial BRA >Legal Code Setup >Labor Regime

• Define Payee Parameters BRA (GPBR_PAYEE_PARM)

Global Payroll & Absence Mgmt >Payee Data >Define PayeeParameters BRA

• Unions (UNION_TABLE)

Set Up HCM >Product Related >WorkforceAdministration >Labor Administration >Unions >Unions >UnionLocation

• Establishment Table Brazil (ESTAB_TBL_BRA)

Set Up HCM >Product Related >WorkforceAdministration >Establishment BRA >Additional Info - Brazil

• Pay Groups (GP_PYGRP)

Set Up HCM >Product Related >Global Payroll & AbsenceMgmt >Framework >Organizational >Pay Groups >Pay GroupsName

• Schedule Shifts (SCH_DEFINITION)

Set Up HCM >Product Related >Global Payroll & AbsenceMgmt >Schedules >Definitions

• Shifts (SCH_SHIFT)

• Set Up HCM >Product Related >Time and Labor >ScheduleConfigurations >Shifts >Shift

260 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 14 Working With eSocial

Event Layout - Report Name EventType

Components to Collect Event Data

• Set Up HCM >Product Related >Global Payroll & AbsenceMgmt >Schedules >Shifts >Shift

• Shift BRA (SCH_SHIFT_BRA)

Set Up HCM >Product Related >Time andLabor >Schedules >Shifts BRA >Shift

S-2210 - Accident at WorkCommunication (CAT)

Non-periodic

• Incident data Brazil (HS_INCIDENT_BRA)

Workforce Monitoring >Health and Safety >Obtain IncidentInformation >Incident Details BRA

• Incident data (HS_INJURY_ILL_BRA)

Workforce Monitoring >Health and Safety >Obtain IncidentInformation >Injury Details BRA

• Source Of Injury Table (INJURY_SOURCE_TBL)

Workforce Monitoring >Health and Safety >Define Accident/Injury Info >Source of Injury

• Physician data for Brazil (HS_PHYSICIAN_BRA)

Set Up HCM >Product Related >Workforce Monitoring >Healthand Safety >Physician BRA

S-2220 - Occupational HealthMonitoring

Non-periodic

• ASO Exam Results BRA (ASO_EXAM_RSLT_BRA)

Workforce Monitoring >Health and Safety >Record Medical ExamResults >ASO Exam Results BRA

• Physician data for Brazil (HS_PHYSICIAN_BRA)

Set Up HCM >Product Related >Workforce Monitoring >Healthand Safety >Physician BRA

• Laboratory Exams BRA (MED_TESTS_DET_BRA)

Set Up HCM >Product Related >Workforce Monitoring >Healthand Safety >Laboratory Exams BRA

Copyright © 1988, 2022, Oracle and/or its affiliates. 261

Working With eSocial Chapter 14

Event Layout - Report Name EventType

Components to Collect Event Data

S-2230 - Temporary Absence Non-periodic

• Job Data (JOB_DATA)

Workforce Administration >Job Information >Job Data >WorkLocation

• Additional Information BRA (ADDL_INFO_BRA)

Workforce Administration >Job Information >AdditionalInformation BRA

• Personal Data (PERSONAL_DATA)

Workforce Administration >PersonalInformation >Biographical >Update Person Detail >BiographicalDetails

• Disabilities BRA (DISABILITY_BRA)

Workforce Administration >PersonalInformation >Disability >Disabilities BRA >Disabilities BRA

• Establishment Table Brazil (ESTAB_TBL_BRA)

Set Up HCM >Product Related >WorkforceAdministration >Establishment BRA >Additional Info - Brazil

• Absence Take and Reason (GPBR_ABS_TAKE_REA)

Set Up HCM >Product Related >Global Payroll & AbsenceMgmt >eSocial BRA >Legal Code Setup >Absence Take andReason

• Absence Event Entry - Brazil (GPBR_ABSENCE_ENTRY)

Global Payroll & Absence Mgmt >Payee Data >MaintainAbsences >Absence Event BRA

• Country Take (GP_ABS_BAL_SS_DEF)

Set Up HCM >Product Related >Global Payroll & AbsenceMgmt >Absence Management >Country Take >Absences

• Absence Entitlements (GP_ABS_ENTL)

Set Up HCM >Product Related >Global Payroll &Absence Mgmt >Elements >Absence Elements >AbsenceEntitlements >Absence Entitlement Name

• Pay Groups (GP_PYGRP)

Set Up HCM >Product Related >Global Payroll & AbsenceMgmt >Framework >Organizational >Pay Groups >Pay GroupsName

• Vacation Parameters BRA (GPBR_VACN_PARM)

Set Up HCM >Product Related >Global Payroll & AbsenceMgmt >Framework >Organizational >Vacation ParametersBRA >Vacation Parameters BRA

262 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 14 Working With eSocial

Event Layout - Report Name EventType

Components to Collect Event Data

• eSocial Parameters BRA (GPBR_ESOCIAL_PARAM)

Set Up HCM >Install >Product and Country Specific >eSocialParameters BRA >eSocial Parameters BRA

• Establishment Address (ESTABLISHMENT_DATA)

Set Up HCM >FoundationTables >Organization >Establishment >Establishment Address

S-2240 - Environmental WorkingConditions

Non-periodic

• Worker Conditions BRA (WORKER_ENVIRON_BRA)

Workforce Monitoring >Health and Safety >Define HazardousEnvironments >Worker Conditions BRA

• Job Data (JOB_DATA)

Workforce Administration >Job Information >Job Data >WorkLocation

• Define Payee Parameters BRA (GPBR_PAYEE_PARM)

Global Payroll & Absence Mgmt >Payee Data >Define PayeeParameters BRA >Payee Parameters

• Hazard Agent Codes BRA (HAZ_AGENT_TBL_BRA)

Set Up HCM >Product Related >Workforce Monitoring >Healthand Safety >Hazard Agent Codes BRA

• Work Hazards BRA (HAZARD_TBL_BRA)

Workforce Monitoring >Health and Safety >Define HazardousEnvironments >Work Hazards BRA

• Protection Equipment BRA (PROT_EQUIPMENT_BRA)

Set Up HCM >Product Related >Workforce Monitoring >Healthand Safety >Protection Equipment BRA

• Environmental Responsible BRA (HA_RESPONSIBLE_BRA)

Set Up HCM >Product Related >Workforce Monitoring >Healthand Safety >Environmental Responsible BRA

• Physician data for Brazil (HS_PHYSICIAN_BRA)

Set Up HCM >Product Related >Workforce Monitoring >Healthand Safety >Physician BRA

Copyright © 1988, 2022, Oracle and/or its affiliates. 263

Working With eSocial Chapter 14

Event Layout - Report Name EventType

Components to Collect Event Data

S-2250 - Termination PreviousNotification

Non-periodic

Important! This eSocial report is no longer required and therefore has beeninactivated in the S-1.0 version.

• Personal Data (PERSONAL_DATA)

Workforce Administration >Personal Information >Modify aPerson

• Define Payee Parameters BRA (GPBR_PAYEE_PARM)

Global Payroll & Absence Mgmt >Payee Data >Define PayeeParameters BRA >Termination Parameters

• Additional Information BRA (ADDL_INFO_BRA)

Workforce Administration >Job Information >AdditionalInformation BRA

S-2298 - Employee Reinstatement Non-periodic

• Personal Data (PERSONAL_DATA)

Workforce Administration >PersonalInformation >Biographical >Update Person Detail >BiographicalDetails

• Additional Information BRA (ADDL_INFO_BRA)

Workforce Administration >Job Information >AdditionalInformation BRA

264 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 14 Working With eSocial

Event Layout - Report Name EventType

Components to Collect Event Data

S-2299 - Termination Termination • Job Data (JOB_DATA)

• Workforce Administration >Job Information >Job Data (allpages except Salary Plan)

• Workforce Administration >Job Information >Job Data. Clickthe Employee Data link.

• Personal Data (PERSONAL_DATA)

Workforce Administration >Personal Information >Modify aPerson

• Payee Parameters - Brazil (GPBR_PAYEE_PARM)

Global Payroll & Absence Mgmt >Payee Data >Define PayeeParameters BRA >Termination Parameters

• Additional Information BRA (ADDL_INFO_BRA)

Workforce Administration >Job Information >AdditionalInformation BRA

• eSocial Action and Reason (GPBR_ESOC_ACT_REA)

Set Up HCM >Product Related >Global Payroll & AbsenceMgmt >eSocial BRA >Legal Code Setup >eSocial Action andReason >Hire Action and Reason

• Labor Regime (GPBR_LABOR_REGIME)

Set Up HCM >Product Related >Global Payroll & AbsenceMgmt >eSocial BRA >Legal Code Setup >Labor Regime

• Establishment Table Brazil (ESTAB_TBL_BRA)

Set Up HCM >Product Related >WorkforceAdministration >Establishment BRA >Additional Info - Brazil

Copyright © 1988, 2022, Oracle and/or its affiliates. 265

Working With eSocial Chapter 14

Event Layout - Report Name EventType

Components to Collect Event Data

S-2300 - Workers who have noemployment relationship – Begin

Non-periodic

• Additional Information BRA (ADDL_INFO_BRA)

• Workforce Administration >Job Information >AdditionalInformation BRA >Additional Information BRA

• Workforce Administration >Job Information >AdditionalInformation BRA >Additional Contract Data

• Job Data (JOB_DATA)

• Workforce Administration >Job Information >Job Data (allpages except Salary Plan)

• Workforce Administration >Job Information >Job Data. Clickthe Employment Data link.

• Personal Data (PERSONAL_DATA)

Workforce Administration >PersonalInformation >Biographical >Update Person Detail (all pages)

• Additional Names (NAMES_OTHER)

Workforce Administration >PersonalInformation >Biographical >Additional Names

• Personal Information BRA (PERSONAL_INFO_BRA)

Workforce Administration >PersonalInformation >Biographical >Personal Information BRA >PersonalInformation BRA

• Establishment BRA (ESTAB_TBL_BRA)

• Set Up HCM >Product Related >WorkforceAdministration >Establishment BRA >Establishment Address

• Set Up HCM >Product Related >WorkforceAdministration >Establishment BRA >Additional Info - Brazil

• eSocial Action and Reason (GPBR_ESOC_ACT_REA)

Set Up HCM >Product Related >Global Payroll & AbsenceMgmt >eSocial BRA >Legal Code Setup >eSocial Action andReason >Hire Action and Reason

• Labor Regime (GPBR_LABOR_REGIME)

Set Up HCM >Product Related >Global Payroll & AbsenceMgmt >eSocial BRA >Legal Code Setup >Labor Regime

• Ethnic Groups (GPBR_ETHNIC_GROUP)

Set Up HCM >Product Related >Global Payroll & AbsenceMgmt >eSocial BRA >Legal Code Setup >Ethnic Groups

• Education Level (GPBR_EDUCATIO_CODE)

266 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 14 Working With eSocial

Event Layout - Report Name EventType

Components to Collect Event Data

Set Up HCM >Product Related >Global Payroll & AbsenceMgmt >eSocial BRA >Legal Code Setup >Education Level

• Marital Status (GPBR_MARITAL_CODE)

Set Up HCM >Product Related >Global Payroll & AbsenceMgmt >eSocial BRA >Legal Code Setup >Marital Status

• Define Payee Parameters BRA (GPBR_PAYEE_PARM)

Global Payroll & Absence Mgmt >Payee Data >Define PayeeParameters BRA

• Unions (UNION_TABLE)

Set Up HCM >Product Related >WorkforceAdministration >Labor Administration >Unions >Unions >UnionLocation

• Disabilities BRA (DISABILITY_BRA)

Workforce Administration >PersonalInformation >Disability >Disabilities BRA >Disabilities BRA

• Dependent Information (DEPEND_BENEF)

Workforce Administration >Personal Information >PersonalRelationships >Dependent Information (all pages except Address)

• Assign Work Schedule (GP_SCH_ASSIGN)

Global Payroll & Absence Mgmt >Payee Data >CreateOverrides >Assign Work Schedule >Assign Work Schedule

Copyright © 1988, 2022, Oracle and/or its affiliates. 267

Working With eSocial Chapter 14

Event Layout - Report Name EventType

Components to Collect Event Data

S-2306 - Workers who haveno employment relationship -Changes

Non-periodic

• Job Data (JOB_DATA)

• Workforce Administration >Job Information >Job Data (allpages except Salary Plan)

• Workforce Administration >Job Information >Job Data. Clickthe Employee Data link.

• Personal Data (PERSONAL_DATA)

Workforce Administration >Personal Information >Modify aPerson (all pages)

• Additional Information BRA (ADDL_INFO_BRA)

• Workforce Administration >Job Information >AdditionalInformation BRA >Additional Information BRA

• Workforce Administration >Job Information >AdditionalInformation BRA >Additional Contract Data

• Labor Regime (GPBR_LABOR_REGIME)

Set Up HCM >Product Related >Global Payroll & AbsenceMgmt >eSocial BRA >Legal Code Setup >Labor Regime

• Define Payee Parameters BRA (GPBR_PAYEE_PARM)

Global Payroll & Absence Mgmt >Payee Data >Define PayeeParameters BRA

• Unions (UNION_TABLE)

Set Up HCM >Product Related >WorkforceAdministration >Labor Administration >Unions >Unions >UnionLocation

• Establishment Table Brazil (ESTAB_TBL_BRA)

Set Up HCM >Product Related >WorkforceAdministration >Establishment BRA >Additional Info - Brazil

• Pay Groups (GP_PYGRP)

Set Up HCM >Product Related >Global Payroll & AbsenceMgmt >Framework >Organizational >Pay Groups >Pay GroupsName

• Schedule Shifts (SCH_DEFINITION)

Set Up HCM >Product Related >Global Payroll & AbsenceMgmt >Schedules >Definitions >Schedule Shifts

• Shifts (SCH_SHIFT)

• Set Up HCM >Product Related >Time and Labor >ScheduleConfigurations >Schedule Shifts >Shift

268 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 14 Working With eSocial

Event Layout - Report Name EventType

Components to Collect Event Data

• Set Up HCM >Product Related >Global Payroll & AbsenceMgmt >Schedules >Schedule Shifts >Shift

• Shift BRA (SCH_SHIFT_BRA)

Set Up HCM >Product Related >Time andLabor >Schedules >Shifts BRA >Shift

• Schedule Definition (SCH_DEFINITION)

Set Up HCM > Product Related > Global Payroll & AbsenceMgmt > Schedules > Definitions > Definition

S-2399 - Workers who have noemployment relationship - End

Termination • Job Data (JOB_DATA)

• Workforce Administration >Job Information >Job Data (allpages except Salary Plan)

• Workforce Administration >Job Information >Job Data. Clickthe Employee Data link.

• Personal Data (PERSONAL_DATA)

Workforce Administration >Personal Information >Modify aPerson

• Payee Parameters - Brazil (GPBR_PAYEE_PARM)

Global Payroll & Absence Mgmt >Payee Data >Define PayeeParameters BRA >Termination Parameters

• Additional Information BRA (ADDL_INFO_BRA)

Workforce Administration >Job Information >AdditionalInformation BRA

• eSocial Action and Reason (GPBR_ESOC_ACT_REA)

Set Up HCM >Product Related >Global Payroll & AbsenceMgmt >eSocial BRA >Legal Code Setup >eSocial Action andReason >Hire Action and Reason

• Labor Regime (GPBR_LABOR_REGIME)

Set Up HCM >Product Related >Global Payroll & AbsenceMgmt >eSocial BRA >Legal Code Setup >Labor Regime

• Establishment Table Brazil (ESTAB_TBL_BRA)

Set Up HCM >Product Related >WorkforceAdministration >Establishment BRA >Additional Info - Brazil

Copyright © 1988, 2022, Oracle and/or its affiliates. 269

Working With eSocial Chapter 14

Event Layout - Report Name EventType

Components to Collect Event Data

S-3000 - Event Exclusion Non-periodic

• Additional Information BRA (ADDL_INFO_BRA)

Workforce Administration >Job Information >AdditionalInformation BRA

Change the eSocial register number of an employee.

• Work Location (JOB_DATA1)

Workforce Administration >Job Information >Job Data >WorkLocation

Change the company of an employee.

• Job Information (JOB_DATA_JOBCODE)

Workforce Administration >Job Information >Job Data >JobInformation

Change the employee class of an employee.

Understanding Pre-Hiring EventsCompanies are required to report hiring transactions to eSocial one day before new hires start working.In some situations, companies may not be able to collect all the information needed to submit employeesinitial loading and hiring events (S-2200) in time. As an alternative, they can submit pre-hiring events(S-2190)—a simplified version of hiring events that requires little information for reporting.

Companies run the GPBR_ES_P_HIRE application engine (AE) process for pre-hiring events. It takesthe information from the run control page, inserts data rows to driver and cross-reference tables, callsthe mapping process that cleans up data and populates staging tables, and calls the XML file generationprocess that creates XML files for eSocial submission all in one continuous process. Unlike the AEprocesses for other events, GPBR_ES_P_HIRE does not provide options to prepare data, reprocess, orcreate XML files separately.

If, after the submission of a pre-hiring event, the hiring of a worker cannot be completed, the companymust inform eSocial by sending an exclusion event (S-3000) for the pre-hiring event no later than the endof the worker’s estimated hire date.

Before an S-2200 event is generated, the system checks if a pre-hiring event already exists for thesame employee ID. If such event exists, the system validates the data (if pre-hiring event is submittedsuccessfully), submits the S-2200 event and updates the status of its pre-hiring record accordingly.

See eSocial Pre-Hiring Event Page and eSocial Pre-Hiring Monitor Page

Identifying Events

This topic discusses run control pages that are used in eSocial reporting.

See Also Understanding eSocial.

270 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 14 Working With eSocial

Pages Used to Identify Events

Page Name Definition Name Usage

eSocial Basic Initial Page GPBR_ESOC_ILB Perform an initial load of basic table andemployer data for eSocial reporting.

eSocial Employee Initial Page GPBR_ESOC_ILE Perform an initial load of employee (active and terminated) data for eSocialreporting.

eSocial Basic Table Event Page GPBR_ESOC_MBT Process and load basic table data changesfor eSocial reporting.

eSocial Non Periodic Event Page GPBR_ESOC_MNP Process and load non-periodic datachanges for eSocial reporting.

eSocial Pre-Hiring Event Page GPBR_ES_P_HIRE Process and load employee’s pre-hiringdata for eSocial reporting.

eSocial Pre-Hiring Monitor Page GPBR_ES_PH_MONITOR View the list of generated pre-hiringevents.

eSocial Pre-Hiring Monitor - DetailsPage

GPBR_ES_HIRE_DET View event details.

eSocial Termination Events Page GPBR_ESOC_TER Process and load terminations for eSocialreporting.

eSocial Processed Calendars - eSocialTermination Events Page

GPBR_ES_IDCALT Review the list of identified calendars fortermination event processing.

eSocial Processed Employees - eSocialTermination Events Page

GPBR_ES_IDTER_EMP Review the payroll status andtermination event status of payees for theselected calendar.

eSocial Payroll Tax Exempt BRA Page GPBR_ESOC_TAX_RE Enter payroll tax exemption informationfor companies.

eSocial Employer Union Contrib Page GPBR_ES_EUC Enter union contribution information forcompanies.

eSocial Payroll Events Page GPBR_ESOC_PER Process and load payroll events.

eSocial Processed Calendars - eSocialPayroll Events Page

GPBR_ES_IDCAL Review the list of identified calendars forS-1200 and S-1210 event processing.

Copyright © 1988, 2022, Oracle and/or its affiliates. 271

Working With eSocial Chapter 14

Page Name Definition Name Usage

eSocial Processed Employees - eSocialPayroll Events Page

GPBR_ES_IDEMP Review the payroll status and payrollevent status of payees for the selectedcalendar.

eSocial Period Controls Page GPBR_ESOC_PER_CTRL Close or reopen assessment periods forprocessing periodic events.

Company Without Movement Page GPBR_ESOC_NOMOV Review, by company, a list of periodsduring which no periodic events arereported to the eSocial system.

eSocial Hire Exclusion Page GPBR_RC_EVT_EXCL Generate driver information of exclusionevents for hiring events.

eSocial Basic Initial PageUse the eSocial Basic Initial page (GPBR_ESOC_ILB) to perform an initial load of basic table andemployer data for eSocial reporting.

Navigation:

Global Payroll & Absence Mgmt >Absence and Payroll Processing >Reports >eSocialBRA >eSocial Basic Initial

272 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 14 Working With eSocial

This example illustrates the fields and controls on the eSocial Basic Initial page.

Run the eSocial Basic Tables Initial process (GPBR_ES_ILB) to perform an initial load of basic table andemployer data for eSocial records. By default, events that are marked as initial events on the Events Setuppage appear as selected in this section.

Field or Control Description

Limit Date This field is not used in basic table initial loading events.

All Companies or Company Click to include all companies that are enabled for eSocialreporting on the Company Parameters Page in the initial dataloading process.

Alternatively, you can add one or more companies manuallyby inserting rows to this page. Only eSocial-enabledcompanies are available for selection.

Adhere to eSocial Displays the date the company is required to report data toeSocial. This date is entered on the Company Parameters Page.

This field is not displayed if the All Companies field isselected. Date validation is performed when events aregenerated.

Copyright © 1988, 2022, Oracle and/or its affiliates. 273

Working With eSocial Chapter 14

Events

This section lists all the initial load events for basic tables that are enabled for eSocial reporting for thespecified company. These events are categorized as basic table events and marked as Initial Events (on theEvents Setup Page).

If applicable, you can clear the selection of any enabled events and remove them from the initial loadingprocess. Doing so means that you opt to not use PeopleSoft HCM Global Payroll for Brazil to processthose removed eSocial events.

Processing Phases and Options

For more information about processing options that are listed in this section, see Processing Phases andOptions.

eSocial Employee Initial PageUse the eSocial Employee Initial page (GPBR_ESOC_ILE) to perform an initial load of employee (activeand terminated) data for eSocial reporting.

Navigation:

Global Payroll & Absence Mgmt >Absence and Payroll Processing > Reports >eSocialBRA >eSocial Employee Initial

This example illustrates the fields and controls on the eSocial Employee Initial page (1 of 2).

274 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 14 Working With eSocial

This example illustrates the fields and controls on the eSocial Employee Initial page (2 of 2).

Run the eSocial Employee Initial process (GPBR_ES_ILE) to perform an initial load of employee datafor eSocial records. By default, S-2200 and S-2300 events appear as selected in this section, if they areactivated.

At initial implementation, customers have the option to load active employees as well as terminatedemployees depending on their business needs (for example, bonus payments for terminated employeesthrough complementary termination).

Note: Run the initial load process for employees after the initial load process for basic tables hascompleted successfully.

Field or Control Description

Limit Date This field is not used in employee initial loading events.

All Companies or Company Click to include all companies that are enabled for eSocialreporting on the Company Parameters Page in the initial dataloading process.

Alternatively, you can add one or more companies manuallyby inserting rows to this page. Only eSocial-enabledcompanies are available for selection.

Non Periodic Go Live Date Displays the go live date for non-periodic events that isspecified for the selected company. This date is entered on theCompany Parameters Page.

This field is not displayed if the All Companies field isselected. Date validation is performed when events aregenerated.

Copyright © 1988, 2022, Oracle and/or its affiliates. 275

Working With eSocial Chapter 14

Field or Control Description

Health/Safety Go Live Date Displays the go live date for health and safety events (forexample, S-2220 and S-2240) that is specified for the selectedcompany. This date is entered on the Company ParametersPage.

This field is not displayed if the All Companies field isselected. Date validation is performed when events aregenerated.

All Establishment or Establishment ID Select to include all establishments of the specified companyfor eSocial reporting. When selected, the EstablishmentSelection section becomes invisible.

Alternatively, you can add establishments manually byinserting rows in the Establishment Selection section.

Events

This section lists all the initial load events for employees that are enabled for eSocial reporting for thespecified company or all companies. By default, S-2200 and S-2300 events appear as selected and theS-2240 event deselected in this section. The S-2200 and S-2300 events are the prerequisites of the S-2240event, and are deselected automatically when the S-2240 event is selected.

If applicable, you can clear the selection of enabled events and remove them from the initial loadingprocess. Doing so means that you opt to not use PeopleSoft HCM Global Payroll for Brazil to processthose removed eSocial events.

Establishment Selection

Use this section to manually add company establishments to be included in eSocial reporting.

Processing Phases and Options

For more information about processing options that are listed in this section, see Processing Phases andOptions.

Employees

Use this section to specify the group of employees for which the employee initial loading events aregenerated.

Field or Control Description

Active and As of Select to generate specified events only for active employees.

When selected, specify the Active as of date. Employees whoremain active on this date will be included in the employeeinitial loading events.

276 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 14 Working With eSocial

Field or Control Description

Inactive, From and To Select to generate specified events only for inactiveemployees (terminated employees).

When selected, specify the termination period. Employeeswho were terminated during this period will be included in theemployee initial loading events.

eSocial Basic Table Event PageUse the eSocial Basic Table Event page (GPBR_ESOC_MBT) to process and load basic table datachanges for eSocial reporting.

Navigation:

Global Payroll & Absence Mgmt >Absence and Payroll Processing >Reports >eSocialBRA >eSocial Basic Table Event

Copyright © 1988, 2022, Oracle and/or its affiliates. 277

Working With eSocial Chapter 14

This example illustrates the fields and controls on the eSocial Basic Table Event page.

Run the eSocial Basic Tables (GPBR_ES_MBT) process to load basic table and employer data changesfor eSocial reporting.

Field or Control Description

Limit Date Enter the date that is used to identify which data rows from theDriver record are to be processed. Driver record rows with aneffective date later than this date will not be processed.

By default, the current date is populated.

All Companies Select to run the XML file creation process for all companiesthat are enabled for eSocial reporting.

278 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 14 Working With eSocial

Field or Control Description

Company Select a company for which the process runs, if not all activecompanies are to be processed.

You can add more companies to the process by inserting newrows.

Events

This section lists all the events that are categorized as Basic Table on the Events Setup page. Select theones to be processed.

Processing Phases and Options

For more information about processing options that are listed in this section, see Processing Phases andOptions.

Related LinksSubmitting XML Outputs and Requesting Results

eSocial Non Periodic Event PageUse the eSocial Non Periodic Event page (GPBR_ESOC_MNP) to process and load non-periodic datachanges for eSocial reporting.

Navigation:

Global Payroll & Absence Mgmt >Absence and Payroll Processing >Reports >eSocialBRA >eSocial Non Periodic Event

Copyright © 1988, 2022, Oracle and/or its affiliates. 279

Working With eSocial Chapter 14

This example illustrates the fields and controls on the eSocial Non Periodic Event page (1 of 2).

280 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 14 Working With eSocial

This example illustrates the fields and controls on the eSocial Non Periodic Event page (2 of 2).

Run the eSocial Non Periodic Events (GPBR_ES_MNP) process to load non-periodic data for eSocialreporting.

Field or Control Description

Limit Date Enter the date that is used to identify which data rows from theDriver record are to be processed. Driver record rows with aneffective date later than this date will not be processed.

By default, the current date is populated.

All Companies Select to run the XML file creation process for all companiesthat are enabled for eSocial reporting.

Company Select a company for which the process runs, if not all activecompanies are to be processed.

You can add more companies to the process by inserting newrows.

Copyright © 1988, 2022, Oracle and/or its affiliates. 281

Working With eSocial Chapter 14

Field or Control Description

Non Periodic Go Live Date Displays the go live date for non-periodic events that isspecified for the selected company. This date is entered on theCompany Parameters Page.

This field is not displayed if the All Companies field isselected. Date validation is performed when events aregenerated.

All Establishment Select to run the XML file creation process for allestablishments of the selected company.

Events

This section lists all the events that are categorized as Non Periodic on the Events Setup page. Select theones to be processed.

Establishment Selection

In this section, select one or more establishments for which the process runs, if not all establishments ofthe selected company are to be processed.

This section appears if the All Establishment field is not selected.

Processing Phases and Options

For more information about processing options that are listed in this section, see Processing Phases andOptions.

eSocial Pre-Hiring Event PageUse the eSocial Pre-Hiring Event page (GPBR_ES_P_HIRE) to process and load employee’s pre-hiringdata for eSocial reporting.

Navigation:

Global Payroll & Absence Mgmt >Absence and Payroll Processing > Reports >eSocialBRA >eSocial Pre-Hiring Event

282 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 14 Working With eSocial

This example illustrates the fields and controls on the Preliminary Info tab of the eSocial Pre-HiringEvent page (1 of 2).

This example illustrates the fields and controls on the Digital CTPS tab of the eSocial Pre-Hiring Eventpage (2 of 2).

Default Parameters

Field or Control Description

Company Select a company for the pre-hiring event. The selectedcompany becomes the default value that is populated in theEmployees section.

Hire Date Select the estimated hire date, which cannot be earlier than thecurrent date. The specified date becomes the default value thatis populated in the Employees section.

Employees - Preliminary Information

Information entered in this section is used by the GPBR_E_PHIRE application engine process to generatepre-hiring event XML files. All fields are required.

Copyright © 1988, 2022, Oracle and/or its affiliates. 283

Working With eSocial Chapter 14

Field or Control Description

Employee ID Select the employee or individual for which the pre-hiringevent is launched.

You can select from:

• Employees whose employee IDs are inactive with aneffective date less than or equal to the system date. Or

• Individuals whose person IDs do not have employmentrelationship in job data.

Note: You may enter the same ID more than once as long asthe ID is associated with different companies. However, youmay not enter the same ID for more than one run control ID.

Company Select the company for the selected individual. Companiesthat are enabled on the Company Parameters Page for eSocialreporting are available for selection.

Reg Region (regulatory region) Select the regulatory region to determine the setID for theEmpl Class field.

Empl Class (employee class) Select the applicable employee class for the employee.

The same list of values is also used on the Job Informationpage (JOB_DATA_JOBCODE).

Hire Date Select the estimated hire date for the selected individual. Thisdate is sent to eSocial as the hire date and it cannot be earlierthan the current date.

Employees - Digital FGTS

Field or Control Description

Business Unit Select the business unit to determine the setID for the JobCode field.

Job Code Select the job code used to populate the Brazilian OccupationCd field automatically.

Brazilian Occupation Cd (Brazilian occupation code) The system populates this field automatically when you selecta job code. This field value is required for eSocial.

284 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 14 Working With eSocial

Field or Control Description

Comp Rate and Contract Salary Type Enter the salary amount of the job, and the salary type of theamount, for example, Monthly, Weekly, Per Task.

Contract Type Select the type of employment contract for this hire.

Contract End Date Specify the end date of the employee’s contract. This fieldappears when the selected contract type is Determinate.

Related LinksUnderstanding Pre-Hiring EventsS-2190 - Pre-Hiring Event

eSocial Pre-Hiring Monitor PageUse the eSocial Pre-Hiring Monitor page (GPBR_ES_PH_MONITOR) to review statuses of the list ofgenerated pre-hiring events.

Navigation:

Global Payroll & Absence Mgmt >Absence and Payroll Processing > Reports >eSocialBRA >eSocial Pre-Hiring Monitor

This example illustrates the fields and controls on the eSocial Pre-Hiring Monitor page.

Copyright © 1988, 2022, Oracle and/or its affiliates. 285

Working With eSocial Chapter 14

This example illustrates the eSocial Pre-Hiring Monitor page where search results are displayed.

Use this page to search for and review the list of submitted pre-hiring events and event details. You canperform searches by dates, company, employee, and statuses. The search results help you monitoring thecurrent status of hiring-related events, and decide if additional ones need to be reported.

Search Criteria

Use this section to look up hiring-related events using at least one search criterion. Corresponding searchsections and fields (except searching by status) appear in the Select Filter Values section based on theselected search criteria.

Field or Control Description

Search Date By Select to look up events by:

Hire Date

Transaction Date

Then, enter a date range to search for events with hire ortransaction dates that fall between the specified date range.

286 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 14 Working With eSocial

Field or Control Description

Search Status By Select to look up events by status. Values are:

Await Exclusion: Select to search for S-2190 events withS-3000 events that are in the XML Create status.

Canceled: Select to search for events that are canceled.

Complete: Select to search for events that are completedsuccessfully.

Error: Select to search for events that encountered errors atany stage of the eSocial report process (for example, mappingprocess, XML file generation, or web service communication). Error codes are defined on the eSocial Error Catalog Page.

Hired: Select to search for S-2200 events that are associatedwith pre-hiring protocol numbers.

Hiring in Progress: Select to search for S-2190 events withS-2200 events that are in the XML Create status.

Pending Hiring: Select to search for S-2190 events withreceipt numbers and are associated with S-2200 events.

Wait for Return: Select to search for events (S-2190, S-2200and S-3000) that are awaiting protocol numbers to be returnedfrom the government.

Withdraw Hiring: Select to search for S-2200 events, whichreference S-2190 events, that have been excluded.

Withdraw Pre-Hiring: Select to search for S-2200 events thathave been sent as part of employee initial loading and havebeen excluded, and corresponding receipt numbers returnedfrom the government.

Search By Select to look up events by:

Company. Select one or more companies, which are enabled inthe Company Parameters Page.

Employees. Select one or more employee IDs that are eitherinactive, or do not have employment relationships in job data.

Select Filter Values

Use this section to enter search values based on the selected search criteria, which can be date range,companies, and employees

Copyright © 1988, 2022, Oracle and/or its affiliates. 287

Working With eSocial Chapter 14

Search Results - Events

This section displays the search result.

Field or Control Description

Select Select one or more events for an action (already selected) to beperformed.

Note: Specify an action before selecting any event. Thesystem refreshes the search result and displays events that areeligible for the selected action.

Type Indicates the type of the event, Original or Rectifier.

Empl Class Displays the employee class of the employee.

eSocial Reg. Number (eSocial register number) Displays the eSocial register number generated for theemployee.

Details Click to view additional details of the selected event on theSearch Results - Details page (GPBR_ES_HIRE_DET).

288 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 14 Working With eSocial

Field or Control Description

Action and Process Select an action to perform. Values are:

Cancel: Select to set the statuses of selected events toCanceled. Cancelled events can be reprocessed.

Exclude: Select to generate S-3000 events for selected S-2190events that are in the Pending Hiring status.

Rectify: Select generate rectification drivers for the selectedevents. Only events with a receipt number can be rectified. When an event is selected for the Rectify action, you canupdate the employee class and hire date as needed. Accordingto the S-1.0 version requirement, the information (for example,CPF, birthdate, hire date, register number, and employee class)sent to the Government by the S-2190 event and its associatedS-2200 or S-2300 event must match. If the information (employee class and hire date) was sent incorrectly using theS-2190 event, the event needs to be rectified before sendingthe S-2200 or S-2300 event. If the CPF or birthdate was sentto the Government using the S-2190 event and the informationwas incorrect, you need to first update it from the source (thePersonal Data component) and rectify the S-2190 event beforesending the S-2200 or S-2300 event.

Reprocess: Select to run the pre-hiring AE process again onselected events. This action is available to events that haveencountered error.

The Process button appears when an action is selected. Clickto process selected events with the selected action.

Related LinksUnderstanding Pre-Hiring Events

eSocial Pre-Hiring Monitor - Details PageUse the eSocial Pre-Hiring Monitor - Details page (GPBR_ES_HIRE_DET) to view event details.

Navigation:

Click the Details link of an event from the search result on the eSocial Pre-Hiring Monitor page.

Copyright © 1988, 2022, Oracle and/or its affiliates. 289

Working With eSocial Chapter 14

This example illustrates the fields and controls on the eSocial Pre-hiring Monitor - Details page.

This page displays additional information about the event being viewed, including information aboutrelated events. For example, if you click to view the details of a hiring event for a person, the informationfor the associated pre-hiring event (if available) is also available for viewing.

Field or Control Description

Date of action Displays the date when the event was processed.

Protocol Displays the associated protocol number that is returned fromeSocial.

Receipt Num (receipt number) Displays the associated receipt number that is returned fromeSocial.

Description Displays error description if applicable, for example:

Event S-2190 already exist for this Emplid

Other Company indicated in event S-2200

Other Hiring Date indicate in event S-2200

Other Labor Category indicate in event S-2300

Return to Monitor Page Click to go back to the eSocial Pre-Hiring Monitor page.

eSocial Termination Events PageUse the eSocial Termination Events page (GPBR_ESOC_TER) to process and load terminations foreSocial reporting.

Navigation:

Global Payroll & Absence Mgmt >Termination Processing >eSocial Termination Events BRA

290 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 14 Working With eSocial

This example illustrates the fields and controls on the eSocial Termination Events page.

Run the GPBR_ES_TER process to load employee and non-employee terminations for eSocial reporting.

The process takes in all terminations (with and without payment) that occurred in the specified timeperiod for selected companies, and have not yet been processed for eSocial reporting.

For terminations with payment, the process identifies all applicable calendars automatically based on theselection criteria. These calendars are listed on the eSocial Processed Calendars - eSocial TerminationEvents Page for reference.

Selection Criteria

Field or Control Description

Competency Year and Competency Month Specify the time period that is being assessed for terminationreporting.

Copyright © 1988, 2022, Oracle and/or its affiliates. 291

Working With eSocial Chapter 14

Field or Control Description

Selection Criteria Select to process terminations for all companies, or a selectionof companies that are selected in the Companies section thatappears.

Events

Field or Control Description

S-2299 Termination and S-2399 Workers who have noemployment relationship – End

Displays the two system-delivered termination events (S-2299and S-2399) that are used for reporting employee and non-employee terminations to the government’s eSocial system. They are preselected in the process and cannot be deselected.

S-3000 Termination and S-3000 Terminate Non Employee If applicable, select to prepare and generate exclusion eventsfor terminations (employee, non-employee, or both) that matchthe specified search criteria.

Submit a termination exclusion event if your wish to removefrom the government’s eSocial system termination informationthat was submitted by mistake.

Search Criteria Click to search for all finalized termination calendarsfor employees that were terminated during the specifiedcompetency period for the selected companies.

Employees and calendars that are identified for terminationare available for viewing by clicking the View Payroll EventStatus link that appears.

Processing Phases and Options

For more information about processing options that are listed in this section, see Processing Phases andOptions.

Field or Control Description

View Payroll Event Status Click, if available, to access the eSocial Processed Calendars- eSocial Termination Events page to review a list of payrollcalendars that have been identified for S-2299 and S-2399events.

Related LinksS-2299 - Termination

292 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 14 Working With eSocial

S-2399 - Workers who have no employment relationship - End

eSocial Processed Calendars - eSocial Termination Events PageUse the eSocial Processed Calendars - eSocial Termination Events page (GPBR_ES_IDCALT) to reviewthe list of identified calendars for termination event processing.

Navigation:

Click the View Payroll Events Status link on the eSocial Termination Events page.

This example illustrates the fields and controls on the eSocial Processed Calendars - eSocial TerminationEvents page.

Use this page to review the list of finalized payroll calendars that are identified based on the specifiedcompetency period, active run types in that period and specified companies. Both regular and off-cyclecalendars are included. Calendar information is used in the mapping process for termination events.

Field or Control Description

Select with Matching Criteria Click to refine the search result based on the selected searchcriteria.

Details Click to access the eSocial Processed Employees - eSocialTermination Events page to review the termination eventstatus (S-2299 and S-2399) for each payee included in theselected competency period and calendar entry.

eSocial Processed Employees - eSocial Termination Events PageUse the eSocial Processed Employees - eSocial Termination Events page (GPBR_ES_IDTER_EMP) toreview the payroll status and termination event status of payees for the selected calendar.

Navigation:

Copyright © 1988, 2022, Oracle and/or its affiliates. 293

Working With eSocial Chapter 14

Click the Details link of a calendar entry on the eSocial Processed Calendars - eSocial TerminationEvents page.

This example illustrates the fields and controls on the eSocial Processed Employees - eSocial TerminationEvents page.

Use this page to review the list of payees that are included in the specified competency period, company,pay group, calendar group, calendar, and run type. Specify additional selection criteria to refine the searchresult if needed. As a payroll clerk, you can review the current statuses of payees’ termination events,compare information on this page with your payroll reports, and verify that the information looks good.

Field or Control Description

S-2299 Status or S-2399 Status Displays the current status of the termination event (S-2299 orS-2399) for the corresponding payee.

Values are:

Awaiting Return Government: Indicates that the event isalready submitted and is awaiting a receipt number from thegovernment.

Error Event: Indicates that an error was found in processing.

Finalized: Indicates that a receipt number for the payroll eventhas been given from the government.

Identified: Indicates that the event is currently in the mappingprocess, or it is in the RDY status (the event has beenidentified, but no data preparation is done on it yet).

eSocial Payroll Tax Exempt BRA PageUse the eSocial Payroll Tax Exempt BRA page (GPBR_ESOC_TAX_RE) to enter payroll tax exemptioninformation for companies.

Navigation:

Global Payroll & Absence Mgmt >Social Security / Insurance >eSocial Payroll Tax Exempt BRA

294 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 14 Working With eSocial

This example illustrates the fields and controls on the eSocial Payroll Tax Exempt BRA page.

Use this page to report company’s payroll tax exemption to the government. This page is applicable tocompanies that have Partially Replaced selected in the Other Sectors field on the "Additional Info -Brazil Page" (PeopleSoft Human Resources Administer Workforce) for their establishment headquarters.Companies need to provide this information for S-1280 (Complementary Information to Periodic Events)event reporting.

Note: A headquarter must already be defined for a company (only one for each company) in order forpayroll tax exemption to be reported for that company. If the headquarter is missing, it will be logged, andthe tax exemption information that is specified on this page will not be reported to the government.

Field or Control Description

Period Type Specify whether this payroll tax exemption is monthly orannually in nature.

If payroll tax exemption entries are entered both monthlyand annually for the same company and competency period, two S-1280 events will be created after validation checks arepassed.

If the selected period type is Annual, an S-1280 event will becreated regardless of whether the selected month is December.

% Reduction Enter a positive non-zero tax reduction percentage number. This is required if the Other Sectors field value is setas Partially Replaced on the "Additional Info - BrazilPage" (PeopleSoft Human Resources Administer Workforce)for the establishment headquarter of the selected company.

Related LinkseSocial Payroll Events PageS-1280 - Complementary Information to Periodic Events

Copyright © 1988, 2022, Oracle and/or its affiliates. 295

Working With eSocial Chapter 14

eSocial Employer Union Contrib PageUse the eSocial Employer Union Contrib page (GPBR_ES_EUC) to enter union contribution informationfor companies.

Navigation:

Global Payroll & Absence Mgmt >Absence and Payroll Processing >Reports >eSocialBRA >eSocial Employer Union Contrib

This example illustrates the fields and controls on the eSocial Employer Union Contrib page.

Note: This page is not used.

Use this page to report company’s union contribution to the government.

Field or Control Description

Period Type Select if the union contribution is a compulsory annualpayment or an optional monthly payment.

Union Details

Enter all union contributions that were made for the specified company, competency period and periodtype.

296 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 14 Working With eSocial

Field or Control Description

Union Code Select an applicable union code.

Union codes are set up using the Unions component.

See Also "Setting Up Unions" (PeopleSoft Human ResourcesManage Labor Administration)

Contribution Type Select the type of the union contribution to be reported. Valuesare:

Assistance. The period type for this contribution type isMonthly.

Associative. The period type for this contribution type isMonthly.

Compulsory. The period type for this contribution type isAnnually.

Confederative. The period type for this contribution type isMonthly.

Amount Enter positive non-zero union contribution amount.

Related LinkseSocial Payroll Events Page

eSocial Payroll Events PageUse the eSocial Payroll Events page (GPBR_ESOC_PER) to process payroll events for eSocial reporting.

Navigation:

Global Payroll & Absence Mgmt >Absence and Payroll Processing >Reports >eSocialBRA >eSocial Payroll Events

Copyright © 1988, 2022, Oracle and/or its affiliates. 297

Working With eSocial Chapter 14

This example illustrates the fields and controls on the eSocial Payroll Events page.

Run the GPBR_ES_PER process to load payroll data for eSocial reporting.

Selection Criteria

Field or Control Description

Competency Year and Competency Month Specify the period that is being assessed for eSocial reporting.

This period is considered valid if it is equal to or after theAdhere to eSocial date (its month and year) that is specifiedfor each company included in this payroll event process. Ifthe period is invalid, the process stops and an error “Periodselected in Run Control page isn't valid” is logged.

If an S-1299 event (Closing Periodic event) exists in thesystem for the same period and company that is specifiedon this page, and the event is not cancelled or excluded, thepayroll event process stops and an error “Event S-1299 createdfor this Company in this Period” is logged. However, if anS-1298 event (Reopening Periodic event) also exists for thesame period and company, and is associated with a receiptnumber, which voids the S-1299 event, the payroll eventprocess continues.

298 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 14 Working With eSocial

Field or Control Description

Selection Criteria Select to process payroll events for:

Note: Companies must be activated on the CompanyParameters Page to support payroll event reporting in eSocial.

All Companies

Company: A list of companies that are selected in theCompanies section.

Employee: A list of employees that are selected in theEmployee Selection section.

Period Type Select:

Annual to generate the selected payroll events for the specifiedyear.

Month to generate the selected payroll events for the specifiedyear and month.

This field appears if the selected competency month is 12 -December.

Company Specify a company of which employees can be picked for theselected payroll events.

This field appears if the Selection Criteria field is set toEmployee.

Companies

This section appears if the Selection Criteria field is set to Company. Select a list of companies for whichselected events are generated.

Employee Selection

This section appears if the Selection Criteria field is set to Employee and a company is specified. Select alist of company employees for which selected events are generated.

Events

This section displays these payroll-specific events to be identified and processed. These events needto be activated at setup so that valid event reports can be generated for companies and submitted to thegovernment.

Copyright © 1988, 2022, Oracle and/or its affiliates. 299

Working With eSocial Chapter 14

Field or Control Description

S-1300 Employer Union Contribution Note: This field is not used. The S-1300 report is no longerrequired and therefore has been inactivated in the new version.

S-1280 Complementary Information to Periodic Events Select to process and generate S-1280 event reports in thepayroll event process.

See Also S-1280 - Complementary Information to PeriodicEvents

S-1200 Compensation Select to process and generate S-1200 event reports in thepayroll event process.

Both S-1200 or S-1210 events are processed together. Ifeither one of them is selected, the system selects the other oneautomatically and makes it unavailable for edits. Additionally, the system also selects the Identify Calendars option to beincluded in the run control process for these two events.

See Also S-1200 - Compensation

S-1210 Miscellaneous Payments Select to process and generate S-1210 event reports in thepayroll event process.

See Also S-1210 - Miscellaneous Payments

S-3000 Emp Union Contribution, S-3000 ComplementaryInfo., S-3000 Compensation and S-3000 Miscellaneous Pay

If applicable, select to prepare and generate exclusion eventsfor corresponding payroll events.

Submit a payroll exclusion event if you wish to remove fromthe government’s eSocial system corresponding payroll datathat was submitted by mistake.

Note: Do not use the S-3000 Emp Union Contribution field.The S-1300 report is no longer required and therefore has beeninactivated in the new version.

See Also S-3000 - Event Exclusion

Processing Phases and Options

For more information about processing options that are listed in this section, see Processing Phases andOptions.

300 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 14 Working With eSocial

Field or Control Description

View Payroll Event Status Click to access the eSocial Processed Calendars - eSocialPayroll Events page to review a list of payroll calendars thathave been identified for S-1200 and S-1210 events.

This link appears after the Identify Calendars processingoption is run successfully for S-1200 and S-1210 events.

Related LinkseSocial Processed Calendars - eSocial Payroll Events PageeSocial Processed Employees - eSocial Payroll Events Page

eSocial Processed Calendars - eSocial Payroll Events PageUse the eSocial Processed Calendars - eSocial Payroll Events page (GPBR_ES_IDCAL) to review the listof identified calendars for S-1200 and S-1210 event processing.

Navigation:

Click the View Payroll Events Status link on the eSocial Payroll Events page.

This example illustrates the fields and controls on the eSocial Processed Calendars - eSocial PayrollEvents page.

Use this page to review the list of finalized payroll calendars that are identified based on the specifiedcompetency period, active run types in that period and specified companies. Both regular and off-cyclecalendars are included. Calendar information is used in the mapping process for payroll events.

All calendars that are identified for the specified period must be finalized in order for the payroll processto proceed to subsequent phases.

Copyright © 1988, 2022, Oracle and/or its affiliates. 301

Working With eSocial Chapter 14

Field or Control Description

Select with Matching Criteria Click to refine the search result based on the selected searchcriteria.

Details Click to access the eSocial Processed Employees - eSocialPayroll Events page to review the payroll event status (S-1200 and S-1210) for each payee included in the selectedcompetency period and calendar entry.

eSocial Processed Employees - eSocial Payroll Events PageUse the eSocial Processed Employees - eSocial Payroll Events page (GPBR_ES_IDEMP) to review thepayroll status and payroll event status of payees for the selected calendar.

Navigation:

Click the Details link of a calendar entry on the eSocial Processed Calendars - eSocial Payroll Eventspage.

This example illustrates the fields and controls on the Processed Employees - eSocial Payroll Eventspage.

Use this page to review the list of payees that are included in the specified competency period, company,pay group, calendar group, calendar, and run type. Specify additional selection criteria to refine the searchresult if needed. As a payroll clerk, you can review the current statuses of payees’ payroll events, compareinformation on this page with your payroll reports, and verify that the information looks good.

Field or Control Description

Calculation Status If one or more of the listed calendars are not finalized, notriggers can be created and no payroll reporting will occur forthe corresponding company and competency period.

302 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 14 Working With eSocial

Field or Control Description

S-1200 Status or S-1210 Status Displays the current status of the Compensation event (S-1200) or the Miscellaneous Payments event (S-1210) forthe corresponding payee. These event statuses are updatedin these columns, as different processing options (IdentifyCalendars, Prepare Data, and so on) are selected to run indifferent payroll event process instances for the same searchcriteria.

Values are:

Awaiting Finalize Calendar: Indicates that the calculationstatus of the calendar that is associated with the payee is notFinalized (70) or Finalized with Bank (75).

Awaiting Return Government: Indicates that the event isalready submitted and is awaiting a receipt number from thegovernment.

Awaiting Return Termination: (For S-1210) Indicates thata Termination event is already submitted and is awaiting areceipt number from the government.

Error Event: Indicates that an error was found in processing.

Finalized: Indicates that a receipt number for the payroll eventhas been given from the government.

Identified: Indicates that the event is currently in the mappingprocess, or it is in the RDY status (the event has beenidentified, but no data preparation is done on it yet).

Next Competency: Indicates that either the Period ID or thepayment date of the payroll entry falls after the competencyperiod.

Not Eligible: Indicates that the event is not applicable in thecompetency period. Suppose that in the run type setup, the KRFERIAS run type is configured for the S-1210 event but notthe S-1200 event. In this case, the S-1200 status is set to NotEligible in the Employee Data section.

Previous Competency: Indicates that either the Period ID orpayment date of the payroll entry falls before the competencyperiod.

Termination in Progress: (For S-1200) Indicates that atermination event (S-2299 or S-2399) has been identified inthe competency period, and as a result, no S-1200 will begenerated.

eSocial Period Controls PageUse the eSocial Period Controls page (GPBR_ESOC_PER_CTRL) to close or reopen assessment periodsfor processing periodic events.

Navigation:

Copyright © 1988, 2022, Oracle and/or its affiliates. 303

Working With eSocial Chapter 14

Global Payroll & Absence Mgmt >Absence and Payroll Processing >Reports >eSocialBRA >eSocial Period Controls

This example illustrates the fields and controls on the eSocial Payroll Controls page.

Run the GPBR_ES_PERC process to close or reopen assessment periods for payroll and paymentinformation submission.

Selection Criteria

Field or Control Description

Event Code Select a periodic control event to, for example, reopen or closea period. As delivered, S-1298 and S-1299 are available forselection.

Competency Year and Competency Month Specify the period to be reopened or closed.

304 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 14 Working With eSocial

Field or Control Description

Selection Criteria Select to process payroll events for all companies, or aselection of companies that are selected in the Companiessection that appears.

Period Type Select the period type of the specified period to reopen. Values are Annual and Monthly. This field appears if theselected event is S-1298. For S-1299 events, the periodtype is generated automatically based on the existing periodtype selected for S-1200, S-1210, and S-1280 events of thespecified period.

Companies

This section appears if the Selection Criteria field is set to Company. Select a list of companies for whichthe selected event generates.

The system displays a list of eSocial-active companies in this section automatically, if the selected eventis S-1299 and the competency month is set to 01 - January.

Processing Phases and Options

For more information about processing options that are listed in this section, see Processing Phases andOptions.

Related LinksCompany Without Movement Page

Company Without Movement PageUse the Company Without Movement page (GPBR_ESOC_NOMOV) to review, by company, a list ofperiods during which no periodic events are reported to the eSocial system.

Navigation:

Global Payroll & Absence Mgmt >Absence and Payroll Processing >Reports >eSocialBRA >Company Without Movement

Copyright © 1988, 2022, Oracle and/or its affiliates. 305

Working With eSocial Chapter 14

This example illustrates the fields and controls on the Company Without Movement page.

A company that does not have any of S-1200, S-1210 or S-1280 reporting processing for any givencompetency period is considered a company without movement for that period.

Field or Control Description

Period Displays the competency period during which no S-1200, S-1210 and S-1280 events are processed for the selectedcompany.

Since Displays the competency period when the selected companybecomes a company without movement. Usually, this fielddisplays the same value that is shown in the Period field.

In the case where a company is no longer active with periodicreport processing, an S-1299 event is reported annually inJanuary of each year. If the corresponding period is January ofa year, this field displays the last competency period when thecompany became a company without movement.

Event Code Displays the S-1299 event.

Receipt Number Displays the receipt number of the corresponding S-1299event returned from the government.

Related LinkseSocial Period Controls Page

eSocial Hire Exclusion PageUse the eSocial Hire Exclusion page (GPBR_RC_EVT_EXCL) to generate driver information ofexclusion events for hiring events.

Navigation:

306 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 14 Working With eSocial

Set Up HCM >Product Related >Global Payroll & Absence Mgmt >eSocial BRA >eSocial HireExclusion

This example illustrates the fields and controls on the eSocial Hire Exclusion page.

Access to the eSocial Hire Exclusion page is restricted to administrator users with the GP AdministratorBRA role.

There are times when companies need to delete hiring events that were submitted to the government, forexample when corresponding hires fail to go through successfully. When that happens, the administratorcan run the eSocial Hire Exclusion process that generates S-3000 (Event Exclusion) events to removeunwanted hiring information of individuals from the government.

Specify the receipt number of a submitted hiring event (S-2200 for employees or S-2300 for non-employees) you wish to delete the information of from the government. When this process runs, it createsthe driver information of an S-3000 event for the hiring event. After the process completes successfully,be sure to access the eSocial Non Periodic Event Page to prepare data (generate mapping) and create anXML file for the S-3000 event to be submitted to the government.

Field or Control Description

Receipt Number Enter the receipt number of an S-2200 or S-2300 event forwhich to generate the driver information of an S-3000 (EventExclusion) event.

You must enter a valid receipt number for this process to runproperly. A number is considered valid if it is the latest receiptnumber of the S-2200 or S-2300 event that was returnedsuccessfully (hiring event status = GSUC) to PeopleSoft fromthe government.

Original Event

This section displays the hiring event information associated with specified receipt number.

Related LinksS-3000 - Event Exclusion

Copyright © 1988, 2022, Oracle and/or its affiliates. 307

Working With eSocial Chapter 14

"Deleting Employment Record Numbers (ERNs)" (PeopleSoft Human Resources Administer Workforce)

Creating XML Outputs for Events

This topic provides an overview of the XML output creation process.

Page Used to Create XML Outputs For Submission

Page Name Definition Name Usage

eSocial Recreate XML Files Page GPBR_RUN_XML Recreate XML outputs for selectedevents, companies, and establishments.

Understanding XML Output GenerationOnce the staging tables are loaded with the eSocial event data that is identified for the reference month,together with driver and cross reference tables, XML outputs for event data are ready to be generatedusing the XML Reporting Framework.

Customers are ready to generate XML outputs for eSocial reporting when:

• The XML Reporting Framework is set up for eSocial functionality.

The setup (for example, XML set, template, and node root) is delivered as part of the eSocialfunctionality.

See Also "Setting Up XML Reporting Framework" (Application Fundamentals)

• Tables views are created for event layouts to be used in the XML output creation process.

They are delivered as part of the eSocial functionality.

• The XML-specific setup is configured for events and companies that are enabled for eSocialreporting.

See Also XML Batch Group Definition Page, Events Setup Page and XML Options Page

• eSocial data is loaded in driver, cross-reference, and staging tables.

PeopleSoft delivers run control pages that invoke the XML output creation process. While these pages arebuilt for specific event categories, the process flow remains the same.

308 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 14 Working With eSocial

This diagram illustrates the high-level process flow for generating XML outputs for eSocial reporting.

The XML output creation process can be invoked from these run control pages: eSocial Basic Initial Page,eSocial Employee Initial Page, eSocial Basic Table Event Page, and eSocial Non Periodic Event Page.

When the process is invoked from an eSocial run control page (with Create XML selected as the processoption), it:

1. Reads the parameters that are specified on the run control page, and selects from the driver table datarows that match those parameters and are in the SUCC (Success) or XERR (XML Error) status. Itpopulates these data rows to the temporary record, waiting to be processed.

Copyright © 1988, 2022, Oracle and/or its affiliates. 309

Working With eSocial Chapter 14

2. Updates the status of these data rows to XRDY in the driver table to prevent them from being used byother processes.

3. Validates the status of the events that are associated with all data rows that are available in thetemporary record:

• If the event of a row is active, the row is populated to XML records (XMLFG_ITEM andXMLFG_RC) for file creation.

• If the event of a row is inactive, the row status is set to XERR (XML Error) in the driver record.The row is sent for error handling.

4. Calls the XMLFG_PRNT process of the XML Reporting Framework to create XML outputs for rowsfound in the XML records.

This step applies to companies that have their XML output type set to file on the XML Options page.

5. Updates the status of each data row that has its XML output created successfully to XCRT (XMLCreate) in driver records. For those that didn’t have their outputs generated, their row statuses are setto XERR, and their rows sent for error handling.

6. Writes the process results to the log.

Based on the output type (string or file) that is specified on the XML Options page, PeopleSoft eithergenerates an XML string to be inserted into the XMLGF_STRNG_TBL record, or generates XML filesto be stored in the specified directory for the corresponding company. Customers are responsible forsubmitting XML outputs to the eSocial environment using third-party or their own in-house systems.

Customers have the option to recreate XML outputs (file or string) for eSocial events if necessary.PeopleSoft delivers the eSocial Recreate XML Files Page that recreates XML outputs for selectedcompanies, establishments and events.

Related LinksSubmitting XML Outputs and Requesting Results

eSocial Recreate XML Files PageUse the eSocial Recreate XML Files page (GPBR_RUN_XML) to recreate XML outputs for selectedevents, companies, and establishments.

Navigation:

Global Payroll & Absence Mgmt >Absence and Payroll Processing >Reports >eSocialBRA >eSocial Recreate XML

310 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 14 Working With eSocial

This example illustrates the fields and controls on the eSocial Recreate XML Files page.

Note: Normally, XML outputs are created after the XML generation process is invoked from the initialloading, basic table, and non-periodic run control pages. If XML outputs are not created as expected,use this page to run the XML generation process (GPBR_GEN_XML) to recreate XML outputs for datarows that are set as XCRT (XML created) in the driver table, but do not have corresponding XML outputscreated.

Field or Control Description

Limit Date Enter the date that is used to identify which data rows from theDriver record are to be reprocessed. Driver record rows withan effective date later than this date will not be reprocessed.

By default, the current date is populated.

Company Select the company to be reprocessed.

Copyright © 1988, 2022, Oracle and/or its affiliates. 311

Working With eSocial Chapter 14

Field or Control Description

Category Select the category of events to be processed. Values are:

Basic Table

Non Periodic

Periodic

Totaling

Termination

All Establishments Select for all establishments of the selected company to bereprocessed.

Event List

This section lists all the events for the selected category. Select the ones to be reprocessed.

Establishment List

In this section, select one or more establishments to be reprocessed for XML output creation, if not allestablishments of the selected company are to be processed.

This section appears if the All Establishments field is not selected.

Submitting XML Outputs and Requesting Results

This topic provides an overview of how XML outputs and process results flow between PeopleSoft andeSocial systems using system-delivered web services.

Pages Used to Submit XML Outputs and Request Submission Results

Page Name Definition Name Usage

Send Batch Process Page GPBR_ES_SEND_RC Specify eSocial XML outputs to send tothird-party systems.

Get Events Results Process Page GPBR_ES_QUERY_RC Request XML output submission resultsfrom third-party systems.

312 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 14 Working With eSocial

Understanding eSocial Data Transmission Between PeopleSoft and eSocialSystems

The transmission of eSocial data between the PeopleSoft system and the eSocial environment of theBrazilian government is handled through a partner integration or company customization (referred to as“third-party program” in this topic) that customers provide. PeopleSoft delivers web services that areresponsible for sending XML outputs to and requesting submission results from this third-party program,which communicates with the eSocial environment and transmits information between both systems.

This diagram describes the process flow of submitting event outputs to the eSocial environment andsending the results back to the PeopleSoft system through a third-party program.

When XML outputs are generated for each driver sequence by the XML generation AE program, theyare sent to the receiver node that the customer created for the third-party program in Integration Broker.These outputs are sent in batches, each of which can include up to 50 event outputs of the same grouptype (initial and basic tables, non-periodic, or periodic), or the maximum number allowed that is specifiedon the XML Options Page for any given company.

In order for XML outputs to be grouped into batches properly for submission, you need to define XMLbatch groups and subgroups on the XML Batch Group Definition Page. Subgroups allow you to furthercategorize events of a group type into smaller logical groupings. Then, assign each eSocial event to abatch group and subgroup on the Events Setup Page. PeopleSoft groups company’s event outputs of thesame batch group and subgroup in batches for transmission.

Delivered ServicesPeopleSoft HCM Global Payroll for Brazil delivers two services to facilitate the communications betweenthe PeopleSoft HCM and third-party programs.

• GPBR_ESOCIAL_BATCH_SEND (eSocial BRA XML Batch Send)

Copyright © 1988, 2022, Oracle and/or its affiliates. 313

Working With eSocial Chapter 14

• GPBR_ESOCIAL_BATCH_GET_RESULTS (Get Events Processing Results)

Important! For these services to function properly, verify that correct values are specified in the ServiceAlias and Namespace fields on the Services page (IB_SERVICEDEFN), according to the web servicesthat are provided by the third-party system.

GPBR_ESOCIAL_BATCH_SEND (eSocial BRA XML Batch Send)

PeopleSoft uses this service to send XML output batches to the third-party program that is responsible fordelivering XML outputs to the government. Upon receipt of an XML batch, the third-party system returnsa response message that contains the Protocol ID (generated by the third-party system) of the batch file.If the batch was not sent successfully, relevant information about the error is included in the responsemessage instead.

It contains one synchronous service operation, GPBR_ESOCIAL_BATCH_SEND, with two messages:

• GPBR_ESOCIAL_BATCH_SEND_REQ (request)

• GPBR_ESOCIAL_BATCH_SEND_RES (response)

GPBR_ESOCIAL_BATCH_GET_RESULTS (Get Events Processing Results)

PeopleSoft uses this service to request the processing results of each event that was sent in any givenbatch.

The third-party system returns the result information in a response message. If any errors are found andthe information cannot be returned, the response message includes the locations of where the errors orwarnings were identified.

It contains one synchronous service operation, GPBR_ESOCIAL_BATCH_GET_RESULTS, with twomessages:

• GPBR_ESOCIAL_GET_RESULTS_REQ (request)

• GPBR_ESOCIAL_GET_RESULTS_RES (response)

Integration Broker Setup Considerations for Transmitting eSocial Data

Note: Oracle delivers a document (in Portuguese) that provides an example of an integrationconfiguration between PeopleSoft and third-party systems for eSocial reporting. This document isavailable for download on My Oracle Support (document ID 1526487.1).

Note that in these system-delivered service operations, both handlers and routings are not delivered. Youneed to add a new routing definition for each service operation.

Routings can be added from the Routings page of Service Operation component (navigation:PeopleTools >Integration Broker >Integration Setup >Service Operations).

On the Routing Definitions page (IB_ROUTINGDEFN) of the new routing, specify the default local nodeas the sender node, and the node that is created for the third-party program as the receiver node.

On the Parameters page (IB_ROUTINGDEFNDOC) of the new routing, be sure to verify that correctvalues are specified in the External Alias fields.

314 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 14 Working With eSocial

In addition, make sure that these properties are added on the Connector Properties page(IB_ROUTINGDEFCON) for the LOCAL gateway and HTTPTARGET connector to generate the SOAPenvelope:

• Property ID: HEADER; Property Name: Content-Type

Enter the value for this property based on the third-party system configuration.

• Property ID: HEADER; Property Name: sendUnCompressed

Enter the value for this property based on the third-party system configuration.

• Property ID: HTTPPROPERTY; Property Name: Method

Enter the value for this property based on the third-party system configuration.

• Property ID: HTTPPROPERTY; Property Name: SOAPUpContent

Enter the value for this property based on the third-party system configuration.

• Property ID: PRIMARYURL; Property Name: URL

Enter the value for this property based on the third-party system configuration.

When this Integration Broker setup is completed, you can send eSocial XML outputs and requestsubmission results on the Send Batch Process Page and Get Events Results Process Page.

Send Batch Process PageUse the Send Batch Process page (GPBR_ES_SEND_RC) to specify eSocial XML outputs to send tothird-party systems.

Navigation:

Global Payroll & Absence Mgmt >Absence and Payroll Processing >Reports >eSocial BRA >SendBatch Process

Copyright © 1988, 2022, Oracle and/or its affiliates. 315

Working With eSocial Chapter 14

This example illustrates the fields and controls on the Send Batch Process page.

Run the GPBR_ES_SEND AE (application engine) process to submit XML output batches (as selected onthis page) to the target third-party program using the eSocial BRA XML Batch Send service.

Field or Control Description

Send Method Select the method to use to select XML outputs forsubmission. Values are Single and Multiple.

Single Batch

This section displays if the Single send method is selected.

Field or Control Description

Driver Sequence Enter one or more driver sequence numbers of XML outputsto be sent to the third-party system. The system creates a batchfor each specified driver sequence. For example, if you enter10 driver sequences to be sent to the third-party program usingthe Single method, the system creates 10 batches, one for eachdriver sequence.

If you use the Single method, it is expected that you knowthe drive sequence numbers of files you want to send. Driversequences can be obtained from the eSocial Events MonitorPage or through queries.

316 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 14 Working With eSocial

Multiple Batch

This section displays if the Multiple send method is selected. Use this method to send XML outputs ofspecific XML batch groups and companies to third-party programs.

Field or Control Description

Company Select the company of XML outputs to be sent to the third-party system. You can include more companies by addingmore rows.

If no company is selected, all eSocial-enabled companies areincluded.

XML Batch Group Select one or more batch groups of XML outputs to be sent tothe third-party system.

Get Events Results Process PageUse the Get Events Results Process page (GPBR_ES_QUERY_RC) to request XML output submissionresults from third-party programs.

Navigation:

Global Payroll & Absence Mgmt >Absence and Payroll Processing >Reports >eSocial BRA >GetEvents Results Process

This example illustrates the fields and controls on the Get Events Results Process page.

Run the GPBR_ES_QRY AE process to request XML output submission results from the target third-party program using the Get Events Processing Results service.

Copyright © 1988, 2022, Oracle and/or its affiliates. 317

Working With eSocial Chapter 14

Field or Control Description

Query Method Select the method to use to query results. Vales are Single andMultiple.

Single Queries

This section displays if the Single query method is selected.

Field or Control Description

Protocol Enter one or more protocol IDs of XML batches of which youwish to request the submission results.

Multiple Queries

This section displays if the Multiple query method is selected.

Field or Control Description

Company Enter one or more companies to request the submission resultsof all their XML outputs.

Monitoring eSocial Events

This topic provides an overview of eSocial event monitoring.

Pages Used to Monitor eSocial Events

Page Name Definition Name Usage

eSocial Error Catalog Page GPBR_ES_ERR_CAT Define and maintain error, warningand informational messages for usein various components of the eSocialfunctionality.

eSocial Events Monitor Page GPBR_ESOC_MONITOR Monitor event statuses throughout theeSocial data reporting process.

eSocial Events Monitor - Details Page GPBR_ESMON_DETL View detailed event information of theselected event layout or event layoutstatus.

318 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 14 Working With eSocial

Page Name Definition Name Usage

Event Details Page GPBR_ES_EVT_OCCUR View additional information of thecorresponding event.

eSocial Monitor XML Preview Page GPBR_ES_PREV_XML Preview XML files for events that havecompleted the mapping process.

Employee Event History Page GPBR_ESOC_EMPLHIST View eSocial event information byemployee.

Understanding eSocial Event MonitoringeSocial is a complex reporting system. For companies that prepare and submit data to eSocial in highvolume, it is important for them to be able to keep track of the progress of these events, identify errorsthat occur during the process cycle and take appropriate actions.

The eSocial Events Monitor provides users the ability to view the progress of events at each stage (orstatus) of the eSocial reporting cycle. Users can search for events using a number of supported searchfilters (by date, company, establishment, event, and status). From the search results, users can see the totalnumber of events that are created for any given event, as well as the breakdown by status, which gives ageneral status summary of where events stand in the eSocial reporting cycle.

Errors found during the reporting cycle are recorded in the eSocial Events Monitor as well. They comefrom the eSocial functionality in PeopleSoft, the Brazilian government or third-party partners, and need tobe addressed in a timely manner. PeopleSoft provides a setup page to define error messages and possibleactions that users can take when errors are found.

In addition to the eSocial Events Monitor, Global Payroll for Brazil provides another functionality forusers to track events by employee on the Employee Event History Page. Users can view the list of eventsthat were created for the selected employee, refine the search results by time period, event category andstatus, and view event details such as driver sequence, event type, and receipt number.

To access the eSocial Events Monitor, users need to be associated with the HCCPGPBRA permission listthrough user roles. This permission list is linked to the system-delivered GP Administrator BRA user role.

eSocial Error Catalog PageUse the eSocial Error Catalog page (GPBR_ES_ERR_CAT) to define and maintain error, warning andinformational messages for use in various components of the eSocial functionality.

Navigation:

Set Up HCM >Product Related >Global Payroll & Absence Mgmt >eSocial BRA >MainSetup >eSocial Error Catalog

Copyright © 1988, 2022, Oracle and/or its affiliates. 319

Working With eSocial Chapter 14

This example illustrates the fields and controls on the eSocial Error Catalog page.

Field or Control Description

Source Displays where in the general eSocial flow the messageoriginates, which can be any of the batch processes, onlineHCM transactions, web service communications, and so on. Values are:

Government - Batch: From the eSocial environment.

Government - Event: From the eSocial environment.

Initial Loading: From the initial data loading process wheredriver records are created.

Mapping: From the mapping process when data from driverrecords is populated to staging tables.

Online: From the generation of driver records (on demand, fornon-periodic events).

Process: From the generation of driver records that isperformed by batch processes.

Third-Party: From a third-party system.

XML Generation: From the XML file generation process.

320 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 14 Working With eSocial

Field or Control Description

Owner Indicates the party that is responsible for defining andmaintaining the message definition. Values are:

Customer Maintained: Customers can modify messages thatare defined by themselves.

PS Delivered/Not Maintained: PeopleSoft-delivered messagesare displayed as read-only.

PS Delivered/Maintained

Error Code Enter the error code.

Severity Select the severity of the message. Values are:

Error

Message (for informational purposes)

Warning: Typically used for rectification and exclusion events. Warning messages are marked with Action Required on theeSocial Monitor.

Message Text Enter the text of the message, which is displayed on eventmonitoring pages and reports. Keep it precise.

Description Enter the detailed description of the message, for example, the reasons why the message is generated and ways to resolveissues caused.

Action Select, if any, one or more actions that can be performed forthe message. Values are:

Cancel the Event: Update the event to the Cancelled status. Cancelled events cannot be processed again.

Reprocess: Reprocess the event from the step where an error isfound.

Restart the Event: Update the event to the Ready (RDY) statusfor it to be picked up for eSocial processing again.

eSocial Events Monitor PageUse the eSocial Events Monitor page (GPBR_ESOC_MONITOR) to monitor event statuses throughoutthe eSocial data reporting process.

Navigation:

Global Payroll & Absence Mgmt >Absence and Payroll Processing >Reports >eSocialBRA >eSocial Events Monitor

Copyright © 1988, 2022, Oracle and/or its affiliates. 321

Working With eSocial Chapter 14

This example illustrates the fields and controls on the eSocial Events Monitor page.

This example illustrates the eSocial Events Monitor page, displaying search results.

Search Criteria

Use this section to select at least one search criterion. Corresponding search sections and fields appear inthe Select Filter Values section based on the selected search criteria.

Field or Control Description

Search Date By This is the recommended search criteria. Values are:

Accrual Period. Select to search for events that occurred in thespecified month and year time period.

Transaction Date. Select to search for events generated fortransactions that occurred during the specified date range.

322 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 14 Working With eSocial

Field or Control Description

Search By Values are:

• Company. Select one or more companies, which areenabled on the Company Parameters Page.

• Establishment. Select one or more companyestablishments that are enabled for eSocial reporting.

• Employee ID. Select one or more employees.

Search Event by Values are:

• Event. Select one or more events.

• Event Category. Select one or more delivered eventcategories.

Search Status By The available value is Status.

Select Filter Values

Use this section to enter search values for selected search criteria.

Field or Control Description

Accrual Period From and Accrual Period To Enter the accrual time period for the event search.

These fields appear if Accrual Period is selected in the SearchDate By field.

Transaction Dt From (transaction date from) andTransaction Dt To (transaction date to)

Enter the transaction time period for the event search.

These fields appear if Transaction Date is selected in theSearch Date By field.

Companies Enter one or more eSocial-enabled companies for the eventsearch.

This section appears if Company is selected in the Search Byfield.

Employees Enter one or more employee IDs for the event search.

This section appears if Employee ID is selected in the SearchBy field.

Copyright © 1988, 2022, Oracle and/or its affiliates. 323

Working With eSocial Chapter 14

Field or Control Description

Establishments Enter one or more establishments of eSocial-enabledcompanies for the event search.

This section appears if Establishment is selected in the SearchBy field.

Events Enter one or more events for the event search.

This section appears if Event is selected in the Search EventBy field.

Event Category Enter one or more event categories for the event search. Valuesare Basic Table, Non Periodic, Periodic, Termination andTotaling.

This section appears if Event Category is selected in theSearch Event By field.

324 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 14 Working With eSocial

Field or Control Description

Status Enter one or more event statuses for the event search. Valuesare:

CANC (Cancelled): Events that are cancelled by users.

COMP (Completed): Events that are accepted by thegovernment.

DUPL (Duplicated): Events that are duplicated.

ERRM (Error Mapping): Events that encountered error in themapping process.

GERR (WS Return Error): Events that encountered error asreported by the web service.

GSUC (WS Return Success): Events that are submittedsuccessfully as reported by the web service.

HOLD (On Hold): Events that are placed on hold and mayrequire user action.

MAPP (Mapping): Events that are completed successfully inthe mapping process and loaded to staging tables.

NEW (New): Newly created events in the system.

RDY (Ready): Events that are ready for the mapping process.

SMOV (Without Movement): Events created for companiesthat have no movement.

SUCC (Success): Events that are ready for XML outputgeneration if selected.

XCRT (XML Create): Events that are completed successfullyin the XML output generation process.

XERR (XML Error): Events that encountered errors during theXML output generation process.

XRDY (XML Ready): Events that are about have their XMLoutputs generated by an AE (application engine) process.

XSEN (XML Sent): Events with XML outputs that aresubmitted to the government.

This section appears if Status is selected in the Search StatusBy field.

Copyright © 1988, 2022, Oracle and/or its affiliates. 325

Working With eSocial Chapter 14

Search Results

This section displays the search result summary.

Field or Control Description

Edit Search Values Click to expand the search sections and modify search values, if necessary.

Events Total Displays the sum of all event count for the listed company andevent.

Click the number link to view the list of event items in moredetail.

[Event Status columns] Displays the individual event count for the listed company andevent by status.

Click the number link to view the list of event items in moredetail.

eSocial Events Monitor - Details PageUse the eSocial Events Monitor - Details page (GPBR_ESMON_DETL) to view detailed eventinformation of the selected event layout or event layout status.

Navigation:

Click a number link (which can be a total event count, or status-specific event count) on the eSocialEvents Monitor page.

This example illustrates the fields and controls on the eSocial Events Monitor - Details page.

Field or Control Description

Event Code Displays the event code and name of the entries listed in thegrid.

326 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 14 Working With eSocial

Field or Control Description

Status Displays the status of the entries listed in the grid.

This field appears if you click the number link of a particularstatus to view event detail.

Count Displays the number of the event entries listed in the grid.

Events

The display of columns in this section changes slightly based on the event code, status, and the typeof event count link (total or status-specific) that was clicked to access the event detail. Valid columnsinclude, but not limited to:

• Company

• Company Name

• Element Number

• Element Name

• Establishment ID

• Empl ID (employee ID)

• Empl Record

• Name (employee)

• Hire Date

• Accrual Period

• Set ID

• Job Code

• Job Code Description

• Location Type

• Proceeding Number

• Proceeding Type

• Description

• Service Taker

• Shift ID

• Wage Tp Table ID

Copyright © 1988, 2022, Oracle and/or its affiliates. 327

Working With eSocial Chapter 14

• Effective Date

• Ini Date

• End Date

• Transaction Date. Displays the date the corresponding event occurred.

• Operator ID. Displays the user who performed the transaction.

• Last Processing Date. Displays the date and time when the last process was performed on the event.

• Status

• Event Status. Available to total count links only.

• Details. Available to status-specific count links only. Click to access the Event Details Page to viewdetails of the corresponding event.

Field or Control Description

Select Select one or more event entries for an action (alreadyselected) to be performed. This field becomes editable whenyou clicked the number link of either the Errors or Returnedwith Error status in the search result of the eSocial EventsMonitor page previously, and have now selected an action thatis applicable to an event entry on this page.

Errors and their associated actions are defined on the eSocialError Catalog Page.

Action and Go Select an action to perform on selected event entries. This fieldbecomes editable when you clicked the number link of eitherthe Errors or Returned with Error status in the search resultof the eSocial Events Monitor page previously. Click the Gobutton to perform the action on selected event entries.

If you select more than one entry and each is associated witha different error and action, all actions become available forselection.

Entries are removed from the grid after the selected actionis performed successfully and that the statuses of entries areupdated accordingly.

Status

Valid statuses are:

328 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 14 Working With eSocial

Field or Control Description

Indicates transactions that have eSocial events requested forthem (driver transactions created).

Indicates eSocial events that are in the mapping process.

Indicates transactions with internal errors found by eSocialprocesses.

Indicates transactions with rectification or exclusion eventsthat require user actions.

This status is common for rectification and exclusion events, which are sometimes critical and therefore require userintervention.

Indicates transactions that have the related XML files createdand are waiting for a receipt number (if XML files aresubmitted to the government).

After XML files are generated, no user actions are allowed onthis page. Administrators, however, can cancel or update thestatus of events in the Awaiting Return status on a differentpage.

Indicates transactions that have errors found by the third-partysystem or the Brazilian government.

Indicates transactions that have been accepted and havecorresponding receipt numbers.

Indicates transactions that are cancelled by users.

Event Details PageUse the Event Details page (GPBR_ES_EVT_OCCUR) to view additional information of thecorresponding event.

Navigation:

Click the Details link in the Events section of the eSocial Events Monitor - Details page.

The Details link appears if a status-specific event count is clicked on the eSocial Events Monitor page.

Copyright © 1988, 2022, Oracle and/or its affiliates. 329

Working With eSocial Chapter 14

This example illustrates the fields and controls on the Event Details page.

Original Event

This section displays information of the selected event. Information shown is slightly different dependingon the status of the event.

Field or Control Description

Preview XML Click to preview the XML content for the event on the eSocialMonitor XML Preview Page. This link appears if the event isin the MAPP, SUCC, or XRDY status.

Occurrences

If the event transaction you’re viewing is in an error status, all associated error codes are available forreview in this section. These codes help identify the cause of errors that occurred, and provide useful tipsto address them.

Error messages are defined on the eSocial Error Catalog Page.

eSocial Monitor XML Preview PageUse the eSocial Monitor XML Preview page (GPBR_ES_PREV_XML) to preview XML files for eventsthat have completed the mapping process.

Navigation:

Click the Preview XML link on the Event Details page.

330 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 14 Working With eSocial

This example illustrates the fields and controls on the eSocial Monitor XML Preview page.

Administrators have the option to preview XML files for events that have completed the mapping processand are in the MAPP, SUCC, or XRDY status. Events in these statuses are consolidated under the InProcess status in the Search Results: Events Summary section of the eSocial Events Monitor Page.

Note: The preview version of the XML files is not the same as the official version that the systemgenerates for events in the XML generation process. Do not submit the preview version of XML files tothe Government.

Employee Event History PageUse the Employee Event History page (GPBR_ESOC_EMPLHIST) to view eSocial event information byemployee.

Navigation:

Global Payroll & Absence Mgmt >Absence and Payroll Processing >Reports >eSocialBRA >Employee Event History

Copyright © 1988, 2022, Oracle and/or its affiliates. 331

Working With eSocial Chapter 14

This example illustrates the fields and controls on the Employee Event History page.

Video: Image Highlights, PeopleSoft HCM Update Image 38: eSocial Employee Events History

Search Options

Field or Control Description

Time Period Select the time frame during which the drivers of the eventsyou want to view were generated. Values are:

Custom Period

Last 30 Days (Default value)

Last 60 Days

Last 90 Days

From Date and To Date Enter the start and end dates of the time frame for the eventsearch. These fields appear if you select the Custom Periodoption in the Time Period field.

Category (Optional) Select to view only Non Periodic, Periodic, orTermination events in the search results.

Refer to the Global Payroll for Brazil eSocial Event Layoutstopic for the list of system-delivered events and theircategories.

332 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 14 Working With eSocial

Field or Control Description

Status (Optional) Select the status of the events to return in the searchresults.

Event Details

This section lists the matching events by driver sequence in descending order.

Field or Control Description

Driver Sequence Displays the unique identifier of the event.

Event Displays the event code. For the periodic events (S-1200and S-1210), the payroll type (Monthly or Annually) is alsodisplayed.

Date Displays the date when the data creation, change or deletionfor which the event was created occurred, for example, theeffective date for an employee’s job code change in JobData. This date appears in the XML file to be reported to theGovernment.

Type Displays the type of the event. Values are:

Deleted: Indicates that an S-3000 event has been created forthe event to remove the event data from the Government’seSocial system.

Original

Rectified: Indicates that the event is being rectified by anotherevent.

Rectifier: Indicates that the event rectifies another event.

Rectified Driver Sequence Displays the unique identifier of the event that was rectified bythis event. This value appears only for Rectifier events.

Receipt Num (receipt number) Display the receipt number of the event. This value is onlyavailable for events that have been processed successfully bythe Government.

Copyright © 1988, 2022, Oracle and/or its affiliates. 333

Working With eSocial Chapter 14

Generating CAT Forms

This topic provides an overview of eSocial CAT forms and discusses how to generate them.

Page Used to Generate CAT Forms

Page Name Definition Name Usage

CAT Form Page GPBR_CAT_FORM Generate CAT forms for work accidents.

Understanding eSocial CAT FormsA CAT (Comunicado de Acidente de Trabalho) form is a work accident report that contains informationabout an employee’s occupational accident or illness. Employers are required to file CAT forms for allwork accidents that caused injuries, illnesses, or death to their employees.

The GPBR_ES_CATF application engine program generates CAT forms with work accident data that wassubmitted and accepted by the Government using the S-2210 event in eSocial.

On the CAT Form Page, you can specify a time period (last 30, 60, or 90 days, or a custom period), CATtype, and the option to search for the S-2210 events by employee, establishment, or incident number.When you run the GPBR_ES_CATF program, it evaluates all S-2210 events that meet the selectioncriteria, and generates the CAT form for each event that has the GSUC (WS Return Success) status.

The GPBR_ES_CATF program creates a CAT form for an eligible S-2210 event using the most recentinformation in one of these versions:

• Standard: If the S-2210 event had a rectification, followed by an exclusion, but the exclusion eventwas not accepted successfully by the Government, the process populates the entire CAT form usingthe updated (rectified) version of the data.

• Exclusion: If the S-2210 event had a rectification, followed by an exclusion, and all were acceptedsuccessfully by the Government, the process populates part of the CAT form only. Sections pertainingto the work accident (or disease) and medical certificate (fields 19 through 50) are blank.

The CAT form is printed in Portuguese. If a work accident is associated with more than one CAT typewith the same work accident date, a CAT forms will be generated for each applicable CAT type.

Note: For customers who do not use the S-2210 event in eSocial to submit work accident data tothe Government, run the BRCAT01 process to generate CAT reports on the "CAT Report BRAPage" (PeopleSoft Human Resources Monitor Health and Safety) instead.

CAT Form PageUse the CAT Form page (GPBR_CAT_FORM) to generate CAT forms for work accidents.

Navigation:

334 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 14 Working With eSocial

Global Payroll & Absence Mgmt >Absence and Payroll Processing >Reports > eSocialBRA >CAT Form

This example illustrates the fields and controls on the CAT Form page.

Field or Control Description

Company (Required) Select the company of the S-2210 events withgenerated drivers to be included in the selection.

Only companies that are enabled on the Company ParametersPage are available for selection.

Time Period (Required) Select the time frame for the event selection. AnyS-2210 event with a generated driver and a work accident datewithin the specified time frame will be included. Values are:

Custom Period

Last 30 days (default)

Last 60 days

Last 90 days

From Date and To Date Enter the start and end dates of the time frame. These fieldsappear if you select the Custom Period option in the TimePeriod field.

CAT Type Select to refine the selection by CAT type. Values are:

All (default)

Death Communication

Initial

Reopened

Copyright © 1988, 2022, Oracle and/or its affiliates. 335

Working With eSocial Chapter 14

Field or Control Description

Search By Select to refine the selection further by:

Employee (default): Specify one or more employee IDs of theselected company in the Employee Data section that appears.

Establishment: Specify one or more establishments of theselected company in the Establishment Data section thatappears.

Incident: Specify one or more incident numbers of the selectedcompany in the Incident Data section that appears.

Related LinksS-2210 - Accident at Work Communication (CAT)

336 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 15

Calculating Social Security Contributions

Understanding INSS Contributions

The main objective of the INSS (Instituto Nacional do Seguro Social) (Brazilian Social SecurityInstitute) is to provide uniform social security benefits and services to urban and rural populations. Thisincludes cover for sickness, disabled workers, death and the aged. INSS social security contributions arecompulsory and binding and are funded through contributions made by companies and employees.

Both employers and employees must make a monthly contribution to social security through the INSSusing their own resources to finance the benefits payable to employees. Calculation is in accordance withInstitute's table, which is published by INSS.

Viewing Delivered ElementsThe PeopleSoft system delivers a query that you can run to view the names of all delivered elementsdesigned for Brazil. Instructions for running the query are provided in the "Understanding How to ViewDelivered Elements" (PeopleSoft Global Payroll) topic.

Entering GPS Establishment Information

The INSS payment is made using the GPS (Guia da Previdência Social) (Social Security Payment Form).You set up some of the following establishment details required for the form in the eSocial Data groupbox on the "Additional Info - Brazil Page" (PeopleSoft Human Resources Administer Workforce) (Set UpHCM > Product Related > Workforce Administration > Establishment BRA > Additional Info -Brazil).

Field Details

FPAS Code Fundo de Previdência e Assistência Social (Pension Fund and Social Assistance). Defines percentages due to third parties in the GPS. Represents the code of thecompany's activity for INSS classification purposes, which is used to define thepercentage of the INSS due to third parties.

SAT Code Seguro de Acidente de Trabalho (Workers' Accident Insurance)

Work Risk % Percentage of payment to be made by the company regarding workers' accidentapplicable to employees under status 01 or 05 (non-exposure to harmful substance).

SAT % 25 Years Special retirement at 25 years of service - exposure to harmful substances (withconditions 04 and 08)

Copyright © 1988, 2022, Oracle and/or its affiliates. 337

Calculating Social Security Contributions Chapter 15

Field Details

SAT % 20 Years Special retirement at 20 years of service - exposure to harmful substances (withconditions 03 and 07)

SAT % 15 Years Special retirement at 15 years of service - exposure to harmful substances (withconditions 02 and 08).

See Also "Additional Info - Brazil Page" (PeopleSoft Human Resources Administer Workforce)

Determining Social Security Contributions

This topic discusses how companies, third parties, and employees should contribute to Social Securitythrough the GPS (Guia da Previdência Social) (Social Security Form).

Determining Company Social Security ContributionsCompanies and equivalent-status contributors are required to contribute to Social Security throughInstituto Nacional do Seguro Social (INSS) (Brazilian Social Security Institute) with their own resourcesin order to finance the benefits due to workers as follows:

• Application of the 20 percent rate on the total of the compensation subject to INSS contribution(accumulator), without limit, paid or credited to insured individuals at its service and in case offinancial institutions and equivalent-status entities an additional contribution of 2.5 percent will alsobe payable.

• Application of 20 percent rate on the total of compensation or retribution, paid or credited for servicesrendered to it by insured individual contributor, freelance workers and other individuals withoutemployment bond, and in case of financial institutions and the equivalent-status institutions aresubject to an additional contribution of 2.5 percent.

• Contribution intended to finance benefits granted according of the level of occurrence of labordisability as a result of working environmental risks at 1 percent, 2 percent and 3 percent rates by thecompany with low, medium, or high risk of accident in its main activity, respectively, on the total ofcompensation subject to INSS contribution (accumulator) paid or credited on any account during themonth, to insured employees, freelance workers and resident physicians.

Rates will be added by 12 percent, 9 percent, or 6 percent, according to the activity in which thecompany is engaged with, by the insured worker at service of the company, allows the granting ofspecial retirement at 15, 20, or 25 years of contribution, respectively.

• Contribution intended to third parties with variable rate in accordance with the activity developed bythe company, applicable on the total of compensation, without limit, paid or credited to employees atits service.

Rates will be defined according to FPAS code of the company. This field is at the establishment level.

338 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 15 Calculating Social Security Contributions

Determining Third-Party Social Security ContributionsThird parties are other entities for which the company pays contribution, such as INCRA, SESC, SENAI,SEBRAE, and education allowance. These contributions are not intended to finance the benefits paid bySocial Security, they are collected by INSS and passed over to the respective entities, reflecting directlyupon the compensation paid to the employee. Entities for which a company is required to contributeare defined according to the activity developed by it. INSS classifies the company according to thecode that identifies the activity developed by the establishment in relation to the Fundo de Previdênciae Assistência Social (FPAS) (Pension Fund and Social Assistance). The FPAS defines percentagesdue to third parties in the GPS. The FPAS code represents the code of the company's activity for INSSclassification purposes, which is used to define the percentage of the INSS due to third parties. You setup the code on the Additional Info - Brazil page. With the FPAS code of the establishment, company isinformed of the entities for which it has to contribute and the respective rates of contribution.

If the company has a convention signed with third parties such as SESI, SENAI and EDUCATIONALLOWANCE, payment will be made separately from the GPS (Guia da Previdência Social) (SocialSecurity Form).

Determining Contribution to SAT (Workers' Accident Insurance)To determine the amount of contribution to the Seguro de Accidents do Trabalho (SAT) (Workers'Accident Insurance), you enter a percentage on the SAT % 15 Years, SAT % 20 Years, and SAT %25 Years fields on the Additional Info - Brazil page (Set Up HCM > Product Related > WorkforceAdministration > Establishment BRA). The calculation base of accident is the total of compensationsubject to INSS contribution (accumulator).

The company or equivalent status contributor is required to pay a contribution to finance the specialretirement of the employees and the benefits granted because of the degree of occurrence of labordisability as a result of the working environmental risks. Contribution is applicable on the compensationpaid, due or credited to the employee, on any account during the month in which the rates are of 1 percentfor low risk of work accident, 2 percent for medium risk of work accident, and 3 percent for serious riskof work accident. Rates are defined according to the main activity of the company. The main activity ofthe company is the activity that engages the highest number of employees of the company.

A company exposing employees to substances harmful to health, whether chemicals, physical, orbiological risks susceptible for the granting of special retirement, is subject to the payment of anadditional rate. Special retirement will be due, once the waiting period is complied with, to the insuredemployee that has worked under special conditions that may affect the health or the physical integrity for15, 20, or 25 years.

Determining Employee Social Security ContributionsEvery employee is required to contribute toward Social Security. The company discounts the amount ofthe contribution from the employee's compensation and the calculation is made through the application ofpercentages in a progressive manner, on the monthly contribution salary. When calculating a contributionnote always the maximum limit of contribution salary as the employee's contribution, unlike thecontribution due by the company that is applicable on the total of compensation is restricted to themaximum limit. For example, if the maximum limit for contribution salary starting from March of 2020 isBRL 6.101,06 (maximum limit set forth by the government at company level, applying to all employees)and the employee's compensation is BRL 7.000,00, the contribution due by employee will be calculatedconsidering only the limit of BRL 6.101,06. Employee's contribution salary consists of the compensation

Copyright © 1988, 2022, Oracle and/or its affiliates. 339

Calculating Social Security Contributions Chapter 15

actually paid or credited on any account, during the month, by one or more companies, including earningspaid in kind.

Determining Maternity Allowance ContributionsAlthough the maternity allowance is a social security benefit, it also constitutes the employee contributionsalary. Therefore, contribution will be payable by both, employer and employee, on the values paid onthe account of Maternity Allowance. Maternity Allowance may be paid directly by Social Security or thecompany if it has a convention signed with the INSS.

Determining Family Allowance ContributionsFamily Allowance is a social security benefit paid by the company, with the respective reimbursement bythe INSS. Reimbursement occurs through GPS (Guia da Previdência Social) (Social Security Form). Onlyemployees with compensation up to BRL 429,00 (maximum limit stated by the government at companylevel, that is, for all employees) are entitled to receive Family Allowance. Current value of the familyallowance quota is of BRL 10,31.

Determining Contributions For Contracting Independent WorkersCompanies are required to contribute with 20 percent rate on the value of services rendered byindependent workers. Contribution must be paid together with other company contributions through GPS.

Determining Contributions for Compensation Paid to BusinessmenA contribution of 20 percent rate is applicable on values paid on the account of compensation to insuredbusinessmen. Contribution must be paid together with company's other contributions through the GPSform.

Calculating Social Security (INSS) Payments

This topic discusses how the system calculates social security (INSS) per employee.

Video: Image Highlights, PeopleSoft HCM Update Image 34: Global Payroll for Brazil -- INSSCalculation Changes

Calculating INSS with IN BR PCT INSS Bracket DataBracket IN BR PCT INSS (INSS Table) stores the information that is used to calculate certain socialsecurity taxes to be paid by employees.

In this table, each contribution salary range (with the minimum amount of the range listed in the INVR BASE INSS column) is associated with a tax percentage value, an accumulated INSS amount fromprevious salary ranges, and the minimum amount of the current range for tax calculations.

This table lists the INSS data in bracket IN BR PCT INSS, published by the Government in year 2020:

340 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 15 Calculating Social Security Contributions

IN VR BASE INSS

(Bracket Search Key)

IN BR PCT INSS

(Bracket ReturnColumn)

IN VR VLR AC FAIXA

(Bracket Return Column)

IN VR VLR FX ATUAL

(Bracket Return Column)

0.000000 7.500000 0.000000 0.000000

1045.000000 9.000000 78.370000 1045.000000

2089.600000 12.000000 172.380000 2089.600000

3134.400000 14.000000 297.750000 3134.400000

6101.060000 14.000000 713.080000 6101.060000

The system uses information from the INSS table to calculate INSS and INSS for income tax deductions.

See Also Calculating INSS and Calculating INSS for Income Tax.

INSS tax is calculated using a progressive calculation system in which an employee’s taxable incomeis taxed at an increasing rate as the income increases, up to the maximum contribution limit. Based onthe INSS table listed, for an employee who earns a monthly pay of $3600, the first range of monthly payup to $1044.99 is taxed at 7.5%, the second range between $1045 and $2089.59 at 9%, the third rangebetween $2089.60 and 3134.39 at 12%, and the remaining $465.60 ($3600 - $3134.4) at 14%.

Calculating INSS - Salary for ContributionDeduction INSS SAL CON (INSS - Salary for Contribution) uses the Amount calculation rule, wherethe amount is determined by formula IN FM SAL CONTR (INSS Salary for Contrib. Calc). Formula INFM SAL CONTR calculates the INSS salary contributions as the minimum of variable IN VR LIM INSS(legal limit for INSS) and accumulator INSS BASE TOTAL (Social Security Accumulator).

Deduction INSS SAL CON (INSS - Salary for Contribution) is a "dummy" deduction, created to keep thisamount and also for demonstration.

The INSS BASE TOTAL accumulator contains all the employee earnings that contribute toward INSS.

The base calculation amount (accumulator) is compared to the (legal) limit amount for contribution and isused as the contribution amount if the base is less than or equal to the limit.

Note: You have to keep both the total base of employees and the amount base for contribution values forreporting requirements.

If the INSS BASE TOTAL accumulator is less than the limit in variable IN VR LIM INSS, thenaccumulator INSS BASE TOTAL ⇒ deduction INSS SAL CON. If accumulator INSS BASE TOTAL isgreater than the limit in variable IN VR LIM INSS, then IN VR LIM INSS ⇒ deduction INSS SAL CON.

When the INSS BASE TOTAL accumulator includes the employee total base, a "dummy" deduction,INSS SAL CON, is used to ensure that the amount is considered in the contribution calculation.

Copyright © 1988, 2022, Oracle and/or its affiliates. 341

Calculating Social Security Contributions Chapter 15

Calculating INSSDeduction INSS (INSS) uses the Base × Percent calculation rule where the Base is determined bydeduction INSS SAL CON (INSS - Salary for Contribution) and the Percent is determined by formula INFM INSS ALIQ EF (INSS Effective Tax Rate).

Formula IN FM INSS ALIQ EF returns the actual tax rate that is used to calculate the INSS amounts.It uses the employee's salary contribution base to obtain the corresponding tax percentage value,accumulated INSS amount (from previous salary ranges), and INSS current step amount (the minimumamount of the current salary range) from bracket IN BR PCT INSS. First, it subtracts the INSS currentstep amount from the salary contribution base to get the taxable amount from the highest salary range,and multiplies this amount by the tax percentage to get the INSS amount to be paid for the highest salaryrange. Then, it calculates the actual tax rate by adding this INSS amount and the accumulated INSSamount from previous salary ranges, multiplying the subtotal by 100, and dividing it by the employee'ssalary contribution base.

Suppose that an employee’s salary for contribution is $3,600.00, and based on the INSS table listed inthe Calculating INSS with IN BR PCT INSS Bracket Data section, the corresponding tax percentage,accumulated INSS amount, and INSS current step amount are 14%, $3134.40, and $297.75.

The actual tax rate is calculated as:

($3600 - $3134.40) * 14 / 100 = $65.184($65.184+ $297.75) *100 / $3600= 10.0815

Using the Base × Percent calculation rule, the INSS amount (or deduction) is calculated as:

$3600 * 10.0815% = $362.93

The deduction adds to the TOTAL DESCONTOS N (Deductions Total Not Maintained), PA INSS (INSSBase), INSS_VRPER (INSS), and INSS_VRMEN (INSS) accumulators.

CPMF has expired. The system defines the same percentage in bracket IN BR PCT INSS for the bracketresult and for the IN VR PCT INS CPMF variable, which is used to calculate the INSS deduction.

Calculating INSS for Income TaxDeduction INSS CALC IR (INSS for Income Tax) uses the Base × Percent calculation rule where theBase is determined by deduction INSS SAL CON (INSS - Salary for Contribution) and the Percentage isdetermined by formula IN FM INSS ALIQ EF (INSS Effective Tax Rate). Refer to the Calculating INSSsection for more information about formula IN FM INSS ALIQ EF.

The deduction contributes to the IR DEDUÇÕES (Income Tax Deductions) accumulator and correspondsto the INSS amount calculated by using the INSS effective tax rate.

This is a "dummy" deduction and the amount is deductible for Income Tax and is used for legal reports.

Calculating INSS for Special RetirementAll of the deductions—IN GPS APO15 (SS – Retirement, 15 Years), IN GPS APO20 (SS – Retirement,20 Years) and IN GPS APO25 (SS- Retirement, 25 Years)—use the Base × Percent calculation rule where

342 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 15 Calculating Social Security Contributions

the Base is determined by accumulator INSS BASE TOTAL and the percentage is determined by therelated variables, respectively IN VR SAT PCT 15, IN VR SAT PCT 20 and IN VR SAT PCT 25.

The deductions also use the related Generation Controls—IN GC VERIF APO 15, GC VERIF APO 20,and GC VERIF APO 25, respectively.

According to the SEFIP Risk Level value on the Payee Parameters page, one of these three dummydeductions should be calculated. If the value is Default, the default value can be found on the Position/Jobcode Parms BRA page. These default values can de defined per position, per location and associatedjob code, per location, or per job code. You build the rules that define how the system should handle thesevalues, in case of different options for location and job.

Note: The percentage variables are automatically populated by the system.

Running the GPS Report

This section discusses how to run the GPS report.

Page Used to Run the GPS Report

Page Name Definition Name Usage

GPS Report BRA Page GPBR_RC_GPS Run the GPS report (GPBRGP01) for theselected establishment and time period.

GPS Report BRA PageUse the GPS Report BRA page (GPBR_RC_GPS) to run the GPS report for the selected establishmentand time period.

Navigation:

Global Payroll & Absence Mgmt >Social Security / Insurance >GPS Report BRA >GPS ReportBRA

Copyright © 1988, 2022, Oracle and/or its affiliates. 343

Calculating Social Security Contributions Chapter 15

This example illustrates the fields and controls on the GPS Report BRA page.

Field or Control Description

Year Enter a 4-digit number representing the year for which theGPS report runs.

Month Enter between 01 to 13 representing the month of the year forwhich the GPS report runs. The number 13 represents the 13thmonth salary.

13th Salary Base Select to generate the GPS report with INSS contributions forthe 13th month salary (for example, in case of terminations).

Related LinksUnderstanding the 13th Salary

344 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 16

Withholding Income Tax (IRRF)

Understanding Income Tax Withholding

Global Payroll for Brazil provides rules and elements to calculate and deduct withholding of income taxusing the graduated tax rate for monthly payroll, 13th salary, and vacation payments.

This section discusses:

• Income tax rates and amounts.

• Allowable tax deductions.

• Income tax calculation.

• Special tax withholding situations.

Income Tax Rates and AmountsTo set up and maintain the parameters for calculating income tax withholding using the template providedby PeopleSoft, you must:

• Update the IRRF table when changes to deductible tax rates and installments occur.

PeopleSoft delivers the IRRF table as a bracket (IR BR % IRRF). As the graduated tax table mightvary during the year, you must maintain this bracket and retain the previous versions. The brackets areeffective-dated. Calculations use the bracket in effect as of the payroll payment date.

• Update the following variables containing values for income tax calculation when changes occur:

Variable Description

IR VR MIN IR Minimum amount of income tax withholding.

IR VR VRDED DEP Amount of the deduction per dependent.

IR VR VRDED APO Retirement deduction amount.

• Ensure the elements composing the deductions for the income tax calculation are defined as membersof the respective accumulator.

The following table lists the accumulators for each type of income tax calculation:

Copyright © 1988, 2022, Oracle and/or its affiliates. 345

Withholding Income Tax (IRRF) Chapter 16

Income Tax Calculation Type Accumulator

Monthly payment IR DEDUÇÕES

13th salary IR DEDUÇÕES 13S

Vacation IR DEDUÇÕES FER

• Ensure the elements composing the gross income for the income tax calculation are defined asmembers of the respective accumulator.

These accumulators can include earnings and deductions such as Unjustified Absence.

The following table lists the accumulators for each type of income tax calculation:

Income Tax Calculation Type Accumulator

Monthly payment IR RENDA BRUTA

13th salary IR REN BRUTA 13S

Vacation IR REN BRUTA FER

Allowable Tax DeductionsThe accumulators for each type of income tax calculation (IR DEDUÇÕES, IR DEDUÇÕES 13S, andIR DEDUÇÕES FER) accumulate allowable tax deductions. Global Payroll for Brazil provides delivereddeductions elements for the following allowable deductions:

• Alimony in compliance with court decision including pensions.

• Deductions for qualifying dependents.

• Contributions to social security (INSS).

• Contributions for private pension fund and the individual planned retirement fund (FAPI).

• Income from retirements and pensions.

Data for Retirement and Dependent Deductions

To ensure that the system calculates the proper deductions:

• Select the IR Ded Retirement check box on the Payee Parameters page (Global Payroll & AbsenceMgmt > Payee Data > Define Payee Parameters BRA) for payees who are inactive retirees.

Inactive retirees are entitled to an additional deduction from their gross income for income taxpurposes.

346 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 16 Withholding Income Tax (IRRF)

• Enter dependent data on the Dependent Information - Personal Profile page in PeopleSoft HR.

Calculating Dependents

Using the information entered for each dependent in PeopleSoft HR (gathered using an array), the systemuses the formula IR FM NUM DEP IR to determine whether each dependent meets the conditions thatenable an employee to claim an income tax deduction for the dependent. For example, the dependent'seconomic status must be Dependent or Dependent/Beneficiary to qualify as a dependent for income taxpurposes. The system flags each dependent that meets these criteria.

When calculating income tax, the system multiplies the total number of dependents by the deductionamount per dependent to determine the employee's total deduction amount for dependents.

You can view the number of dependents for income tax on the Review Dependent Data BRA page.

See Viewing Dependents.

Related LinksUnderstanding Deduction Types"Tracking Dependent and Beneficiary Data" (PeopleSoft Human Resources Administer Workforce)Payee Parameters Page

Income Tax CalculationEach calculation type has its own income tax deduction element.

To determine the income tax withholding, each income tax deduction element:

1. Runs a preprocess formula that determines the calculation base and stores it in a variable (IR VR RENLIQUID).

The formula obtains the calculation base by deducting the income tax deduction accumulator from thegross income accumulator.

2. Runs the generic income tax calculation formula (IR FM IRRF).

This formula is common to the deduction elements for all the income tax calculation types. Theformula:

a. Applies the tax rate from the IRRF table (IR BR % IRRF) to the calculation base and determinesthe amount to withhold for income taxes.

b. Compares the calculated amount to withhold for income taxes to the minimum amount towithhold for taxes.

If the calculated amount is less than the minimum amount, the employee's amount to withhold forincome taxes equals zero.

The following table lists the income tax deduction elements and preprocess formulas for each income taxcalculation type:

Copyright © 1988, 2022, Oracle and/or its affiliates. 347

Withholding Income Tax (IRRF) Chapter 16

Income Tax Calculation Type Income Tax Deduction Element Pre-Process Formula

Monthly payment IRRF IR FM IRRF SAL

13th salary IRRF 13 SAL IR FM IRRF 13SAL

Vacations IRRF FER IR FM IRRF FER

Related LinksCalculating Earnings

Special Tax Withholding SituationsThis section provides information about special tax withholding situations.

Salary Advance

If the salary advance is completed within the month that the income is earned (just paid early within thesame month) the tax calculation is normal. In this case, there is no Income Tax calculation. However,if the advance is paid in a month other than the month in which the respective payment occurred, theadvance is taxed in the month in which it is paid along with other earnings for the same period. For thiscalculation use the variable IR VR REG CX.

Viewing Delivered ElementsThe PeopleSoft system delivers a query that you can run to view the names of all delivered elementsdesigned for Brazil. Instructions for running the query are provided in the "Understanding How to ViewDelivered Elements" (PeopleSoft Global Payroll) topic.

Viewing Dependents

This topic discusses how to view an employee's dependents.

348 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 16 Withholding Income Tax (IRRF)

Page Used to View Dependents

Page Name Definition Name Usage

Review Dependent Data BRA Page GPBR_DEPEND_SUMM View information about an employee'sdependents, including how manydependents are eligible for Income Taxdeductions.

You can also view the number ofdependents for other purposes, suchas family allowance and child careallowance.

Review Dependent Data BRA PageUse the Review Dependent Data BRA page (GPBR_DEPEND_SUMM) to view information about anemployee's dependents, including how many dependents are eligible for Income Tax deductions.

You can also view the number of dependents for other purposes, such as family allowance and child careallowance.

Navigation:

Global Payroll & Absence Mgmt > Payee Data > Review Dependent Data BRA > ReviewDependent Data BRA

This example illustrates the fields and controls on the Review Dependent Data BRA page.

Number of Dependents

Field or Control Description

As Of Date Displays the date of the most recent payroll calculation.

Family Allowance, Income Tax, and Child Care Displays the number of qualifying dependents for familyallowance, income tax, and child care purposes as calculatedby the most recent payroll.

Copyright © 1988, 2022, Oracle and/or its affiliates. 349

Withholding Income Tax (IRRF) Chapter 16

Dependents Detail

This group box displays a summary of the information entered for each dependent on the DependentInformation - Personal Profile page. Use this data to validate the number of qualifying dependents foreach purpose that appears in the Number of Dependents group box.

Running the Income Tax Report

This topic lists the pages used to run the Income Tax report.

Pages Used to Run the Income Tax Report

Page Name Definition Name Usage

Dependnt Statmnt IncomeTax BRAPage (dependent statement income taxBRA page)

GPBR_RC_INCTAX Generate the Depend Statement IncomeTax BRA report (GPBRDE01) thatshows the details of the employee'sdependent data used for calculatingincome tax.

The employee uses this document todeclare his or her dependents for IncomeTax. The employee should sign thisdeclaration and is responsible for thisinformation.

DARF Report BRA Page GPBR_RC_DARF Generate the Monthly CompanyPayment of the Withholding Tax Report (GPBRDA01).

Related LinksGlobal Payroll for Brazil Reports: A to Z

Generating Declaration of Withholding Tax (DIRF) Reports

To set up parameters for DIRF reporting, use the DIRF Parameters BRA (GPBR_PARM_DIRF)component.

This topic provides an overview of DIRF reporting and discusses how to produce DIRF reports.

350 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 16 Withholding Income Tax (IRRF)

Pages Used to Produce DIRF Reports

Page Name Definition Name Usage

DIRF Parameters BRA Page GPBR_PARM_DIRF Enter DIRF parameters for a company. The parameters are used to produce theannual DIRF report.

Monthly DIRF Report BRA Page GPBR_RC_DIRF_MENS Generate a monthly DIRF report for acompany or establishment.

DIRF Report BRA Page GPBR_RC_ANNDIRF Generate a company's annual DIRFreport.

Income & Taxes Page GPBR_AU_DIRF Enter company’s annual income and taxcontributions for autonomous workers.

Health Service Page GPBR_AU_DIRF_HS Enter company’s annual health carecontributions for autonomous workers.

Understanding DIRF ReportingYou can use Global Payroll for Brazil to produce a monthly report (GPBRDI01) that shows eachindividual's taxable income, deductions, and withholding tax for the reported month. The system can alsogenerate the annual DIRF report (GPBRDI02, Declaração do Imposto Retido na Fonte).

Note: To identify who is responsible for producing the DIRF report for an establishment, use theAdditional Info - Brazil page in the Administer Workforce business process of PeopleSoft HR.

See "(BRA) Setting Up Brazilian Workforce Tables" (PeopleSoft Human Resources AdministerWorkforce).

Monthly DIRF Report

You can generate the monthly DIRF report for an entire company or a selected establishment. Youcan select the run types or pay groups to consider and can include employees, contingent workers, orpersons of interest. When you run the report, you identify the elements that store the values for the taxableincome, deductions, and withholding tax amounts that appear in the report.

This is simply a control report, once the DIRF is an annual and legal Brazilian report. This report enableyou to have monthly control of the taxes and taxable amounts.

Annual DIRF Report

Before you can produce a company's annual DIRF report, you must use the DIRF Parameters pageto select the default establishment and contact person responsible for submitting the report, and anyadditional data, such as employee ID and establishment ID, that will help you identify the individualslisted in the report. You also select the earnings and deductions to include in the report, and specify which

Copyright © 1988, 2022, Oracle and/or its affiliates. 351

Withholding Income Tax (IRRF) Chapter 16

elements represent taxable income, deductions, or withholding tax. (When you run the report, you canoverride the default values for the responsible establishment, company, or DIRF contact.)

DIRF Parameters BRA PageUse the DIRF Parameters BRA page (GPBR_PARM_DIRF) to enter DIRF parameters for a company.

The parameters are used to produce the annual DIRF report.

Navigation:

Set Up HCM > Product Related > Global Payroll & Absence Mgmt > Taxes > DIRF ParametersBRA > DIRF Parameters BRA

This example illustrates the fields and controls on the DIRF Parameters BRA page (1 of 2).

352 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 16 Withholding Income Tax (IRRF)

This example illustrates the fields and controls on the DIRF Parameters BRA page (2 of 2).

Establishment Responsible

Field or Control Description

Establishment ID Select the establishment that is responsible for producing thecompany's DIRF report.

Company Responsible

Identify the employee or non-employee who is responsible for generating the DIRF report.

Health Provider Source

Use this section to enter health care-related payee and dependent information. The system uses thisinformation to determine where to look for the health care information to be displayed in the DIRF report.The same information is also collected for use in the IREN report.

Copyright © 1988, 2022, Oracle and/or its affiliates. 353

Withholding Income Tax (IRRF) Chapter 16

Field or Control Description

Health Provider Source Select the source from which the system collects healthprovider information for the report. Values are:

• Both: The system collects the health care-related payeeand dependent information that is entered in the HealthProviders Payroll Data Definition section of this page, as well as on the Employee Other Annual Amt BRAPage.

• From Other Annual Amounts Page: The system collectsthe health care-related payee and dependent informationthat is entered on the Employee Other Annual Amt BRAPage.

• From Payroll Results. The system collects the healthcare-related payee and dependent information from thecalculated payroll results, as instructed in the HealthProviders Payroll Data Definition section of this page.

Leave the field blank if you don’t want to report healthprovider information.

Health Providers Payroll Data Definition

Enter information in this section if From Payroll Results or Both is selected as the health provider source.

Note: Be sure to add element ASSMEDICADEP for the Dependent health type.

Field or Control Description

Health Type Specify the health type, Dependent or Employee.

Element Name Select an element.

Note: Be sure to prepare health provider deductions withuser field variables. Then, override the character value of thevariables on the Element Assignment By Payee - "ElementDetail Page" (PeopleSoft Global Payroll).These values must be overridden before the calculation ofpayroll.

Health Provider User Field # (health provider user fieldnumber)

Specify the field where health provider name is stored inpayroll calculation, User field 1 through 6.

354 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 16 Withholding Income Tax (IRRF)

Field or Control Description

Dependent User Field # (dependent user field number) Specify the field where dependent ID is stored in payrollcalculation, User field 1 through 6. This field is available foredits if the selected health type is Dependent.

DIRF Data

You can add or remove the appropriated earnings or deductions to the report based on an accumulator byselecting the appropriate values in the Payroll Type andParameter Type fields of the page. Then, clickthe Add Earnings/Deductions button or theRemove Earnings/Deductions button and the system addsor removes the appropriate earnings or deductions, based on the accumulator you specified.

Use these fields to identify the earnings and deductions that are to be included in the report.

Field or Control Description

Payroll Type Select the payroll type for the earning or deduction: 13th. Salary, Profit Sharing Program or Regular Payroll.

Parameter Type Identify whether the value represents:

>=65 Non Taxable Prt Incme

Alimony

Credit Vacation

Dependents

Official Welfare

Other Non-Taxable Income

PLR - Alimony

PLR - Taxable Income

PLR - Withholding Tax

Per Diary & Cost Allowances

Private Welfare and FAPI

Taxable Income

Termination Indemnity

Withholding Tax

Copyright © 1988, 2022, Oracle and/or its affiliates. 355

Withholding Income Tax (IRRF) Chapter 16

Field or Control Description

Entry Type Specify whether the listed payroll type is an earning or adeduction.

Private Fund & FAPI Select the private fund and FAPI entity if the selectedparameter type is Private Welfare and FAPI.

Private fund and FAPI entities are defined on the "PrivateFund & FAPI Entities Page" (PeopleSoft Human ResourcesAdminister Workforce).

Monthly DIRF Report BRA PageUse the Monthly DIRF Report BRA page (GPBR_RC_DIRF_MENS) to generate a monthly DIRF reportfor a company or establishment.

Navigation:

Global Payroll & Absence Mgmt > Taxes > Monthly DIRF Report BRA > Monthly DIRF ReportBRA

This example illustrates the fields and controls on the Monthly DIRF Report BRA page.

356 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 16 Withholding Income Tax (IRRF)

Parameters

Field or Control Description

Company Select the company to which the report pertains.

Establishment ID To include data for a specific establishment only, select theestablishment here.

Organizational Relationship Specify whether you are running the report for employees, contingent workers, or persons of interest.

Date Criteria Select the date used for gathering payroll result information forthe report. Values are:

Payment Date: The payment date of the calendar group.

Period End Date: The end date of the calendar group.

Control Type

To produce the report for all pay groups that are associated with particular run types, select By Run Typeand enter the run types. To produce the report for selected pay groups, select By Pay Group and enter thepay groups and associated run types.

Earnings and Deductions

Use these fields to identify the earnings and deductions that are to be included in the report.

Field or Control Description

Payroll Type Select the payroll type for the earning or deduction: 13th. Salary, Profit Sharing Program or Regular Payroll.

Copyright © 1988, 2022, Oracle and/or its affiliates. 357

Withholding Income Tax (IRRF) Chapter 16

Field or Control Description

DIRF Parameter Type Identify where each value is to be reported. The reportcontains the following categories:

• Compensated tax current year

• Compensated tax previous year

• Deduction suspended liability

• Deductions

• Income tax in court deposit

• Income tax suspended liability

• Taxable income

• Withholding tax

• Withholding tax sus. liability

Element Select an element for the specified payroll type.

Entry Type Specify whether the value represents an accumulator, deduction, or earning.

DIRF Report BRA PageUse the DIRF Report BRA page (GPBR_RC_ANNDIRF) to generate an annual DIRF report for acompany or establishment.

Navigation:

Global Payroll & Absence Mgmt > Year-End Processing > DIRF Report BRA > DIRF ReportBRA

358 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 16 Withholding Income Tax (IRRF)

This example illustrates the fields and controls on the DIRF Report BRA page.

Field or Control Description

Company Enter a company for which the DIRF report is run.

Estab ID (establishment ID) Enter a company establishment for which the DIRF report isrun.

If no establishment is specified, the report includes allestablishments of the selected company.

Calendar Year Enter the year for which you are reporting data.

Identifier Code Enter a 7-character DIRF report code provided by theGovernment for the specified calendar year.

Declaration Status

Select Normal or Other.

If you select Other as the declaration status, identify the event type, Dispossession or Termination, andenter the date.

Declaration Type

Select Original if this is the first time you are submitting this report. Select Rectifier if this reportcorrects one that was previously submitted. Enter the receipt number for the previously submitted report.

Copyright © 1988, 2022, Oracle and/or its affiliates. 359

Withholding Income Tax (IRRF) Chapter 16

Overrides

Use this section to enter instructions for overriding the responsible establishment or company thatis identified on the DIRF Parameters BRA Page. The information that you enter here is used for thisinstance of the report only.

Income & Taxes PageUse the Income & Taxes page (GPBR_AU_DIRF) to enter company’s annual income and taxcontributions for autonomous workers.

Navigation:

Global Payroll & Absence Mgmt >Year-End Processing >DIRF Autonomous BRA >Income &Taxes

This example illustrates the fields and controls on the Income & Taxes page.

Autonomous persons are workers who perform their jobs without establishing employment relationshipswith employers.

Autonomous Person Data

Field or Control Description

CPF National ID Enter the CPF national identifier of the autonomous worker.

Display Name Enter the name or title to be printed on the report.

Reference Enter the reference information for the report.

360 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 16 Withholding Income Tax (IRRF)

Autonomous Amounts Data

Field or Control Description

Parameter Type Select the type for the amount values entered for the monthfields.

January through 13th Enter an amount for one or more months plus the 13th salary.

Health Service PageUse the Health Service page (GPBR_AU_DIRF_HS) to enter company’s annual health care contributionsfor autonomous workers.

Navigation:

Global Payroll & Absence Mgmt >Year-End Processing >DIRF Autonomous BRA >HealthService

This example illustrates the fields and controls on the Health Service page.

Health Provider

Use this section to enter health care-related information for autonomous workers.

Copyright © 1988, 2022, Oracle and/or its affiliates. 361

Withholding Income Tax (IRRF) Chapter 16

Field or Control Description

Health Provider CNPJ Select a health provider code.

Health provider codes are defined on the "Health ProvidersPage" (PeopleSoft Human Resources Administer Workforce).

CPF National ID Select a CPF national ID.

CPF national IDs are defined on the Income & Taxes Page.

Dependent Information

Use this section to enter health care-related information for dependents of autonomous workers.

Generating Document for the Collection of Federal Revenues(DARF) Reports

To set up parameters for DARF reporting, use the DARF Parameters BRA (GPBR_PARM_DARF)component.

This topic provides an overview of DARF reporting and discusses how to produce DARF reports.

Pages Used to Produce DARF Reports

Page Name Definition Name Usage

DARF Parameters BRA Page GPBR_PARM_DARF Enter DARF parameters for a company.

The parameters are used when producingthe DARF report.

DARF Report BRA Page GPBR_RC_DARF Generate a company's DARF report.

Understanding DARF ReportingYou can use Global Payroll for Brazil to produce a monthly report (GPBRDA01, Documento deArrecadação de Receitas Federais) that shows each company’s or company employee’s tax payment aswell as any late charge that are due for the reported month.

Enter DARF parameters (by company) before running the DARF report.

DARF Parameters BRA PageUse the DARF Parameters BRA page (GPBR_PARM_DARF) to enter DARF parameters for a company.

362 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 16 Withholding Income Tax (IRRF)

The parameters are used to produce the DARF report.

Navigation:

Set Up HCM > Product Related >Global Payroll & Absence Mgmt >Taxes >Parameters DARFBRA >Parameters DARF BRA

This example illustrates the fields and controls on the DARF Parameters BRA page.

Note: For each effective date, code, format ID, and taxable period combination, specify the classes ofemployees to be included in the DARF report.

DARF Parameters BRA

Field or Control Description

Code Enter the code of the tax being paid. These codes aremaintained by the IRS (Receita Federal).

Format ID Specify the ID of the format used for this report. Choosefrom the list of elements to add to, subtract from, or both, theamount of tax withholding payable by the employee.

Format IDs are defined on the Element Lists BRA Page.

Copyright © 1988, 2022, Oracle and/or its affiliates. 363

Withholding Income Tax (IRRF) Chapter 16

Taxable Period

Field or Control Description

Triggering Date Select this option for the system to populate the Begin Dateand End Date fields of the DARF period to be identical towithholding period date on the DARF Report BRA Page.

Taxable Period Select this option to make these fields required for entryon the DARF Report BRA Page to run the DARF report:WIthholding Period, Date Due, as well as the Begin Dateand End Date of the DARF period.

Employee Class

Field or Control Description

Employee Classification Select one or more classes of employees to be included in theDARF report.

Employee classes are defined on the Employee LaborClassification page (EMPL_CLASS_TABLE).

See "Defining Additional Employment SetupData" (PeopleSoft Human Resources Administer Workforce)for more information.

DARF Report BRA PageUse the DARF Report BRA page (GPBR_RC_DARF) to generate a company's DARF report.

Navigation:

Global Payroll & Absence Mgmt >Taxes >DARF Report BRA >DARF Report BRA

364 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 16 Withholding Income Tax (IRRF)

This example illustrates the fields and controls on the DARF Report BRA page.

Use this page to specify values that are displayed on the DARF report.

DARF Generation

Field or Control Description

Establishment ID Enter the ID of a centralized establishment for the DARFreport. The selected establishment identifies the company thatis printed on the DARF report.

See Also Centralization Data Page

Copyright © 1988, 2022, Oracle and/or its affiliates. 365

Withholding Income Tax (IRRF) Chapter 16

Field or Control Description

Code Select the code of the tax being paid, which gets displayed onthe report.

Withholding Period Specify the end date of the assessment period to be displayedon the report. For example, you may enter January 31 for themonth of January.

Due Date Specify the due date, for example, February 15 for theassessment month of January, of the tax payment to bedisplayed on the report.

Fine Percentage, Fine Factor, Interest Percentage andInterest Factor

Enter percentage or factor numbers for calculating late finesand interests.

Numbers entered in these fields (percentage or factor number)are used to calculate fine and interest values that are displayedon the report.

DARF Generation

Field or Control Description

Element List Displays the element associated with the code that is selectedon this page.

DARF Period

Enter the period (a month) to which the tax payment pertains. For example, you may enter January 1through January 31 as the DARF calculation period.

The system automatically populates the begin and end dates with the date that is specified as thewithholding period on this page, if the Triggering Date option is selected on the DARF Parameters BRAPage. These dates are not prepopulated, if the Taxable Period option is selected.

Establishment ID

If you wish to print the report for some but not all establishments for the identified company, specify themhere.

Employees

If you wish to print the report for a refined list of employees, specify them here.

366 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 16 Withholding Income Tax (IRRF)

Generating the Statement of Income and Withholding Tax (IREN)Report

To set up parameters for IREN reporting, use the IRRF Parameters BRA (GPBR_IREN) component.

This topic provides an overview of the Comprovante Anual de Rendimentos Pagos e de Retenção deImposto de Renda na Fonte - Pessoa Física report (Statement of Income and Withholding Tax or IRENreport), lists prerequisites, and discusses how to produce the IREN report.

Pages Used to Produce the IREN Report

Page Name Definition Name Usage

Recpnt/Benef Relationship BRA Page (recipient/beneficiary relationship BRApage)

GPBR_RECBEN_REL Identify which of a payee's deductionrecipients to include in the annual IRENreport.

IREN Parameters BRA Page GPBR_IREN Define IREN parameters for a company.

IREN Report BRA Page GPBR_RC_IREN Generate the IREN report.

Understanding the IREN Reporting ProcessTo produce the IREN report, you identify the elements that calculate the values shown in the report. Toinclude deductions that were paid to certain recipients, you must select the recipients before generatingthe report.

Recpnt/Benef Relationship BRA PageUse the Recpnt/Benef Relationship BRA (recipient/beneficiary relationship BRA) page(GPBR_RECBEN_REL) to identify which of a payee's deduction recipients to include in the annualIREN report.

Navigation:

Global Payroll & Absence Mgmt > Payee Data > Net Pay/Recipient Elections > Recpnt/BenefRelationship BRA > Recpnt/Benef Relationship BRA

Copyright © 1988, 2022, Oracle and/or its affiliates. 367

Withholding Income Tax (IRRF) Chapter 16

This example illustrates the fields and controls on the Recpnt/Benef Relationship BRA page..

For the selected employee, identify any deduction recipients that are to be included in the IREN report.Deductions paid to the selected recipient will be listed in the report along with the recipient's name. (Usethe Add Deduction Recipients page to specify which deduction a recipient is to receive.)

Related Links"Assigning Recipients to Deductions and Payees" (PeopleSoft Global Payroll)

IREN Parameters BRA PageUse the IREN Parameters BRA page (GPBR_IREN) to define IREN parameters for a company.

Navigation:

Set Up HCM > Product Related > Global Payroll & Absence Mgmt > Taxes > IRRF ParametersBRA > IREN Parameters BRA

368 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 16 Withholding Income Tax (IRRF)

This example illustrates the fields and controls on the IREN Parameters BRA page.

Each section of this page corresponds to a section of the report that has the same name. Map the reportfields in each section to the elements that will provide the values for these fields.

Add/Remove by Accumulator

You can add or remove earnings or deductions to a section of the report by selecting the appropriate reportsection in the IREN Section region of the page. Then, specify the Report Field and Accumulator, andfinally click the Add Earnings/Deductions button or the Remove Earnings/Deductions button and thesystem adds or removes the appropriate earnings or deductions, based on the accumulator you specified.

Field or Control Description

IREN Section Click the name of the report section for which you wish to addor remove earnings or deductions.

Report Field Select the field in the IREN report, based on the section youchoose, for which you wish to add or remove earnings ordeductions.

Accumulator Specify the accumulator for which you want to add or removeearnings or deductions.

Copyright © 1988, 2022, Oracle and/or its affiliates. 369

Withholding Income Tax (IRRF) Chapter 16

Field or Control Description

Add Earnings/Deductions and Remove Earnings/Deductions

Click to add or remove the earnings or deductions to the IRENreport based on the specified accumulator.

Report Sections Regions

For each report section, specify the entries in the report fields that you want to include in the report.

Field or Control Description

Report Field Specify the report field for which you wish to add elements.

Entry Type Specify whether the element is either an earnings element or adeductions element.

Element Name Specify the element name that you wish to add to the specifiedsection of the report.

Private Fund & FAPI Entities Select the private fund and FAPI entity if the selected report is03-Cntribs Private Fund.

Private fund and FAPI entities are defined on the "PrivateFund & FAPI Entities Page" (PeopleSoft Human ResourcesAdminister Workforce).

IREN Report BRA PageUse the IREN Report BRA page (GPBR_RC_IREN) to generate the IREN report.

Navigation:

Global Payroll & Absence Mgmt > Taxes > IRRF Report BRA > IREN Report BRA

370 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 16 Withholding Income Tax (IRRF)

This example illustrates the fields and controls on the IREN Report BRA page.

Field or Control Description

Organizational Relationship You can generate the report for employees, contingentworkers, or persons of interest.

Income Nature You can include salaried or unsalaried workers.

Responsible ID Identify the person who is responsible for this report.

Date Enter the date to print on the report.

Viewing Delivered Income Tax Elements

This topic lists:

• Delivered income tax deductions.

• Delivered income tax earnings.

• Delivered income tax sections.

Note: PeopleSoft delivers a query that you can run to view the names of all delivered elements that aredesigned for Brazil.

Related Links"Understanding How to View Delivered Elements" (PeopleSoft Global Payroll)

Copyright © 1988, 2022, Oracle and/or its affiliates. 371

Withholding Income Tax (IRRF) Chapter 16

Deductions for Income TaxGlobal Payroll for Brazil calculates the following tax deductions:

Deduction Description

IR DEDUC DEP Calculates and maintains the dependents deduction amount. Demo Deduction. It doesnot change the net amount.

IR DEDUC APO Calculates and maintains the additional retirement deductions. Demo Deduction. Itdoes not change the net amount.

IRRF Income tax deduction calculated for monthly payroll.

IRRF 13 SAL Income tax deduction calculated for 13th salary.

IRRF FER Income tax deduction calculated for vacation.

IRRF FE DIF Vacation IRRF Differences (Retro)

IRRF FER PAG Paid Vacation IRRF

Earnings for Income TaxGlobal Payroll for Brazil calculates only one earning:

Deduction Description

IRRF REST Refund of improperly withheld income tax. Calculated by the income tax genericformula as payroll is recalculated due to cash basis activities. This earning is onlycalculated in case of income tax recalculation. One situation that causes incometax recalculation is when an advanced payment occurs in a different month than itsmonthly payment. This earning can also be calculated for vacation or 13th salaryrecalculations.

Income Tax SectionsGlobal Payroll for Brazil calculates the following tax sections:

Section Description

KR IMPOSTO RENDA Income Tax Calculation

KR IR DESC FER Vacation Taxes

372 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 17

Generating MANAD Reports

Understanding MANAD Reports

Companies in Brazil are required by law to provide information about them when requested byGovernment authorities, such as AFPS (Auditor Fiscal da Previdência Social). Authorities collect awide range of information pertaining to company’s finance, accounting, assets, workers and so on, andthese reports must be generated in a standard digital format – MANAD (Manual Normativo de ArquivosDigitais) predefined by law.

Global Payroll for Brazil provides the ability to generate the MANAD report that lists worker’s payrollinformation, such as social welfare contributions and income tax.

Setting Up MANAD ReportsTo set up the system to run MANAD reports, you need to:

1. Define MANAD report parameters for establishments to be used for running the reports.

Defining MANAD Report Parameters

2. Add relevant establishment ID types to establishments to be used for running the reports.

New types are delivered in the system for MANAD reporting: IE (Contributor State Registration), IM(Contributor Municipal Number), and SUFRAM (Registration Number in SUFRAMA).

"Additional Info - Brazil Page" (PeopleSoft Human Resources Administer Workforce)

3. (optional) Centralize establishments for the MANAD report.

"Centralization Data BRA Page" (PeopleSoft Human Resources Administer Workforce)

4. Set up the payroll rules for the report.

Make sure that in the KR INICIAL section, the GP WA Guide element is added as the WritArray(writable array) type.

"Sections - Definition Page" (PeopleSoft Absence Management)

5. Generate the MANAD report.

Generating the MANAD Report

Copyright © 1988, 2022, Oracle and/or its affiliates. 373

Generating MANAD Reports Chapter 17

Defining MANAD Report Parameters

To set up parameters for MANAD reporting, use the MANAD Parameters BRA(GPBR_MANAD_PARMS) component.

This topic discusses how to define MANAD report parameters.

Pages Used to Define MANAD Report Parameters

Page Name Definition Name Usage

MANAD Parameters BRA Page GPBR_MANAD_PARMS Map Global Payroll data to informationto be displayed on the MANAD report.

Responsible Data Page GPBR_MANAD_RESP Enter data of entity or person responsiblefor issuing the MANAD report.

Accountant Data Page GPBR_MANAD_ACCT Enter data of accountant responsible forissuing the MANAD report.

MANAD Parameters BRA PageUse the MANAD Parameters BRA page (GPBR_MANAD_PARMS) to map Global Payroll data toinformation to be displayed on the MANAD report.

Navigation:

Set Up HCM >Product Related > Global Payroll & Absence Mgmt >Reports >MANADParameters BRA >MANAD Parameters BRA

374 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 17 Generating MANAD Reports

This example illustrates the fields and controls on the MANAD Parameters BRA page (1 of 2).

This example illustrates the fields and controls on the MANAD Parameters BRA page (2 of 2).

Field or Control Description

EmplID + Empl Rcd Option (employee ID + employeerecord option)

Select to display the employee’s ID and employee record inthe MANAD report.

GL - Record K200 Select to include a chartfield value in the MANAD report.

Chartfield Indicator Select the indicator number of the chartfield value to beincluded in the MANAD report.

Print Within Period Only Select to the print data that falls within the period specified onthe run control page.

See Also MANAD File Process BRA Page

Copyright © 1988, 2022, Oracle and/or its affiliates. 375

Generating MANAD Reports Chapter 17

Run Type Data

Use this section to map payroll run types in the Global Payroll system to run types for use in the MANADreport.

For example, in a payroll run for December, there can be vacation earnings, 13th salary earnings,terminations earnings as well as deductions in addition to the regular payroll amount. When all theseamounts are paid through their specific run types, the amounts need to be recorded in the MANAD reportunder the mapped run types that are predefined for MANAD reporting.

Income Tax Calculation Base

Use this section to map the income tax base types (predefined for MANAD reporting) to accumulatorelements in the Global Payroll system. This information is used to classify each accumulator in RecordK300 according to their participation in income tax calculation bases.

Suppose that both SALARIO and PREMIO are members of the IR REN BRUTA accumulator and thisaccumulator is mapped to the 1 - Monthly Salary income tax base type in this section. In the MANADreport, the Record K300 of SALARIO and PREMIO earnings for all employees will appear with type 1 inthe Income Tax Classification field.

INSS Calculation Base

Use this section to map social welfare classifications (predefined for MANAD reporting) to elements inthe Global Payroll system. This information is used to classify each accumulator, earnings and deductionselement in Record K300 according to their participation in social security calculations.

Field or Control Description

INSS Base Type Select an INSS base type to map to a Global Payroll element.

If you select 1-Monthly Salary Base or 2-13th Salary Base, thesystem limits the entry type to Accumulator only.

The rest of the base types can be mapped to accumulator, deduction, and earnings elements.

K250 Base Select for the corresponding entry to be included in RecordK250 for MANAD.

Responsible Data PageUse the Responsible Data page (GPBR_MANAD_RESP) to enter data of the company or personresponsible for issuing the MANAD report.

Navigation:

Set Up HCM >Product Related > Global Payroll & Absence Mgmt >Reports >MANADParameters BRA >Responsible Data

376 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 17 Generating MANAD Reports

This example illustrates the fields and controls on the Responsible Data page.

Use this page to enter data for the entity (company or establishment) or person (employee or non-employee) who is responsible for issuing the MANAD report (Record 0100).

Accountant Data PageUse the Accountant Data page (GPBR_MANAD_ACCT) to enter data of the accountant responsible forissuing the MANAD report

Navigation:

Set Up HCM >Product Related > Global Payroll & Absence Mgmt >Reports >MANADParameters BRA >Accountant Data

Copyright © 1988, 2022, Oracle and/or its affiliates. 377

Generating MANAD Reports Chapter 17

This example illustrates the fields and controls on the Accountant Data page.

Use this page to enter data for the accountant (entity or person) who is responsible for issuing theMANAD report.

If the end date of the accounting service is not specified on this page, the system derives the end date bysubtracting one day from the begin date of the next responsible entity.

Generating the MANAD Report

This topic discusses how to run the MANAD report.

378 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 17 Generating MANAD Reports

Page Used to Generate the MANAD Report

Page Name Definition Name Usage

MANAD File Process BRA Page GPBR_RC_MANAD Generate the MANAD report.

MANAD File Process BRA PageUse the MANAD File Process BRA page (GPBR_RC_MANAD) to generate the MANAD report for anestablishment.

Navigation:

Global Payroll & Absence Mgmt >Absence and Payroll Processing >Reports >MANAD ReportBRA >MANAD File Process BRA

This example illustrates the fields and controls on the MANAD File Process BRA page.

Global Payroll for Brazil Reports: A to Z

Copyright © 1988, 2022, Oracle and/or its affiliates. 379

Generating MANAD Reports Chapter 17

MANAD File Data

Field or Control Description

Establishment ID Display or select an establishment for the MANAD report.

Note: Make sure that the MANAD report parameters for theselected establishment are set up properly.

MANAD Purpose Enter the purpose of generating the MANAD report.

Values are 61-AFSP Request through MPF and 90-UF InternalData.

MANAD File Type Enter the MANAD file type.

Values are 1-Importation of File and 2-Validation of File.

File Name Enter the name for the MANAD report file to be generated.

Period Information

Use this section to specify the time period for which the MANAD report generates.

Note: Make sure that the specified period has already been calculated in the system for the payees that aregoing to be included in the report.

List Set

Use this section to specify the list set to be used for the report. The list set references element groups thatinclude elements for the MANAD report.

"Setting Up List Sets" (PeopleSoft Global Payroll)

Payee Population

Use this section to select the payees to be included in the report. Select to include all payees in the system,all payees in a list built using Global Payroll's Group List feature, all payees in a group built using theGroup Build Definition feature in HR, or individual payees.

380 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 18

Managing Social Integration ProgramPayments

Understanding PIS Payment Processing

Employees who participate in the Programa de Integração Social are entitled to receive an annual incomeor allowance payment if they meet certain conditions. You can use Global Payroll for Brazil to specifywhich employees are qualified to receive PIS payments and to process payments for these employeeswhen CAIXA, the institution that administers PIS, notifies you of the PIS amounts that are owed.

Defining Parameters for Processing PIS Payments

To define parameters for PIS payment processing, use the PIS Parameters BRA (GPBR_PARM_PIS)component.

This topic provides an overview of the setup steps for PIS processing and describes how to defineparameters for PIS payments.

Pages Used to Define Parameters for PIS Payments

Page Name Definition Name Usage

PIS Parameters BRA Page GPBR_PARM_PIS Define a company's PIS parameters.

Override PIS Param Page (override PISparameters page)

GPBR_PARM_PIS_E Override a company's PIS parameters fora specific establishment.

Additional Info - Brazil Page ESTAB_TBL_BRA Identify which of a company'sestablishments will send files to CAIXAand identify the CAIXA agency.

Centralization Data Page CENTRALIZATION_BRA Identify the (centralizer) establishmentthat manages PIS processing forthe company and identify otherestablishments that will be represented inthe CAIXA file.

PIS Parameters Page GPBR_PYPIS_PARM Identify whether a selected payee isentitled to receive PIS payments.

Copyright © 1988, 2022, Oracle and/or its affiliates. 381

Managing Social Integration Program Payments Chapter 18

Page Name Definition Name Usage

PIS Assignment BRA Page GPBR_RC_PIS Run the Employee Mark / Unmark forPIS Application Engine process (GPBR_PIS_AE) to identify which payees areentitled to receive PIS payments.

Understanding Setup Steps for PIS PaymentsBefore you can process PIS payments, you must define various parameters. To define the setupparameters for a company:

• Specify the CAIXA bank to use for PIS payments, the earning elements for paying PIS income andallowance amounts, and any optional data to include for each employee in the transfer file that yousend to CAIXA.

• If an establishment's agreement with CAIXA differs from the company's agreement with CAIXA,enter the establishment's information.

• Identify which establishment within the company will transmit files to CAIXA.

• Select the establishment that will manage PIS processing and identify the other establishments forwhich PIS payments will be processed at the same time.

• Identify employees who are entitled to receive PIS payments.

You can identify employees individually or you can run a process that selects all employees of anestablishment or group, or just those employees that you select.

PIS Parameters BRA PageUse the PIS Parameters BRA page (GPBR_PARM_PIS) to define a company's PIS parameters.

Navigation:

Set Up HCM > Product Related > Global Payroll & Absence Mgmt > Social Security/Insurance >PIS Parameters BRA > PIS Parameters BRA

382 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 18 Managing Social Integration Program Payments

This example illustrates the fields and controls on the PIS Parameters BRA page.

Field or Control Description

Bank ID Select the Bank ID for CAIXA.

Company Field

Use these fields to specify additional data that you want to include in the Release of Resources file that isreturned to CAIXA. You can select any field from the PS_JOB record, such as EMPLID (employee ID)or DEPTID (department ID). When you update the Release of Resources file, the system will include, foreach listed employee, the first ten positions from the combined fields. This data can help you research andverify information in the file.

Earnings for Payment

Use these fields to select the earning element that is used to process each type of PIS payment.

Field or Control Description

Payment Type Select the payment type, Income (Rendimento) or Allowance (Abono Salarial). Enter only one row for each payment type.

Override PIS Param PageUse the Override PIS Param (override PIS parameters) page (GPBR_PARM_PIS_E) to override acompany's PIS parameters for a specific establishment.

Navigation:

Set Up HCM > Product Related > Global Payroll & Absence Mgmt > Social Security/Insurance >PIS Parameters BRA > Override PIS Param

Copyright © 1988, 2022, Oracle and/or its affiliates. 383

Managing Social Integration Program Payments Chapter 18

This example illustrates the fields and controls on the Override PIS Param page.

Select the establishment to which the override instructions apply. When processing PIS for thisestablishment, the system will use the instructions entered here rather than the instructions entered for thecompany on the PIS Parameters BRA page.

Additional Info - Brazil PageUse the Additional Info - Brazil page (ESTAB_TBL_BRA) to identify which of a company'sestablishments will send files to CAIXA and identify the CAIXA agency.

Navigation:

Set Up HCM > Product Related > Workforce Administration > Establishment BRA > AdditionalInfo - Brazil

In the PIS Data section of the page, select the Estab Responsible by Agreement check box and identifythe first four digits of the CAIXA agency the establishment has contact with.

In the Establishment ID section at the bottom of the same page, select the establishment ID type ofMCPIS and enter the ID number. The first four digits of this number must match the code for the CAIXAagency.

Related Links"(BRA) Setting Up Brazilian Workforce Tables" (PeopleSoft Human Resources Administer Workforce)

Centralization Data PageUse the Centralization Data page (CENTRALIZATION_BRA) to identify the (centralizer) establishmentthat manages PIS processing for the company and identify other establishments that will be represented inthe CAIXA file.

Navigation:

Set Up HCM > Product Related > Workforce Administration > Centralization Data BRA

Select PIS Process in the Process Type field on the search page.

384 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 18 Managing Social Integration Program Payments

Select the establishment that will send files to CAIXA in the Centralizer field. In theCentralized Datagroup box, list the establishments that will be represented in the file.

PIS Parameters PageUse the PIS Parameters page (GPBR_PYPIS_PARM) to identify whether a selected payee is entitled toreceive PIS payments.

Navigation:

Global Payroll & Absence Mgmt > Payee Data > Define Payee Parameters BRA > PIS Parameters

This example illustrates the fields and controls on the PIS Parameters page.

Field or Control Description

Reference Year Enter the year to which the PIS payments apply. The referenceyear must match the effective date.

PIS/PASEP Payment Select if the employee is qualified to receive PIS or PASEP (Public Service Employees Savings Program) payments for thereference year.

PIS Assignment BRA PageUse the PIS Assignment BRA page (GPBR_RC_PIS) to run the Employee Mark / Unmark for PISApplication Engine process (GPBR_PIS_AE) to identify which payees are entitled to receive PISpayments.

Navigation:

Global Payroll & Absence Mgmt > Social Security/Insurance > PIS Assignment BRA > PISAssignment BRA

Copyright © 1988, 2022, Oracle and/or its affiliates. 385

Managing Social Integration Program Payments Chapter 18

This example illustrates the fields and controls on the PIS Assignment BRA page.

You can use this page to specify that multiple employees are eligible to receive PIS payments for a givenyear.

Field or Control Description

Reference Year Enter the year to which the PIS payments apply. The referenceyear must match the effective date.

PIS Activated Select this check box to indicate that the selected employeesare eligible for PIS payments for the reference year.

Processing PIS Payments

This topic provides an overview of PIS payment processing, lists prerequisites, and discusses how to runPIS processes.

Page Used to Run PIS Processes

Page Name Definition Name Usage

PIS Processing BRA Page GPBR_RC_PIS_PRO Run the PIS Processing ApplicationEngine (GPBR_PISP_AE) process.

Understanding PIS Payment ProcessingPIS processing encompasses four separate processes:

• Identifying employees for payment.

386 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 18 Managing Social Integration Program Payments

• Generating PIS payment data.

• Canceling PIS payments.

• Reversing PIS payments.

To run any of these processes, you must enter the establishment ID for the designated (centralized)establishment and the reference year from which PIS is to paid.

Identifying Employees for Payment

Upon receipt of the Release of Resources file from CAIXA, which lists employees who are scheduled toreceive PIS payments, you run a validation process that identifies discrepancies between the data in thefile and your system records.

The validation process checks to see if each employee listed in the file is covered by a PIS agreement, andchecks the employee's birth date, name, and address. The validation process generates an output file thatincludes values for the additional company fields that you selected on the PIS Parameters BRA page. Italso generates a log that identifies discrepancies between data in the CAIXA file and the system.

Following are common reasons for discrepancies:

• Incompatible MCPIS with responsible Establishment – The MCPIS ID or the CNPJ ID for theresponsible establishment that is listed in the file does not match the ID that is stored in the system.

• PIS Issue PIS=0011 – The company's name, municipal name, federal unit, neighbor, CEP, phone, orfax number listed in the file does not match the data in the system.

• Employee not found using PIS code as search key – The employee is not found in the system, usingthe PIS ID listed in the file.

(An employee's PIS ID is entered on the Biographical Details page in PeopleSoft HR.)

• More than one employee with the same PIS code – The same PIS ID is assigned to more than oneemployee in the system.

• PIS Issue PID=0023 – The employee's name or birth date, as listed in the file, does not match the datain the system. (The NAME_FORMAL field is used for the validation.)

• Employee with no PIS agreement – The employee is selected for payment in the system (the PIS/PASEP check box on the Payee Parameters page is selected) but not in the file, or vice versa.

Reconcile any discrepancies that are reported in the log, run the identification process again, and send theoutput file to CAIXA.

Generating PIS Payment Data

Based on the information that you return to CAIXA, that institution sends a new file that lists only thoseemployees who are to receive PIS payments, along with the payment amounts, and the type of payment(income or allowance). When you receive this file, run the PIS - Payment process.

If the information in the file matches the information in the system, the process assigns the earningelement that is identified on the PIS Parameters BRA page to each employee who is to be paid. Youcan view the payment instructions for an employee on the Element Assignment by Payee page. Thepayment month that you enter on the run control page determines the begin and end dates on the Element

Copyright © 1988, 2022, Oracle and/or its affiliates. 387

Managing Social Integration Program Payments Chapter 18

Assignment Payee page. (Alternatively, you can use the Payee Assignment by Element page to view allassignment instructions that were created for the PIS earning element.)

The process generates a log that identifies employees for whom assignment instructions could not begenerated as a result of discrepancies between data in the CAIXA file and the system. Many of thediscrepancies are similar to those encountered during the employee identification process. Additionalreasons for discrepancies follow:

• Override exists for employee - indicates that assignment instructions for the earning element that isselected on the PIS Parameters BRA page already exist for the listed employee.

• The payment was not made for this employee - indicates the payment could not be made for a specificemployee.

• The payment was not made - this message appears in the summary section and indicates that one ormore employees are in error.

Canceling PIS Payments

The cancellation process has the effect of revoking PIS payment instructions (the earning assignment)for employees who are not entitled to receive payment. This situation can happen, for example, when anemployee is terminated after the list of payees is validated but before the payment date. You use the samefile that is used by the payment process to cancel the payment instructions before running the payrollprocess.

The cancellation process produces an output file that you send to CAIXA to inform them of scheduledpayments that were not made.

Reversing PIS Payments

This process reverses the earning assignment that the PIS payment process generated for the employee.It does this by inserting a second assignment for the reverse amount. Assignment instructions for theoffsetting entry must match the original instructions. You may need to run this process, for example, ifyou specified the wrong month on the run control page when initiating the PIS payment process.

The process generates a log that identifies discrepancies. Many of the discrepancies are similar to thoseencountered during the PIS payment process.

Following are some additional reasons for discrepancies:

• Reversal amount in file is different than in the system - indicates that there is a difference between thereversal amount according to the file and the amount that was paid to the employee.

• Reversal was not made for this employee - indicates the reversal could not be generated for a specificemployee.

• The reversal process was not made - this message appears in the summary section and indicates thatone or more employees are in error.

PrerequisitesBefore you can run the PIS processes described in this section, follow the setup steps for PIS processing.

388 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 18 Managing Social Integration Program Payments

Related LinksDefining Parameters for Processing PIS Payments

PIS Processing BRA PageUse the PIS Processing BRA page (GPBR_RC_PIS_PRO) to run the PIS Processing Application Engine(GPBR_PISP_AE) process.

Navigation:

Global Payroll & Absence Mgmt > Social Security/Insurance > PIS Processing BRA > PISProcessing BRA

This example illustrates the fields and controls on the PIS Processing BRA page.

Field or Control Description

Operation Type Select the process to run:

• File - Cancelation of Empls (cancellation of employees). This process cancels PIS payments that were made toemployees who were not entitled to receive payment. Itcreates an output file that you can return to CAIXA.

• File - Employees for Paymen (employees for payment). This process validates data in the Release of Resourcesfile received from CAIXA and creates a log and an outputfile that you can return to CAIXA.

• PIS - Payment Process. This process assigns the earningelement that is used for PIS payments to employees.

• PIS - Reversal Process. This process reverses PISpayments that were made to employees for a givenpayment month and reference year.

Establishment ID Select the establishment. You can only select from thoseestablishments that have been identified as centralized on theCentralization Data page.

Copyright © 1988, 2022, Oracle and/or its affiliates. 389

Managing Social Integration Program Payments Chapter 18

Field or Control Description

Reference Year Enter the year from which PIS payment can be made.

Payment Month This field appears when you select the payment or reversalprocess in the Operation Type field. Enter the month to whichthe element assignment instructions apply.

Reversal Report This field appears when you select the reversal process in theOperation Type field.

File Name Enter the complete path to the file.

390 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 19

Calculating Legal Provisions

Understanding Legal Provisions

To guarantee that companies have sufficient funds to compensate employees for accrued vacationtime (including 1/3 vacation) and 13th salary, and that monies are available for related INSS (InstitutoNacional do Seguro Social) and FGTS (Fund of Guarantee for Service Time) payments, Braziliancompanies must set aside provisions to cover these payments. Global Payroll for Brazil can calculate andreport the provisions required for each month.

Provision CalculationsEach month, after you finalize the payroll process, you can run a second process that calculates provisionsfor the same payroll period.

To calculate provisions, create a calendar group that is similar to that used for the payroll process.Associate each calendar in the calendar group with run type, KR PROVIS. This run type is associatedwith the process list PROVISOES, which uses an accumulator with a calculation base that includesmonthly salary, as well as other fixed and any variable wages that employees receive as part of theirmonthly pay. Each provision has its own accumulator to meet the specific legal requirements. To run theprocess, use the Calculate Absence and Payroll run control page.

Average versions are defined by union code, run type and element. To calculate provisions based on arun type other than KR PROVIS, set the variable FP VR RUN TYPE to the run type that represents theaccurate average version. You can set this value at the calendar level or other level, including via otherelements.

The system calculates provision amounts on the last segment only.

Note: The system uses prorated vacation entitlement as the basis for calculating provisions for vacationentitlements.

Provision ReportingAfter you calculate provisions, you can review the results by generating the Results Register(GPBRRR01) or Payslip for Brazil (GPBRPS01) reports. The Results Register uses the element list thatyou specify on the report's run control page; payslips use the element list that you select in the Format IDfield on the run control page.

The element list determines what content to retrieve and include in the report and also determines the titlethat appears on the report. Define element lists on the Element List BRA page.

See Selecting Report Elements and Defining Payslip Sort Order.

Copyright © 1988, 2022, Oracle and/or its affiliates. 391

Calculating Legal Provisions Chapter 19

Prerequisites for Calculating Provisions

To configure the system to calculate provision amounts:

• Assign the element group, KR EG PROVISAO to all eligibility groups.

• Create the element list to use when reporting the provision calculations.

Viewing Delivered Elements for Provisions

This topic lists:

• Delivered earning elements for provisions.

• Delivered deduction elements for provisions.

• Delivered process list for provisions.

Delivered Earning Elements for ProvisionsThis table lists the delivered earning elements that the payroll calculation process uses when calculatingprovision amounts:

Element Description

AVISO PRE TR Severance pay

ESTAB PROV Severance pay by stability

MED PREMIO13 Average - premium 13th salary

MED PREMIO F Average - premium vacations

MEDPREMI RE Average - premium termination

FER PROP PAG Proportional days of current

FERIAS PROX Vacation next month

ABONO PROX Credit vacation next month

AVISO PRE IN Severance pay

FER MED PROX Next months vacation averages

392 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 19 Calculating Legal Provisions

Element Description

FER DOB PROX Double vacation next months

ABONO DOB PR Credit vacation next month

1/3FER D PR Next months 1/3 vacation double

1/3ABO D PR Next months - 1/3 credit double

FEPR DOB ANT Previous vacation - provision double

FEPR FER ANT Previous vacation provision

FEPR 1/3 ANT Previous proportional - proportional vacation

FEPR DOB ATU Double vacations

FEPR FER ATU Open vacations

FEPR 1/3 ATU 1/3 vacations - provision

13PR DIREITO 13th salary granted

13PR PAGO M 13th salary paid in the month

13PR PAGO AD 13th salary advance

13PR MED H Hourly average

13PR MEDIA V Average salary provision

13PR SLDO AT Current balance 13th salary provision

FEPR DOB DIF Difference double

FEPR FER DIF Vacation difference - provision

FEPR 1/3 DIF 1/3 Vacation difference - provision

FEP PROP ATU Current proportional vacations

Copyright © 1988, 2022, Oracle and/or its affiliates. 393

Calculating Legal Provisions Chapter 19

Element Description

FEP PRO ANT Previous proportional vacation

FEP PROP DIF Difference - proportional vacations

Delivered Deduction Elements for ProvisionsThis table lists the delivered deduction elements that the payroll calculation process uses when calculatingprovision amounts:

Element Description

FEPR INSS AN Previous INSS

FEPR SAT ATU SAT - current period

FEPR SAT ANT Previous vacation SAT for provision

13PR SAT ATU SAT for 13th salary

13PR SAT ANT Previous SAT - 13 provisions

13PR SAT DIF Difference SAT

FEPR SAT DIF Differences SAT

Delivered Process List for ProvisionsThis table lists the delivered process list that the payroll calculation process uses when calculatingprovision amounts:

Element Description

Process List PROVISOES

The process list includes the following sections:

• KR REMUN MENSAL (base remuneration - monthly).

• KR PROVISAO FER (vacations earning).

• KR PROVISAO 13 (13th salary earning).

394 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 19 Calculating Legal Provisions

• KR PROVISAO FER EN (vacations deductions and taxes).

• KR PROVISAO FE DIF (difference between previous and current).

• KR PROVISAO 13 ENC (13th salary deductions).

Note: Run type KR PROVIS is also delivered.

Copyright © 1988, 2022, Oracle and/or its affiliates. 395

Calculating Legal Provisions Chapter 19

396 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 20

Entering Absences

Understanding Absence Entry in Brazil

Global Payroll for Brazil delivers predefined rules for processing absences due to illness, maternity, workaccidents, and other reasons. These rules are designed in accordance with Brazil's statutory requirements.You can modify many of these rules to reflect absence policies that are specific to your organization.

This topic supplements the absence documentation provided in the PeopleSoft HCM: Global Payrollproduct documentation. Before you begin reading about Brazilian absence functionality, you should readthe topics on absence in the PeopleSoft HCM: Global Payroll product documentation to develop a basicunderstanding of the concepts behind Global Payroll absence processing.

See "Understanding Absence Setup and Management Tasks" (PeopleSoft Global Payroll)

An absence is any event for which an employee fails to comply with the scheduled work time. Absencesmust be recorded in the system so that the appropriate adjustments are made to an employee's salary. InBrazil, absences are also tracked for specific calculations such as 13th salary and vacation compensation.

In Global Payroll, there are two types of absence elements:

• An absence entitlement is defined as the amount of paid time off that a payee is entitled to take foreach category of absence.

For example, payees in your organization may be entitled to receive five sick days per year.

• An absence take is defined as the amount of time off that a payee takes.

This section discusses absence setup tasks, absence takes, and absence types for Brazil.

Note: Procedures for entering absences due to vacation are described in the Entering Vacation Data andUpdating Entitlement topic.

Related LinksUnderstanding Vacation Setup

Absence Setup TasksThe "Understanding Absence Setup and Management Tasks" (PeopleSoft Global Payroll) topic describesthe general setup steps for absences. The specific steps applicable to Global Payroll for Brazil follow.

1. Define work schedules and assign a schedule to each payee.

2. Define holiday schedules.

Copyright © 1988, 2022, Oracle and/or its affiliates. 397

Entering Absences Chapter 20

3. Modify the delivered absence take and absence entitlement elements or create new absence elements,as needed.

A list of the delivered absence take and absence entitlement elements delivered for Brazil is availablein the Viewing Delivered Absences Elements for Brazil topic.

4. Enable absence forecasting for absence take and absence entitlement elements as required.

5. Assign absence elements to payees and process lists.

As with all primary elements, you must assign absence entitlement and absence take elements topayees and include the elements in the process lists that you use when you run the absence process.PeopleSoft delivers predefined sections and process lists for absence processing. You can use these,modify them, or create your own.

Related Links"Setting Up Absence Entitlement Balance Forecasting and Inquiry" (PeopleSoft Global Payroll)

Understanding Absence Take Elements in BrazilThis section describes each delivered absence take element in detail.

Maternity Leave

This absence take generates the LIC MATERN deduction. The units component of the deduction elementis the number of days for the absence. The Day formula increments the deduction unit each day of theabsence.

The maternity take also generates the LIC MATERNID earning. It is generated in the same way that thededuction is generated in terms of the generated units.

Currently, the company is responsible for maternity leave, and can compensate this amount by deductingit from its INSS Contribution. So, the LIC MATERN deduction does not participate in the net calculation.

Foster Maternity Leave

For each absence event, the system generates an earning called LIC ADOCAO. The maximum numberof days compensated with this earning is determined by the bracket element FA BR ADOCAO FILHO,which is used as the basis for calculating entitlement for ADOCAO FILHO. The bracket stores a differentvalue (specified by variable FA VR ADOCAO DIAS) for each absence reason. For example, when anabsence event is reported with absence reason 01 (Up to one year) the bracket returns a value of 120 days.In this case, earning element LIC ADOCAO is used to compensate the payee for a maximum of 120 days.

Paternity Leave

This absence take generates a deduction called LIC PATER. The Units component of the deductionelement is based on the number of days of the absence. For each day of the absence, the Day Formulaadds one to the deduction unit.

Entitlement for paternity take, has a ceiling of five days per absence event (as defined by the LICENCAPAT entitlement element). If the absence exceeds this limit, only five days will be paid. Earnings are paidwith the element LIC PATERN.

398 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 20 Entering Absences

Sick Leave

This absence take generates a deduction called AFAST DOENCA. This element contains the number ofdays in the Units component. All the days of the absence take are considered as units of deduction. Inother words, the Day Formula adds only 1 to the deduction units for each day of this disability.

When AFAST DOENCA is greater than fifteen days, the absence take generates LIC DOENCAbecause the system has a ceiling of fifteen days. After fifteen days, AFAST DOENCA is capped at up tofifteen days for each absence event. The absence take AFAST DOENCA has a corresponding absenceentitlement, 15 DIAS X AF.

General Absence

This unpaid absence take generates a deduction called FALTA INJUST and DESC SEM PER. FALTAINJUST contains the number of days in the Units component. All the days of the absence take areconsidered as units of deduction. In other words, the Day Formula adds only 1 to the deduction unitsfor each day of this leave. DESC SEM PER contains the number of lost weekly rest days generated byabsence events.

Paid Absence

This absence take generates the deductions FALTA JUSTIF and LICENCA REM. These elements containthe number of days in the Units component. All days of the absence take are considered as units for thededuction. In other words, the Day Formula adds only 1 to the deduction units for each day of this leave.

The FALTA JUSTIF deduction is informational only, because this is a paid permission so it won't deductfrom the net pay. When this deduction is used, it generates the earning FALTA JUST.

When the LICENCA REM deduction is used, it generates the earning LIC REMUNER.

Unpaid Absence

This absence take generates a deduction called LIC NA RE DM. This element contains the number ofdays in the Units component. All the days of the absence take are considered as units of deduction. Inother words, the Day Formula adds only 1 to the deduction units for each day of this leave.

Half Unpaid Absence

This absence take generates the deductions 1/2 FAL IN and DESC SEM PER. 1/2 FAL IN containsthe number of days in the Units component. All the days of the absence take are considered as units ofdeduction. In other words, the Day Formula adds only 1 to the deduction units for each day of this leave.DESC SEM PER contains the number of lost weekly rest days generated by absence events.

Union Absence

This absence take generates a deduction called MANDATO SIND. This element contains the number ofdays in the Units component. All the days of the absence take are considered as units of deduction. Inother words, the Day Formula adds only 1 to the deduction units for each day of this leave.

Copyright © 1988, 2022, Oracle and/or its affiliates. 399

Entering Absences Chapter 20

Military Service

This absence take generates a deduction called SERVICO MILI. This element contains the number ofdays in the Units component. All the days of the absence take are considered as units of deduction. Inother words, the Day Formula adds only 1 to the deduction units for each day of this leave.

Accident Leave

This absence take generates a deduction called AFAST ACCIDE. This element contains the number ofdays in the Units component. All the days of the absence take are considered as units of deduction. Inother words, the Day Formula adds only 1 to the deduction units for each day of this leave.

For each absence event the system generates an earning called LIC AFA ACCI. This earning has a capof 15 days, meaning that for absence events greater than 15 days the system pays only 15 days with thisearning code.

Related LinksViewing Delivered Absences Elements for BrazilSetting Up Utilities in Global Payroll for Brazil

Viewing Delivered ElementsThe PeopleSoft system delivers a query that you can run to view the names of all delivered elementsdesigned for Brazil. Instructions for running the query are provided in the PeopleSoft HCM: GlobalPayroll product documentation.

Related Links"Understanding How to View Delivered Elements" (PeopleSoft Global Payroll)"Global Payroll Overview" (PeopleSoft Global Payroll)

Understanding Absence Take Types in BrazilEach absence take element is assigned an absence take type that describes the category of the absence.When reasons are defined for a take type, users can select a reason when entering an absence event. Forexample, multiple reasons are defined for the absence take type FTJ (Paid Absence / married absence),including Born Son, Married Absence, and many others.

Global Payroll for Brazil delivers the following absence take types:

Absence Type Description Absence Takes Associated

AFA Accident Leave Accident Leave

AFD Sick Leave Sick Leave

400 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 20 Entering Absences

Absence Type Description Absence Takes Associated

FTI Unpaid Absence • Half Unpaid Absence

• Not Paid Absence

• General Absence

FTJ Paid Absence (married absence) Paid Absence

LCM Maternity Leave Maternity Leave

LIM Foster Maternity Leave Foster Maternity Leave

LRE Paid License Paid Leave

MAS Union Absence Absence Union

PAL Paternity Leave Paternity Leave

SMI Military Service Military Service

Entering Absences and Forecasting Results

This topic describes how to run the Absence Forecasting process and how to enter absences in Brazil.

Pages Used to Enter Absences and Run the Absence Forecasting Process

Page Name Definition Name Usage

Absence Entry Page GPBR_ABSENCE_ENTRY Enter absence event details for anemployee. You can also run the AbsenceForecasting process to evaluate theimpact of an absence event.

Forecast Messages Page GP_ABS_FCST_MSG Review any messages that are generatedduring the Absence Forecasting process.

Absence Forecast Results Page GP_ABS_EVT_FCS_SEC Review the results of the AbsenceForecasting process for a specificabsence event and any take elements thatare mapped to it.

Copyright © 1988, 2022, Oracle and/or its affiliates. 401

Entering Absences Chapter 20

Running the Absence Forecasting ProcessThe Absence Forecasting process enables you to assess the impact of an absence. To run the process,follow these steps:

1. Enter a payee's actual or anticipated absence event on the Absence Entry page.

2. Click the Forecast button to start the process.

3. If applicable, check the Forecast Messages page to see if errors or warnings were generated.

4. Correct any errors and rerun the process. Each time you run the Absence Forecasting process, thesystem overwrites the previous forecast data.

5. Click the Forecast Details link on the Absence Entry page to view the results.

Video: Image Highlights, PeopleSoft HCM Update Image 32: Absence Attachments for Global Payrollfor Brazil

Absence Entry PageUse the Absence Entry page (GPBR_ABSENCE_ENTRY) to enter absence event details for anemployee.

You can also run the Absence Forecasting process to evaluate the impact of an absence event.

Navigation:

Global Payroll & Absence Mgmt > Payee Data > Maintain Absences > Absence Event BRA >Absence Entry

This example illustrates the fields and controls on the Absence Entry page (1 of 2).

402 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 20 Entering Absences

This example illustrates the fields and controls on the Absence Entry page (2 of 2).

The Absence Entry page in Global Payroll for Brazil is similar to the Absence Event Entry page in thecore application, however this page includes validations for Brazilian absence rules.

Note: You cannot add or edit vacation absence events that were generated by the Vacation AcquisitionPrd-Sched page or the Mass Vacation Programming BRA page using the Absence Entry page.

Field or Control Description

From and Through Specify the date range for which you want to retrieve anddisplay absence event data on the page.

Forecast After entering absence events, click this button to start theAbsence Forecasting process. For the process to run, AbsenceForecasting must be enabled for one or more take elements. Amessage appears when the process is complete. If there wereany processing errors, the message instructs you to review theForecast Messages page.

Absence Detail

Field or Control Description

Element Name and Type Select the absence take element that corresponds to theemployee's absence. The system displays the name of theelement and the absence type. When you define an absencetake element, you assign an absence type that describes thecategory of the absence.

Copyright © 1988, 2022, Oracle and/or its affiliates. 403

Entering Absences Chapter 20

Field or Control Description

Absence Reason Select the code that corresponds to the absence reason. TheAbsence Reason field is optional and further describes theabsence take.

Manager Approved Select to have the absence processed when you run theabsence take process. This check box is selected if you definedthe absence take element as not requiring manager approval onthe Absence Take - Calculation page in the core application.

Process Action Select the process action. For a new absence event, the defaultis Normal. Select Void to void an absence that has alreadygone through the absence take process. The event is notprocessed in subsequent runs. Instead, the process actionis reset to Normal and theVoided Indicator check box isautomatically selected during the absence take process.

During retroactive processing, the system calculates a newversion of the results without the voided event. Positive inputis not generated from the voided event, and the results forearnings or deductions have deltas.

Voided Indicator This check box is automatically selected if you voided theevent and ran the Take process. This check box can also beselected if you use the automatic priority processing featureand have assigned a priority number to your absence takeelements. If you save absence entries with overlapping dates,the system voids the event with the lower priority and creates anew event for the days that do not overlap.

Forecast Details Click to access the Absence Forecast Results page.

Absence Duration

Specify the length of the absence. Depending on which data you enter, the system calculates the missingfield. For example, if you enter the begin and end date, the system calculates the duration days. If youenter the begin date and duration, the system calculates the end date.

Field or Control Description

Begin Date and End Date Enter the begin and end dates for the absence.

404 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 20 Entering Absences

Field or Control Description

Original Begin Date Enter this date if your absence take rules allow you to linkthis absence to a previous absence that was taken for the samereason. If this absence is related to another absence, enter thebegin date of the original absence.

Absence Duration Enter the number of days for the absence.

User Defined Fields

This section appears if the selected absence element is AFAST ACCIDENTE (Accident Leave) or AFASTPOR DOENCA (Sick Leave), and the begin date for the absence request is specified.

In order for this section to display when the condition is met, you need to add the CID as a requiredcharacter field for AFAST ACCIDENTE or AFAST POR DOENCA absence elements on the "ConfigureCountry Take Setup - User Fields Page" (PeopleSoft Absence Management).

Information in this section is used in eSocial, CAGED, and SEFIP reporting, to name a few.

Field or Control Description

CID Specify the appropriate international code of sickness for theabsence request.

SEFIP 660 (660 or Blank) Enter a SEFIP value (for example, 660) if applicable, or leaveit blank.

This field appears if the selected element is AFASTACCIDENTE, and the begin date for the absence request isspecified.

Absence Additional Data for eSocial

This section appears with these fields, if the selected absence element is AFAST ACCIDENTE (AccidentLeave) or AFAST POR DOENCA (Sick Leave), the begin date for the absence request is specified, and theCID field is configured to be displayed. Enter applicable information for employee’s temporary absence.

Copyright © 1988, 2022, Oracle and/or its affiliates. 405

Entering Absences Chapter 20

Field or Control Description

Physician ID Specify a doctor or medical specialist for the absence request.

When selected, several fields are populated automatically withthe physician’s information, such as physician’s name, organstatutory, number or organ class, state, and country.

Physicians are defined using the Physician BRA component.

See Also "Physician Table - Name Page" (PeopleSoft HumanResources Monitor Health and Safety).

Physician Name Enter the physician's name, if physician ID is not specified.

Organ Statutory Enter the organ class of the physician, CRM, CRO, or RMS, ifphysician ID is not specified.

CRM/CRO Enter the class number of the specified CRM or CRO organclass, if physician ID is not specified.

Country and State Enter the country and state where the organ class was issued tothe physician, if physician ID is not specified.

Issued by Select the entity that issued the license of accident leavereferenced in the absence request. This field appears if theSEFIP 660 (660 or Blank) field value is set to 660.

Values are:

Administrative decision

Employer

Judicial decision

Judicial Process and Proceeding Type If the selected Issued by field value is Administrative decisionor Judicial decision, enter the corresponding proceedingnumber and type (Administrative, INSS Benefit Number, orJudicial) in these fields that appear.

eSocial Union Additional Data

This section appears with these fields, if the selected absence element is MANDATO SINDICAL (UnionAbsence). Enter applicable information for employee’s temporary absence by union mandate. Dataentered in this section is used in eSocial reporting.

406 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 20 Entering Absences

Field or Control Description

Union Code, Union Name and Union CNPJ Specify the code of the employee’s union. The systempopulates the corresponding union name and union CNPJnumber.

Alternatively, if the union code is not specified, enter the unionname and CNPJ number manually.

Remuneration Onus Select the recipient of the employee’s remuneration onus.

Values are:

Employer and Union

Not applicable (default)

Only Employer

Only the Union

Attachments

The Attachments link becomes available after an absence element and a begin date are selected. Clickthe link to attach supporting files (for example, doctor’s note) for the absence event on the "MaintainAttachments Page" (PeopleSoft Absence Management), if applicable. Addition to adding attachments,you can also view and delete existing attachments as needed.

Additional Information

Enter data and comments on additional fields pertaining to your business processes. You define thesefields in the Absence Self-Service transaction.

Field or Control Description

Comment Enter more information about the absence event. Thesecomments appear only in the employee's record.

Related Links"Entering Maintaining and Approving Absence Events" (PeopleSoft Absence Management)

Forecast Messages PageUse the Forecast Messages page (GP_ABS_FCST_MSG) to review any messages that are generatedduring the Absence Forecasting process.

Navigation:

Copyright © 1988, 2022, Oracle and/or its affiliates. 407

Entering Absences Chapter 20

Global Payroll & Absence Mgmt > Payee Data > Maintain Absences > Absence Event BRA >Forecast Messages

This example illustrates the fields and controls on the Forecast Messages page.

This page displays any errors the system encountered during the Absence Forecasting process. Correctany errors and run the process again.

Note: The Forecast Messages page in Global Payroll for Brazil is the same as the Forecast Messages pagein the core application.

Related Links"Forecast Messages Page" (PeopleSoft Global Payroll)

Absence Forecast Results PageUse the Absence Forecast Results page (GP_ABS_EVT_FCS_SEC) to review the results of the AbsenceForecasting process for a specific absence event and any take elements that are mapped to it.

Navigation:

Click the Forecast Details link on the Absence Entry page.

This example illustrates the fields and controls on the Absence Forecast Results page.

408 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 20 Entering Absences

Note: The Absence Forecast Results page in Global Payroll for Brazil is the same as the AbsenceForecast Results page in the core application.

Related Links"Absence Forecast Results Page" (PeopleSoft Global Payroll)

Entering Contracts and Absences for Trainees

This topic provides an overview of absences for trainees and discusses how to enter absences for them.

Pages Used to Enter Absences for Trainees

Page Name Definition Name Usage

Trainee Contract Page TR_CONTRACT_BRA Specify contract periods for trainees.

Contract Details Page TR_CONT_DET_BRA Enter detailed contract information fortrainees.

Trainee Recess BRA Page GPBR_TR_VACN Schedule absence requests for trainees.

Understanding Absences for TraineesIn Global Payroll for Brazil, absence requests for trainees are captured on the Trainee Recess BRA page.Specific setup steps need to be performed to support absence scheduling for trainees. Contracts need to beidentified in the system prior to entering absences for trainees.

Setting Up Absences for Trainees

To set up absences for trainees:

1. Add and activate the Recess absence take type for the BRA country on the "Absence Take TypesPage" (PeopleSoft Absence Management). For example:

Absence Type: REC

Description and Short Description: Recess

Allow Request in Self Service: Selected

Absence Reason: 10; Description and Short Description: Recess

2. Update the REC DIAS_BALAN accumulator on the "Accumulators - Level Page" (PeopleSoft GlobalPayroll).

Select the Job (EMPLID/EMPL_RCD) option. Enter Variable in the User Key Type 1 field and ESVR DT INI CONTR in the Key Element 1 field.

Copyright © 1988, 2022, Oracle and/or its affiliates. 409

Entering Absences Chapter 20

3. Add the RECESSO ESTAGIARIO BRA country take for the BRA country and update this informationon the "Configure Country Take Setup - Absences Page" (PeopleSoft Absence Management):

Approval Process ID: AbsenceManagement

Approval Definition ID: AbsenceMgmtByDeptManager

Display Current Balance: Selected

Balanced Display Option: Summarized

Current Balance Accumulator: REC DIAS_BALAN

Display Original Begin Date: Selected

In addition, update this information on the "Configure Country Take Setup - Date RulesPage" (PeopleSoft Absence Management):

Calculate Duration: Selected

If both entered recalculate: Duration

4. Include all these elements in the KR ESTAGIARIO element group on the "Element Group MembersPage" (PeopleSoft Global Payroll):

• Deduction IRRF

• Earnings BOLSA AUX

• Earnings BOLSA AUX ME

• Absence Take RECESSO ESTAGIARIO

• Absence Entitlement REC DIAS

• Earnings RECESSO

• Deduction RECESSO_DED

• Earnings BOLSA AUXILI

The eligibility assignment for these elements is by eligibility group.

5. Update the TOTAL PROVENTOS N accumulator on the "Members Page" (PeopleSoft Global Payroll)to include BOLSA AUXILI and RECESSO earnings elements. Select Add as the accumulator sign.

6. Update the KR VENCIMENTOS section on the "Definition Page" (PeopleSoft Global Payroll) toinclude the BOLSA AUXILI earnings element.

In addition, update the KR LICENCAS section to include the RECESSO earnings element.

7. Add the Trainee (Estagiario) employee class for the BRA country, if it is not yet available in thesystem.

See "Defining Additional Employment Setup Data" (PeopleSoft Human Resources AdministerWorkforce).

410 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 20 Entering Absences

Scheduling Absence for Trainees

To schedule absence for trainees:

1. Make sure that the employee is identified in the HCM system as a Temporary (in the Regular/Temporary field), Trainee (in the Employee Class field) on the "Job Information Page" (PeopleSoftHuman Resources Administer Workforce).

To exclude the trainee from SEFIP reporting, select Not Applicable in the SEFIP Category field ofthe Brazil section on the Job Information page.

Trainees are excluded from RAIS reporting.

When the page is saved, the system automatically creates a contract for the trainee on the TraineeContract BRA page.

2. Enter the contract period for the trainee on the Trainee Contract Page. You can enter additional rowsin case of contract extension.

3. Schedule trainee absence on the Trainee Recess BRA Page.

Trainee Contract PageUse the Trainee Contract BRA page (TR_CONTRACT_BRA) to specify contract periods for trainees.

Navigation:

Workforce Administration >Job Information > Trainee Contract BRA > Trainee Contract

This example illustrates the fields and controls on the Trainee Contract page.

Use this page to enter one or more contracts a trainee has with the company. You cannot delete a contractrow if you have scheduled absences during that period.

Copyright © 1988, 2022, Oracle and/or its affiliates. 411

Entering Absences Chapter 20

Field or Control Description

Begin Date Displays the start date of a contract. The system populatesthe begin date of the first row with the effective date of thetrainee’s first Work Location row.

When you add a new row, the system populates the new begindate by adding one day to the end date of the previous row.

End Date Enter the end date of a contract. The length of a contract mustnot exceed two years.

Contract Details PageUse the Contract Details page (TR_CONT_DET_BRA) to enter detailed contract information for trainees.

Navigation:

Workforce Administration >Job Information > Trainee Contract BRA >Contract Details

This example illustrates the fields and controls on the Contract Details page (1 of 2).

412 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 20 Entering Absences

This example illustrates the fields and controls on the Contract Details page (2 of 2).

Information entered on this page is used in eSocial reporting.

Education Institute

Field or Control Description

CNPJ ID and Name Enter the CNPJ number or name of the education institute. One of these values is required at a minimum.

Note: The system does not return an error message if therequired value is missing when you save this page. Thevalidation takes place in the mapping process, and the errorwill be captured in the eSocial Events Monitor.

Address Enter the address of the education institute, which is requiredif you have specified the name of the education institute.

Note: The system does not return an error message if therequired value is missing when you save this page. Thevalidation takes place in the mapping process, and the errorwill be captured in the eSocial Events Monitor.

Copyright © 1988, 2022, Oracle and/or its affiliates. 413

Entering Absences Chapter 20

Area of Study

Field or Control Description

Stage Level Select stage level of the internship.

1 - Elementary

2 - High School

3 - Vocation School

4 - Higher Education

Area of Study Enter the description of the area of study. For example, Accounting, Law, and so on.

Mandatory Contract Select Yes or No to indicate if the internship is required for thearea of study.

Policy Number Enter the insurance policy number.

Agent of Integration

Enter the CNPJ number, name, and address of the agent of integration.

Trainee Recess BRA PageUse the Trainee Recess BRA page (GPBR_TR_VACN) to schedule absence requests for trainees.

Navigation:

Global Payroll & Absence Mgmt > Payee Data >Maintain Absences >Trainee RecessBRA >Trainee Recess BRA

414 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 20 Entering Absences

This example illustrates the fields and controls on the Trainee Recess BRA page.

Field or Control Description

Balance Days Displays the number of days that the trainee has for requestingabsences.

Total Scheduled Days Displays the number of absence days that the trainee hasscheduled during the service period.

If the number of balance days is equal to the number of totalscheduled days (that is, the value of the Total field is 0), theperiod status is automatically changed to Closed.

Begin Date and Days Enter the start date of the absence period and the number ofabsence days to be requested. When you tab to the next field, the system populates the end date of the requested absence.

Viewing Delivered Absences Elements for Brazil

This section contains information about the following rules that Global Payroll for Brazil delivers toprocess absences:

• Absence earnings.

• Absence deductions.

Copyright © 1988, 2022, Oracle and/or its affiliates. 415

Entering Absences Chapter 20

• Absence takes.

• Absence entitlements.

• Absence process lists.

Absence EarningsThe following table lists the absence earnings for Brazil:

Earning Description

FALTA JUST Paid Absences

LIC MATERNID Maternity Salary

LIC DOENÇA Sick Leave

LIC AFA ACCI Accident Leave

LIC REMUNER Paid Absence

LIC ADOCAO Foster Daughter / Son

LIC PATERN Paternity Leave

Absence DeductionsThe following table lists the absence deductions for Brazil:

Deduction Description

AFAST ACCIDE Accident Leave

FALTA INJUST Unpaid Absence

FALTA JUSTIF Paid Absence

LIC MATERN Maternity Leave

AFAST DOENCA General Sickness

DESC DSR Lost Weekly Rest

416 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 20 Entering Absences

Deduction Description

SERV MIL DMI Military Service

LICENCA REM Paid Leave

LIC NA RE DM Unpaid Leave

MAND SIND DM Union Absence

FERIADO DSR Holiday DSR Lost

1/2 FAL INJ Half Unpaid Absence

LIC PATER Paternity Leave

Absence TakesThe following table lists the absence takes for Brazil:

Absence Take Description

1/2 FALTAS INJUST Half-Unpaid Absence

AFAST ACCIDENTE Accident Leave

AFAST POR DOENCA Sick Leave

FALTAS INJUST General Absence

FALTAS JUSTIFICADA Paid Absence

FERIAS ABONO Paid Vacations

FERIAS CAN Cancel Vacations

HORAS JUSTIF Paid hourly absence

LICENCA ADOCAO FIL Foster Daughter / Son

LICENCA MATERNIDAD Maternity Leave

Copyright © 1988, 2022, Oracle and/or its affiliates. 417

Entering Absences Chapter 20

Absence Take Description

LICENÇA NAO REM Unpaid Leave

LICENCA PATERN Paternity Leave

LICENCA RENUMERADA Paid License

MANDATO SINDICAL Union Absence

RECESSO ESTAGIARIO RECESSO ESTAGIARIO (Trainee Recess)

SAIDA FERIAS Vacation Take

SERVICIO MILITAR Military Service

Absence EntitlementsThe following table lists absence entitlement elements for Brazil:

Absence Entitlement Description

DIREITO FER Vacation Entitlement

15 DIAS X AF Sick and Accident Leave

ADOCAO FILHO Foster Daughter/Son

LICENCA PAT Paternity Leave

Related LinksViewing Delivered Vacation Elements

Absence Process ListsThe following table lists the absence process list for Brazil:

Process List Description

KR AUSENCIAS Absence process

418 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 21

Managing Vacation Data

Entering Vacation Data and Updating Entitlement

This topic provides overviews of how to enter vacation data and update entitlement, lists prerequisites,and discusses how to enter vacation data and update entitlement.

Pages Used to Enter Vacation Data and Update Entitlement

Page Name Definition Name Usage

Maintain Acquisitive Prd BRA Page (maintain acquisitive period BRA page)

GPBR_AP_MAINT List the acquisitive period for allemployees. Maintaining the employees'acquisitive periods can happen manuallyor automatically.

Vacation Acquis Prd-Sched BRA Page (vacation acquisition period-scheduleBRA page)

GPBR_VACN_MAINT Enter and maintain vacation takes.

Understanding How to Enter Vacation DataIn Global Payroll for Brazil, you enter and maintain vacation data for individual employees on theVacation Acquis Prd-Sched page. On this page, you:

• Maintain entitlement periods with their begin and end dates.

• Track vacation entitlement period history with its corresponding statuses: In Progress, Open, Closed/Expired, and Closed by Absence Criteria.

• Track vacation events with their statuses.

• Track years of service and the maximum number of days that are allowed per each vacation take.

• Define, manage, and track programmed leaves.

In Global Payroll for Brazil, you can plan or program vacation for employees in advance of theirtaking time off.

To define programmed leave, you must complete the following steps:

• Enter the start and end dates of each planned (programmed) vacation take.

Copyright © 1988, 2022, Oracle and/or its affiliates. 419

Managing Vacation Data Chapter 21

• Confirm (approve) programmed leave (if approval is required before the payroll process canprocess takes).

• Specify the number of vacation days that the employee wants to sell.

Note: You define how to calculate the dates of vacation sells on the Vacation Parameters BRA Page.

• Specify whether the employee can receive an advance on his or her 13th salary during the vacationprocess.

The first payment of the 13th salary is paid when you select the Advance 13th check box. Theamount of the payment doesn't depend on the vacation dates, and it contributes to the vacation grossaccumulator.

• Manage and view entitlement balances. This includes:

• Tracking the total vacation balance remaining.

• Tracking the number of leave days taken during an entitlement period.

• Making manual adjustments to the entitlement balance.

For example, you can increase or decrease the vacation balance.

• Tracking the total number of balance days plus days taken off.

Understanding How to Update Vacation EntitlementAfter the payroll process is finalized, vacation rules are used to update vacation entitlement for payees.Vacation rules take the new acquisitive period dates from the payroll process and close or extendacquisitive periods according to the parameters that you specify. They are also used for updating the statusfor employees' entitlement (acquisitive) periods.

PrerequisitesBefore you can enter vacation takes or maintain vacation data on the Vacation Acquis Prd-Sched page,you must:

• Specify the parameters of your vacation take and entitlement elements on the Vacation ParametersBRA page.

Among other things, the parameters that you enter on this page enable you to control, at the companylevel, the number of vacation days that employees can take per entitlement period, the maximum andminimum number of vacation days that can be taken per leave, and the ability to maintain a negativeentitlement balance.

Note: The take and entitlement elements that you define on the Vacation Parameters BRA pageare the same elements against which you enter vacation time for individual payees on the VacationAcquisition Prd-Sched page. If you do not specify the take and related entitlement elements on theVacation Parameters BRA page, you cannot enter vacation time using those takes.

420 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 21 Managing Vacation Data

• Define work schedules and assign a schedule to each payee.

• Define holiday schedules for each payee.

• Create Vacation Parameters by Company.

• Create Vacation Calendars (Absence Payroll and Payroll Process).

• Create Vacation Calendars by Pay Group.

Related LinksDefining Vacation Parameters for Brazil

Splitting of Vacation LeavesWhen you create an absence event (on the Brazil-specific Absence Entry page) that happens to take placein the middle of a vacation leave (on the Acquis Prd-Sched BRA page) and that the absence event has ahigher priority (for example, accident leave) than the vacation leave, the system splits the vacation leaveso that the absence event with higher priority can be processed appropriately. In this situation, the system:

• Voids the original vacation leave that is displayed on the Absence Entry page by changing the processaction to Void.

• Reinserts the vacation leave as separate absence events on the Absence Entry page, one before andone after the absence event with higher priority, with the process action set to Normal.

• Adds an alphanumeric code to the original and reinserted vacation leaves to indicate that they arerelated events. The code is populated in the Character 4 field of the Absence Event Input Detailpage.

• Adds a numeric indicator to the last vacation leave event to be processed within the same off-cycle.The value is populated in the Decimal 1 field of the Absence Event Input Detail page.

The indicator is used to process only legal charges in the last payroll segment of the off-cycle. In anexample where a vacation leave is inserted before an accident leave and one after it, the indicator ispresent in the second vacation leave.

• Updates the employee’s vacation leave on the Vacation Acquis Prd-Sched BRA page with informationabout the newly inserted and voided vacation takes.

If the vacation is already paid, an adjustment for it will occur through retroactivity.

To enable this functionality, set the priority of the vacation take (SAIDA FERIAS) to a lower priority (forexample, 30) on the "Absence Takes - Priority Page" (PeopleSoft Global Payroll).

Vacation Acquis Prd-Sched BRA PageUse the Vacation Acquis Prd-Sched BRA (Vacation Acquisitive Period Schedule BRA) page(GPBR_VACN_MAINT) to list the acquisitive period for all employees.

Maintaining the employees' acquisitive periods can happen manually or automatically.

Navigation:

Copyright © 1988, 2022, Oracle and/or its affiliates. 421

Managing Vacation Data Chapter 21

Global Payroll & Absence Mgmt > Payee Data > Maintain Absences > Vacation Leave BRA >Vacation Acquis Prd-Sched BRA

This example illustrates the fields and controls on the Vacation Acquis Prd-Sched BRA page.

Vacation Acquisitive Period-Schedule

Use the fields in this group box to view current and past acquisitive periods or to adjust period lengths, ifnecessary.

Field or Control Description

Begin Date and End Date View or modify the begin and end dates of an employee'sentitlement period.

Note: The begin and end dates that appear on this page can bemodified if necessary. If you modify the dates, the system doesnot recalculate dates for this period; instead, it uses the datesthat you enter.

422 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 21 Managing Vacation Data

Field or Control Description

Status View and maintain the status of the current entitlement periodsor, if you are viewing historical data, view and modify thestatus of prior entitlement periods. Values are:

Closed Expired: The entitlement period is no longer active, and the employee has no usable vacation days that areassociated with that period.

Closed per Absence: The period was automatically closedby the leave parameters that you defined in theAbsenceInterference on Acquisitive Period group box on theVacation Parameters BRA page. For example, you canprogram an entitlement period to close automatically if anemployee has more than 180 days of disability leave in aperiod.

In Progress: The entitlement period is the current period.

Open: The entitlement period is no longer the current period, but the employee has vacation days that are associated withthat period that can still be taken.

See Understanding Vacation Setup.

Note: The entitlement period statuses that appear on this pageare updated automatically by the Update Vacation Entitlementprocess. However, you can modify these statuses, if necessary.

Years of Service Displays the employee's years of service.

Max Days # (maximum number of days) Displays the maximum days that an employee can acquireduring the acquisitive period.

Balance Days

Field or Control Description

Balance Days Displays the number of days in the vacation balance.

Note: The balance = (Total vacation days per entitlementperiod) – (Programmed Vacations) – (Days Sold) +Adjustments.

Total Scheduled Days Displays the total number of programmed leave days that arerecorded in Global Payroll for Brazil.

Copyright © 1988, 2022, Oracle and/or its affiliates. 423

Managing Vacation Data Chapter 21

Field or Control Description

Adjust Days Enter the number of days (positive or negative) by whichyou want to adjust the leave balance that is displayed in theBalance Days field.

Total Displays the sum of the Balance Days and Total Take Days.

Note: The information in this group box is updated when you save the page and during the UpdateVacation Entitlement process.

Vacation Leaves

Use the fields in this group box to define programmed (planned) or confirmed vacations for an employee.A programmed vacation is one that can be set up in advance of the actual vacation take and defines thevacation begin and end dates. In addition, the leave program controls whether the payees will receive anadvance on the 13th salary during the vacation period and allows employees to sell vacation.

Field or Control Description

Vacation Start Date Enter the begin date of the vacation.

Days Enter the duration of the vacation.

Note: When you enter the begin date and a duration, thesystem automatically calculates the end date of the vacationand populates the Vacation End Date field.

Vacation End Date This field is automatically populated when you enter avacation begin date in the Vacation Start Date field anda duration in theDays field. If you want, you can populatethis field yourself and the duration will be recalculatedaccordingly.

Note: If the leave that you enter exceeds the number of leavesper period that is allowed on the Vacation Parameters BRApage, the system issues a warning. Similarly, if the numberof leave days in the vacation exceeds the leave balance, thesystem issues a warning.

424 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 21 Managing Vacation Data

Field or Control Description

Status View and maintain the status of vacations. Values are:

Calculated: Indicates that payroll has processed the leave take.

Note: The value of this field is automatically updated toCalculated when a vacation take is processed. If vacationapproval is required, all takes must be Confirmed before theycan be Calculated. Otherwise, the status of a vacation canchange directly from Programmed to Calculated.

Canceled: Select to cancel an already programmed vacation. The process also cancels the programmed vacation when anentitlement period is closed and it contains a programmedvacation.

Closed: Indicates vacation days were taken and paid.

Confirmed: Select to approve a programmed leave.

Note: To require official confirmation (approval) of a vacationbefore the payroll process can process the take, select theNeeds Confirmation for Program check box on the VacationParameters BRA page. When you do this, you must confirmany take that you enter on Vacation Acquis Prd-Sched pagebefore it can be calculated.

Programmed: Select when the vacation take is first entered—before the leave has been either confirmed or calculated.

Absence Credit Select to sell unused vacations days—that is, days that remainat the end of a vacation. When you select this option, the CrDays (credit days) field becomes available.

Cr Days (credit days) Enter the number of unused vacation days to sell for theemployee.

The value of these days is credited to the employee.

Copyright © 1988, 2022, Oracle and/or its affiliates. 425

Managing Vacation Data Chapter 21

Field or Control Description

Advance 13th Select to enable the employee to receive an advance on his orher 13th salary.

Note: When you save this page, an override to payee calendarsis automatically generated in the core Global Payroll records. This override enables Global Payroll for Brazil to processautomatically the entire vacation event in a single calendargroup with a payment two days before the vacation begindate. However, you can insert or modify the payee calendarsmanually.

Absence Data

This section displays the event history of the corresponding vacation leave, if applicable.

For example, if the system splits up a vacation leave as a result of an absence event that occurs during thatscheduled vacation, you can see the list of voided vacation events related to the split in this section forreference purposes.

Creating Mass Vacation Takes

This topic provides an overview of mass vacation takes, lists prerequisites, and discusses how to createmass vacations.

Page Used to Generate Mass Vacation Takes

Page Name Definition Name Usage

Mass Vacation Programming BRA Page GPBR_RC_MASS_VAC Generate mass vacation takes.

Understanding Mass Vacation TakesIn Global Payroll for Brazil, you can generate mass vacation takes—that is, takes for groups of employeesthat are based on group IDs that are defined in PeopleSoft HR. You use this feature to generate takeswithout entering separate vacations for each employee.

PrerequisitesBecause this feature is based on the definition of group IDs, you must set up group membership inPeopleSoft HR before you can create mass takes.

426 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 21 Managing Vacation Data

Related Links"Understanding Group Build" (Application Fundamentals)

Mass Vacation Programming BRA PageUse the Mass Vacation Programming BRA page (GPBR_RC_MASS_VAC) to generate mass vacationtakes.

Navigation:

Global Payroll & Absence Mgmt > Absence and Payroll Processing > Prepare Payroll > MassVacation Leave BRA > Mass Vacation Programming BRA

This example illustrates the fields and controls on the Mass Vacation Programming BRA page.

Note: Global Payroll for Brazil does not generate an automatic override to payee calendars in the coreGlobal Payroll records for mass vacation event entry. To process the mass vacations in a single calendargroup with a payment two days before the vacation begin date, you must create or manually enter thepayee calendars.

Field or Control Description

Mass Absence ID Assign an ID to identify the parameters that you are defining.

Copyright © 1988, 2022, Oracle and/or its affiliates. 427

Managing Vacation Data Chapter 21

Mass Vacation Event Entry

Field or Control Description

Effective Date Enter the date on which the mass take definition becomeseffective.

Group ID Specify the group ID that contains the payees for whom youwant to generate vacation takes.

Note: You define group IDs as part of the group buildfunctionality in PeopleSoft HR.See "Understanding Group Build" (Application Fundamentals)

Status Set the status of the mass vacation that you are defining. Values are:

Calculated

Canceled

Closed

Confirmed: Select to approve a mass vacation.

Note: To require official confirmation (approval) of a massvacation before the payroll process can process the take, selectthe Needs Confirmation for Program check box on theVacation Parameters BRA page. When you do this, you mustconfirm any mass take that you enter on the Mass VacationProgramming BRA page before it can be calculated.

Programmed: Select when you first define your mass vacation—before the leave has been either confirmed or calculated.

Absence Take Select the absence take element for the mass vacation.

Absence take elements define rules for allowing paid timeoff. They define which kinds of absences are valid and therequirements that must be met before entitlement can be used.

Cancel Select to cancel mass vacation takes that you set up previously. This cancels the takes from the PeopleSoft Global Payrolland country-specific tables where the takes are stored prior tobeing processed.

428 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 21 Managing Vacation Data

Field or Control Description

Remaining Balance Specify how the system should treat the balance of vacationdays (unused days) after the mass vacation take has beenprocessed. Values are:

Maintain B: Select to keep remaining vacation days in theemployees' vacation balances.

Paid: Select to pay employees for the balance of vacation daysafter mass takes have been processed.

Returns: Select to extend the return vacation date by thenumber of unused days.

Leave Days

Field or Control Description

Begin Date Enter the begin date of the mass vacation.

Calendar Days Enter the duration of the mass vacation.

Note: When you enter the absence begin date and a duration, the system automatically calculates the end date of thevacation and populates the Absence End Date field.

End Date This field is automatically populated when you enter anabsence begin date in the Absence Begin Date field and aduration in the Calendar Days field. If you want, you canpopulate this field manually.

Absence Reason Enter an absence reason.

Advance 13th Select to enable payees to receive an advance on their 13thsalary during the mass vacation leave.

Generating the Vacation Payslip

To define the printing order selection for the vacation payslip, use the Sort IDs BRA (GPBR_SORTID)component. To identify the earnings, deductions, and calculation bases for reports use the Element ListsBRA (GPBR_PAYSLIP_FORMA) component.

Copyright © 1988, 2022, Oracle and/or its affiliates. 429

Managing Vacation Data Chapter 21

This topic provides an overview of the vacation payslips and discusses how to generate the vacationpayslip.

Pages Used to Generate the Vacation Payslip

Page Name Definition Name Usage

Sort IDs BRA Page GPBR_SORTID Define the printing order selection forthe vacation payslip.

Element Lists BRA Page GPBR_PAYSLIP_FORMA Enter earnings, deductions, andcalculation bases eligible for printing formultiple reports, including the vacationpayslip.

Create/Print Payslips BRA Page GPBR_RC_PAYSLIP Generates the payslip. Note that if youwant to select employees using groups, you must first define the Group ID togenerate the payslip. All groups selectedin the Group ID field will automaticallybe recreated during the payroll run.

Understanding the Vacation PayslipIn Brazil, companies have to provide the following kinds of payslips:

• A standard payroll payslip containing such information as the number of worked days and wages.

• A vacation payslip displaying vacation earnings, the vacation balance, and other information relatedto vacation pay.

Create/Print Payslips BRA PageUse the Create/Print Payslips BRA page (GPBR_RC_PAYSLIP) to generates the payslip.

Note that if you want to select employees using groups, you must first define the Group ID to generate thepayslip. All groups selected in the Group ID field will automatically be recreated during the payroll run.

Navigation:

Global Payroll & Absence Mgmt > Payslips > Print Payslips BRA > Create/Print Payslips BRA

To generate the vacation payslip, make sure to:

1. Select the Vacations check box. The Calendar ID field becomes the Run Type field.

2. Select a run type

See Also Create/Print Payslips BRA Page.

430 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 21 Managing Vacation Data

Running the Vacation Receipt and Vacation Notice Reports

This topic provides an overview of the vacation receipt and vacation notice reports and discusses how togenerate vacation receipts and vacation notices for employees.

Page Used to Run the Vacation Receipt and Vacation Notice Reports

Page Name Definition Name Usage

Vacation Receipt\Notice BRA Page GPBR_RC_VAC_REC Generate vacation receipts and vacationnotices for employees.

Understanding the Vacation Receipt and Vacation Notice ReportsThe Vacation Receipt/Notice page generates two reports:

• Vacation receipt

This report provides information for a defined period of vacation; it includes either information on theacquisitive period or the amounts of vacation time paid. It serves as a payslip for vacations.

• Vacation notice

This report provides the required 30-day written notice of an employee's vacation dates.

You can generate these reports together or individually.

Vacation Receipt\Notice BRA PageUse the Vacation Receipt\Notice BRA page (GPBR_RC_VAC_REC) to generate vacation receipts andvacation notices for employees.

Navigation:

Global Payroll & Absence Mgmt > Absence and Payroll Processing > Reports > Vacation Receipt/Notice BRA > Vacation Receipt\Notice BRA

Copyright © 1988, 2022, Oracle and/or its affiliates. 431

Managing Vacation Data Chapter 21

This example illustrates the fields and controls on the Vacation Receipt\Notice BRA page.

Field or Control Description

Report Type Choose which reports to generate: vacation receipt andvacation notice together, vacation receipt alone, or vacationnotice alone.

Company Enter the company whose employees you want to include inthe report.

Format ID Select the payslip format to use for the vacation receipt report. This format contains the element list for the earnings anddeductions that are eligible to be printed for this report. Youneed to define an element list for this report.

This field appears only when you are printing the vacationreceipt report (alone or with the vacation notice report).

Run Type Select the vacations run type.

This field appears only when you are printing the vacationreceipt report (alone or with the vacation notice report).

432 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 21 Managing Vacation Data

Field or Control Description

Vacation Remuneration Select the vacation remuneration accumulator, which hasas members the elements and deductions that are part of thesalary that is paid for vacations purposes.

This field appears only when you are printing the vacationreceipt report (alone or with the vacation notice report).

Begin Date and End Date Enter the begin and end dates of the interval to process. If anemployee's vacation acquisitive period start or end date fallswithin this interval, the report includes the details for thatemployee.

Selection Criteria Choose a method of selecting employees for whom to generatethe report.

Exclude Data Select this check box to exclude data that matches the criteriayou enter in the Establishment Data, Department Data, orEmployee Data group boxes (the group box that appearsdepends on the selection you make in the Selection Criteriafield).

Establishment ID, Department, and EmplID Enter the data that the process uses to select employees.

Note: Whether a field appears on this page depends on theoption that you selected in the Selection Criteria field.

Viewing Delivered Vacation Elements

This topic discusses:

• Vacation entitlements.

• Vacation takes.

• Vacation process lists.

Note: This PeopleSoft application delivers a query that you can run to view the names of all deliveredelements for Brazil. You can also see the relationship between elements by using the View ElementRelationships utility.

Related Links"Understanding How to View Delivered Elements" (PeopleSoft Global Payroll)

Copyright © 1988, 2022, Oracle and/or its affiliates. 433

Managing Vacation Data Chapter 21

Vacation EntitlementsThis table contains information about the absence entitlements that are used to process vacations inGlobal Payroll for Brazil:

Absence Entitlement Description

DIREITO FER Stores the vacation balance; each entitlement period has oneinstance.

FERIAS PROP Temporary entitlement stores accrual days per month.

Vacation TakesThis table contains information about the absence takes that are used to process vacations in GlobalPayroll for Brazil:

Absence Take Description

SAIDA FERIAS Used for the vacation events. It counts the number of daysbetween begin and end date and sends the days to FERIAS, FERIAS DOBRO (earning element), or both.

FERIAS ABONO Used for credit vacations. It counts the number of daysbetween begin and end date and sends the days to ABONOFERIAS,ABONO DOBRO (earning element), or both.

Note: Absence take rules use earning and deduction elements, elements that retrieve units for positiveinput, and elements that retrieve percentages for positive input.

Vacation Process ListsGlobal Payroll for Brazil delivers the following process list for absence processing:

Process List Description

FERIAS TOMADAS Process vacation takes.

FERIAS FOLHA Process vacation payroll elements (the gross and netaccumulators for vacation).

434 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 22

Tracking Loans

Understanding Loans in Brazil

It is a common practice for Brazilian companies to grant personal loans or pay for assets and serviceson behalf of their employees. Loan functionality for Brazil enables you to maintain these loans, createpayback schedules and modify the deduction of such values previously loaned to employees. You canadjust the loan by any rate and change the value of the deduction. On termination, the outstanding balancemust be deducted. The loan may be deducted from normal payroll, vacation, 13th salary or termination.

Note: Loan payments in Brazil are via a fixed amount only. This amount may change month-by-monthdepending on the life cost factor. The life cost factor can be handled by Global Payroll rules with avariable to indicate the percentage to apply for each loan payment.

Viewing Delivered ElementsThe PeopleSoft system delivers a query that you can run to view the names of all delivered elementsdesigned for Brazil. Instructions for running the query are provided in the "Understanding How to ViewDelivered Elements" (PeopleSoft Global Payroll) topic.

Defining Loans in Brazil

This topic discusses how to define loans.

Page Used to Define Loans in Brazil

Page Name Definition Name Usage

Request Loans BRA Page GPBR_LOAN Define loan information and a repaymentschedule for an employee. Enablesyou to enter loans and related datarequired for the loan process, which arepopulated in Global Payroll to enableloan paybacks. This page distributesthe loan total amount in the number ofperiods or payments you specify andpopulates required data in Global Payrollto deduct paybacks.

Related LinksUnderstanding the Payslip Definition Process

Copyright © 1988, 2022, Oracle and/or its affiliates. 435

Tracking Loans Chapter 22

Request Loans BRA PageUse the Request Loans BRA page (GPBR_LOAN) to define loan information and a repayment schedulefor an employee.

This page lets you to enter loans and related data required for the loan process, which are populated inGlobal Payroll to enable loan paybacks. It distributes the loan total amount in the number of periods orpayments you specify and populates required data in Global Payroll to deduct paybacks.

Navigation:

Global Payroll & Absence Mgmt > Payee Data > Loans > Request Loans BRA > Request LoansBRA

This example illustrates the fields and controls on the Request Loans BRA page.

To define loans in Brazil:

1. Set up the details of a loan and a loan repayment schedule on the Request Loans BRA page.

2. Process the payroll.

Loan Definition

Field or Control Description

Element Name Select the element name (deduction) that corresponds to theloan.

Loan Number Enter the loan (reference) number for the specific employeeloan.

436 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 22 Tracking Loans

Field or Control Description

Start Date Enter the date on which the loan was provided to theemployee.

Total Amount Enter the total amount of the loan, and specify the currencycorresponding to the amount.

Loan Schedule Setup

Field or Control Description

Periods or Payment Amount Enter the number of payment periods or the amount of theloan payments. When the system generates the loan schedule itcalculates the other value.

Begin Date Enter the date on which the loan repayment begins. The begindate must be after the loan's start date.

Frequency ID Specify the frequency of the loan repayment. Values areWeekly, Biweekly, Semimonthly, and Monthly.

Create Schedule Click to create the loan schedule. In the Loan Schedulegrid, the system displays a single row with the begin dateand end date of the loan payments, along with the paymentamount. (The end date or the payment amount is calculatedautomatically based on the information you entered.)

Note: Be sure to define the same begin date as in the periods you defined on the Periods page or theAutomatic Period Creation page in the core application.

Loan Schedule

You can enter the loan schedule manually, or have the system create it by clicking the Create Schedulebutton.

Field or Control Description

Begin Date and End Date Enter the begin and end dates for the period of time on whichthe payment amount is valid.

Payment Amount This is the flat amount that is to be deducted from anemployee's payslip.

Copyright © 1988, 2022, Oracle and/or its affiliates. 437

Tracking Loans Chapter 22

Note: To create the loan schedule you must define periods, begin date and frequency or Amount.

Creating Deduction Assignments for Loan Schedules

After you define a loan schedule, the system automatically creates a deduction assignment for each loanschedule (Global Payroll & Absence Mgmt > Payee Data > Assign Earnings and Deductions >Element Assignment by Payee). The component interface creates this deduction assignment. Theprocess inserts a deduction assignment with some supporting element overrides like the following:

Field Variable

Loan Number EP VR REF EMP (Loans Reference)

Loan Amount EP VR TOTAL DEVIDO (Loan Amount)

Total Amount EP VR TOTAL (Loan's Total Amount)

Date EP VR DT PAG EMP

All of these variables are used by the process to keep track of each loan balance separately. Thesevariables are also used to calculate the deduction for each loan.

Note: Remember to define the variables listed in the table above when entering your loans outside of theRequest Loans BRA page.

Related Links"Defining Payee Overrides" (PeopleSoft Global Payroll)

Calculating Loan Payments

Loan payments (using deduction EMPRESTIMO) are calculated using formula EP FM EMPRESTIMO.

Whenever you calculate a given pay process (such as normal payroll, vacation, 13th salary or termination)the system checks for any outstanding loan installments for the employee in that month and whetheradjustments were made. Loan payments are then automatically deducted from the employee's salary. Afterthe deduction, the system stores these values for historical purposes.

Note: The EMPRESTIMO deduction cannot exceed 30 percent of net pay.

438 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 22 Tracking Loans

Adjusting Loan Payments

Adjustments can be handled using Global Payroll rules. If you want to adjust the amount of the loanpayment deduction you create a new deduction which provides a rule to reflect adjustments (changingamount or applying a factor to the deduction).

The three methods of adjusting loan values are:

1. Apply a rate to the loan principal value and then divide this value by the number of installments tomake them fixed values.

2. Apply a monthly rate on the total due value of the loan and subtract the agreed fixed portion plusadjustment.

3. Adjust only the agreed fixed portion of the installment by a monthly rate, disregarding the principalvalue of the loan.

Although some companies charge interest on loaned values, this situation is uncommon.

Copyright © 1988, 2022, Oracle and/or its affiliates. 439

Tracking Loans Chapter 22

440 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 23

Running Mass Termination Simulations

Understanding Mass Termination Simulation

Mass termination simulation provides payroll personnel the ability to obtain an estimate of the costs(termination pay) incurred in case of a workforce reduction or layoff.

The simulation is an off cycle process; it leverages the off cycle advance payment functionality that isprovided by Global Payroll core architecture to calculate earnings and deductions for terminated payeesoutside of the normal payroll cycle.

Note that the purpose of the simulation is to provide estimated costs for initiating mass terminations;finalizing of calculated payroll results is not needed and therefore not supported.

Setting Up Mass Termination Simulation ProcessHere are the high-level steps for setting up and running mass termination simulation processes:

1. Define or review the termination setup to be used, which includes the definition of terminationversions and associated termination earnings and deductions.

See Setting Up Termination Versions.

2. Enter parameters for the mass termination simulation process.

See Mass Term Simulation Data Page and Payee Detail Page.

3. Create the off cycle request, review the off cycle request data, and perform calculation.

Global Payroll off cycle processing functionality provides four off cycle types: manual payments,reversals and corrections, unscheduled payments, and advances. Global Payroll for Brazil usesadvances to process requests for mass termination simulations.

See "Initiating Off Cycle Transactions" (PeopleSoft Global Payroll) and Off Cycle On Demand Page.

4. Review payroll results.

Using the Results by Calendar Group component, you can view the termination simulation results(earnings and deductions, accumulators and supporting elements) of employees included in theprocess.

See "Viewing Results by Calendar Group" (PeopleSoft Global Payroll).

Related LinksDefining the Mass Termination Simulation Process

Copyright © 1988, 2022, Oracle and/or its affiliates. 441

Running Mass Termination Simulations Chapter 23

Defining the Mass Termination Simulation Process

This topic discusses how to define the mass termination simulation process.

Pages Used to Define the Mass Termination Simulation Process

Page Name Definition Name Usage

Mass Term Simulation Data Page GPBR_MASS_SIM Specify calendar information for thesimulation process.

Payee Detail Page GPBR_MASS_SIM_PYE Specify employees to be processed in thetermination simulation.

Off Cycle On Demand Page GP_ONDEMAND Create the off cycle terminationsimulation request.

Mass Term Simulation Data PageUse the Mass Term Simulation Data page (GPBR_MASS_SIM) to specify calendar information for thesimulation process.

Navigation:

Global Payroll & Absence Mgmt >Termination Processing >Termination Simulation BRA >MassTerm Simulation Data

This example illustrates the fields and controls on the Mass Term Simulation Data page.

442 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 23 Running Mass Termination Simulations

Field or Control Description

Off Cycle Group Displays the off cycle group name, which represents a set ofoff cycle transactions to process in the simulation.

Period ID Displays the period for the process.

The period needs to be defined in the system before it can beselected. The system populates the begin and end dates on thispage based on the selected period.

Payment Date Displays the payment date for the simulated termination orlayoff.

Source Calendar Run ID Select the predefined calendar run to use during the PayrollCalculation process.

Create Calendar Group or Edit Calendar Group Click to access the Calendar Groups page to create a calendargroup for processing off cycle transactions. If the calendargroup has been created, the button label becomes EditCalendar Group, which you click to edit the calendar groupthat is already created.

Processing Status Displays the latest’s payroll calculation process status.

Payee Detail PageUse the Payee Detail page (GPBR_MASS_SIM_PYE) to specify employees to be processed in thetermination simulation.

Navigation:

Global Payroll & Absence Mgmt >Termination Processing >Termination Simulation BRA >PayeeDetail

Copyright © 1988, 2022, Oracle and/or its affiliates. 443

Running Mass Termination Simulations Chapter 23

This example illustrates the fields and controls on the Payee Detail page (1 of 2).

This example illustrates the fields and controls on the Payee Detail page (2 of 2).

Field or Control Description

Off Cycle Group Click to start the calculation for the simulation process. Thisbutton becomes available after you have entered parametersand saved this page.

Mass Termination Data

Field or Control Description

Termination Date Enter the date that the termination simulation occurs.

Prior Notification (optional) Enter the date when a notification of the simulationwill be sent and the earning severance pay to be paid.

444 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 23 Running Mass Termination Simulations

Field or Control Description

Action Select an action for the termination simulation.

Reason Code Select a reason for the action.

Note: The system performs a validation check to make surethat the specified action and reason code combination isassociated with a termination version.

Off Cycle Reason Define the reason to be associated with the off cycle process.

Selection Criteria

Field or Control Description

Group ID Select an existing group of payees to be used for thetermination simulation. These groups are established using thegroup build feature.

You can also create a new group by clicking the Create aGroup ID button.

If you select a group, the rest of the fields are unavailable foredits.

Establishment ID Select an establishment as a filter for its associated payees tobe included the termination simulation.

Union Code Select a union as filter for its associated payees to be includedthe termination simulation.

Business Unit Select a business unit as filter for its associated payees to beincluded in the termination simulation.

You need to select a business unit prior to selecting adepartment or a job code as the additional filter.

Department Select a department as an additional filter for its associatedpayees to be included the termination simulation.

Job Code Select a job code as an additional filter for its associatedpayees to be included the termination simulation.

Copyright © 1988, 2022, Oracle and/or its affiliates. 445

Running Mass Termination Simulations Chapter 23

Field or Control Description

Insert/Update Payees Click to populate the Payee Detail section with payees thatmeet the specific selection criteria.

Delete Payees Click to remove payees from the Payee Detail section.

Additional Element Payment

Field or Control Description

Element Name Enter additional earning elements that needs to be paid as partof the simulation termination process.

Unit, Rate, and Amount Enter the unit, rate, and amount as necessary.

See the Viewing Delivered Termination Elements topic for the list of delivered earning and deductionelements to process termination pays in Global Payroll for Brazil.

Payee Detail

This section lists the payees that are populated by the system based on the specified selection criteria. Youcan also add payees manually.

The system populates this section with information that is specified in other sections (for example,termination data and job data) on this page.

Note: The information listed in this section is used for simulation purposes; you do not need to entertermination data in the Job Data component for the simulation process.

Off Cycle On Demand PageUse the Off Cycle On Demand page (GP_ONDEMAND) to create the off cycle termination simulationrequest.

Navigation:

Global Payroll & Absence Mgmt >Absence and Payroll Processing >Off Cycle >Off Cycle OnDemand

446 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 23 Running Mass Termination Simulations

This example illustrates the fields and controls on the Off Cycle On Demand page.

The simulation process uses the off cycle advance payment functionality that is provided by GlobalPayroll core architecture to calculate earnings and deductions for terminated payees outside of the normalpayroll cycle.

Click the Create Request button to add a request for the off cycle simulation process. The button label ischanged to Edit Request for you to edit the request, after it is created.

Click the Calculate button to calculate the off cycle request.

For more information about off cycle processing and steps for entering off cycle requests, see"Understanding Off Cycle Processing" (PeopleSoft Global Payroll).

Related LinksUnderstanding Mass Termination Simulation

Copyright © 1988, 2022, Oracle and/or its affiliates. 447

Running Mass Termination Simulations Chapter 23

448 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 24

Processing Termination Pay

Understanding Termination Payments

In Brazil, when you terminate an employee, you might need to make the following payments:

• Regular earnings and deductions that are due for the termination period.

• Compensation for unused paid vacation days and the vacation premium.

• Compensation for the 13th salary.

The system prorates worked days in the year to calculate the corresponding 13th salary pay.

• Severance pay or other compensation in the form of special termination earnings.

• Amount owed for all unpaid loans, independent of each other.

This amount is automatically deducted from the last payslip.

Note: Termination payments are calculated in the payroll and not as a separate process.

Viewing Delivered ElementsThe PeopleSoft system delivers a query that you can run to view the names of all delivered elementsdesigned for Brazil. Instructions for running the query are provided in the "Understanding How to ViewDelivered Elements" (PeopleSoft Global Payroll) topic.

Prerequisites

Because it is common for some payments and deductions to be made only upon termination and somestandard earnings might not be processed as part of termination pay, you must define exactly whichearnings or deductions should be processed in response to a termination.

Before termination earnings or deductions can be processed, you must:

• Define termination versions—that is, the set of reasons for termination, layoff, or completion ofcontract that are considered sufficient to trigger a set of termination payments and deductions.

• Define the earnings and deductions to process upon termination (or layoff and completion) byassociating each element with one or more termination versions.

• Use the delivered generation control element RC GC VER RESCIS to trigger the processing of eachtermination earning and deduction only when the action and reason for an employee's terminationmatch the termination version associated with the earning or deduction.

Copyright © 1988, 2022, Oracle and/or its affiliates. 449

Processing Termination Pay Chapter 24

• Identify the terminated employees and enter the appropriate action/reason for termination on the JobData pages in PeopleSoft HR.

Related LinksUnderstanding Terminations

Running the Employment Contract Termination Report

This topic provides an overview of the Employment Contract Termination report and discusses how tocreate this report.

Page Used to Run the Employment Contract Termination Report

Page Name Definition Name Usage

Legal Codes by Process Type BRA Page GPBR_RPT_CD Define process type legal codes.

Legal Codes by Action Reason BRAPage

GPBR_RPTMOV_DEF Associate action reasons with processtype legal codes.

Termination Contract Rpt BRA Page (termination contract report BRA page)

GPBR_RC_TER_CON Run the Employment ContractTermination report.

Understanding the Employment Contract Termination ReportThe Employment Contract Termination report formalizes the employee termination with the union. Usingthis report, the union evaluates if all MTPS payment requirements were met. Employees can use thereport to receive their FGTS balances.

The report shows all earnings and deductions that the employee has to receive as part of the terminationprocess; for this reason, it also functions as a payslip for the termination payment. It does not includecalculation details for averages. The report gathers only the information of terminated employees forwhom the Contract Termination calculation has been completed.

The report contains five parts:

1. Employer data.

2. Employee data.

3. Contract data.

4. Earnings and deductions calculation details.

5. Signature.

To set up the Termination Contract report:

450 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 24 Processing Termination Pay

1. Define a legal code on the Legal Codes by Process Type BRA Page.

The system delivers the 00 legal code for the Homolognet Termination process type for use intermination contract reporting.

2. Associate the legal code with action and reason on the Legal Codes by Action Reason BRA Page.

This setup task is to be performed by customers.

Legal Codes by Process Type BRA PageUse the Legal Codes by Process Type BRA page (GPBR_RPT_CD) to define process type legal codes.

Navigation:

Set Up HCM >Product Related >Global Payroll & Absence Mgmt >Reports >Legal Codes byProc Type BRA

This example illustrates the fields and controls on the Legal Codes by Process Type BRA page.

The system delivers the 00 legal code for the Homolognet Termination process type to support thereporting of terminations by agreement. When the Termination Contract report (the TRCT type) is run, thesystem populates the Causa do Afastamento field of the report with the description text that is specified inthis legal code, and leaves the Cod. Afastamento field blank.

See Also Legal Codes by Action Reason BRA Page

Legal Codes by Action Reason BRA PageUse the Legal Codes by Action Reason BRA page (GPBR_RPTMOV_DEF) to associate action reasonswith process type legal codes.

Navigation:

Set Up HCM >Product Related >Global Payroll & Absence Mgmt >Reports >Legal Codes byAction Reason BRA

Copyright © 1988, 2022, Oracle and/or its affiliates. 451

Processing Termination Pay Chapter 24

This example illustrates the fields and controls on the Legal Codes by Action Reason BRA page.

As part of the setup for Termination Contract reporting to support terminations by agreement, you needto associate the system-delivered legal code (00) with the appropriate action and reason for your businessneeds.

Termination Contract Rpt BRA PageUse the Termination Contract Rpt BRA (termination contract report BRA) page (GPBR_RC_TER_CON)to run the Employment Contract Termination report.

Navigation:

Global Payroll & Absence Mgmt > Termination Processing > TRCT Report BRA > TerminationContract Rpt BRA

452 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 24 Processing Termination Pay

This example illustrates the fields and controls on the Termination Contract Rpt BRA page.

Field or Control Description

Report Type Select a report type to run, THRCT, TQRCT, TRCT, or run allof them.

Begin Date and End Date Enter a date range. The system will select only records fallingon or between these dates.

Format ID Select the element list that contains all the required earningsand deductions that need to be printed, for example, KRDEMPGTO.

Run Type Select the termination run type.

Vacation Remuneration Select the accumulator that contains the total amount fortermination compensation purposes. TR REM TER RES isprovided as an example for this accumulator.

Copyright © 1988, 2022, Oracle and/or its affiliates. 453

Processing Termination Pay Chapter 24

Field or Control Description

Alimony Percentage If the employee has any garnishment, such as alimony, andyou would like to print the percentage that the employee pays, you need to provide a variable element name. TR VR %PENALIM is provided as an example of a variable element. Youneed to override this variable at the payee level to assign apercentage at the payee level.

Select Establishment ID and Establishment ID Select to report on all dismissed employees from selectedestablishments. Enter the establishment IDs in theEstablishment Data group box.

Select Department ID, Set ID, and Department ID Select to report on all dismissed employees from selecteddepartments. Enter the setIDs and department IDs in theDepartment Data group box.

Select Employees and Empl ID Select to report on selected employees. Enter the employeeIDs in the Employee Data group box.

Running the Unemployment Insurance Request Report

This topic provides an overview of the Unemployment Insurance Request report and discusses how toprocess unemployment insurance requests.

Page Used to Run the Unemployment Insurance Request Report

Page Name Definition Name Usage

Unemployment Insurance Rpt BRA Page(unemployment insurance report BRApage)

GPBR_RC_UNEMP Run the Unemployment Insurancereport.

Understanding the Unemployment Insurance Request ReportUse the Unemployment Insurance Request process to create the Caixa Economica Federal unemploymentinsurance form upon the request of a terminated employee. The report consists of the following two parts:

• Unemployment Insurance Request

• Dismissal Notice

Note: Only issue the request for dismissed employees for whom you've performed the employmenttermination calculation. Also, remember that this report includes the mother's name and the employee'saddress. If you want this information to appear in the report, you must remember to enter it.

454 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 24 Processing Termination Pay

Unemployment Insurance Rpt BRA PageUse the Unemployment Insurance Rpt BRA (unemployment insurance report BRA) page(GPBR_RC_UNEMP) to run the Unemployment Insurance report.

Navigation:

Global Payroll & Absence Mgmt > Termination Processing > Unemployment Insurance BRA >Unemployment Insurance Rpt BRA

This example illustrates the fields and controls on the Unemployment Insurance Rpt BRA page.

Field or Control Description

Horizontal Alignment Use this field to align the horizontal printing of the report. Enter a value to change the default alignment value deliveredwith the report to adjust the report horizontally to your printer.

Vertical Alignment Use this field to align the vertical printing of the report. Enter avalue to change the default alignment value delivered with thereport to adjust the report vertically to your printer.

Output Select the output format of the report. Values are Both, FileOnly, and Report Only.

Employee ID or Name Select to use employee ID or employee name as the payeelevel sort order.

Copyright © 1988, 2022, Oracle and/or its affiliates. 455

Processing Termination Pay Chapter 24

Field or Control Description

Selection Criteria Specify the data selection criteria for the report. Values are:

All Employees

Select Department ID

Select Employees

Select Establishment ID

Select Group ID

Departments Enter one or more departments from which the employmenttermination information needs to be included in the report.

This section appears if the Select Department ID option isspecified as the selection criteria.

Employees Select one or more employees from whom the employmenttermination information needs to be included in the report.

This section appears if the Select Employees option is specifiedas the selection criteria.

Establishments Select one or more establishments from which the employmenttermination information needs to be included in the report.

This section appears if the Select Establishment ID option isspecified as the selection criteria.

Group ID Select a group from which the employment terminationinformation needs to be included in the report.

This section appears if the Select Group ID option is specifiedas the selection criteria.

Run Type Enter one or more run types to be printed.

Note: After you run the process, ensure that the information is complete and that the employee is entitledto unemployment insurance.

Viewing Delivered Termination Elements

This topic contains information about the following elements that Global Payroll for Brazil delivers toprocess termination payments:

• Termination earnings.

• Termination process lists and sections.

456 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 24 Processing Termination Pay

Termination EarningsPeopleSoft delivers the following earnings as models of elements that you can create to processtermination pay.

Note: The delivered termination earnings for Brazil are defined as PeopleSoft Delivered/Not Maintained,which enables you to modify them to fit your needs. You can also create entirely new terminationelements using the delivered elements as your guide.

Earning Element Description

ADIC FÉRIAS Additional Vacations Termination

This earning is the total sum of FERIAS INDEN, DOBRO FERIAS, FERVENCIDO divided by 3.

AVISO INDEM Severance Pay–Prior Notice

If the employee is dismissed without reason and was contracted for anundetermined time, he should receive 1 month of salary of compensation.

DOBRO FÉRIAS Paid Dobro Vacations Termination

In case of terminations, the employee is entitled to double vacations, if at thedismissal date the employee has worked there for at least two entitlementperiods.

DSR INDENIZ Indemnified DSR

This earning pays an extra day of salary for the weekly rest day that is grantedto the employee after a whole week of work (Monday through Friday orSaturday).

DSR SAB COM Compensated Saturday DSR

This earning pays an extra day of salary if the termination occurs on a Friday, and that Saturday is considered a compensation day in the employee’s workschedule.

DSR SAB COM contributes to the gross taxable base, the family allowancebase, FGTS base, monthly social security base, as well as other employers’social security base, gross, adjustments to FGTS and alimony.

ESTAB PROV Severance Pay by Stability

If an employee is dismissed and he suffered an occupational accident at leasttwelve months before the dismissal, the employer must pay an additionalcompensation.

FÉRIAS INDEN Indemnified Vacations Termination

This earning pays for vacations that the employee never takes.

Copyright © 1988, 2022, Oracle and/or its affiliates. 457

Processing Termination Pay Chapter 24

Earning Element Description

INDENIZA ADC Additional Severance Pay

If the employee is dismissed without reason in the 30 days before his base date, the employee is entitled to 1 month of salary on the date of dismissal.

IND A479 EE Severance Pay Remaining Contract

If an employee finishes a contract for an established term before the end date, the employer pays the employee half of the compensation the employee wouldearn if the employee worked until the end of the contract.

IND A 479 ER Severance Pay Remaining Contract

If an employer dismisses an employee with a contract for an established termwithout reason, the employee is entitled to half of the pay the employee wouldbe entitled to if employed until the end of the contract.

Termination DeductionsPeopleSoft delivers the following deductions as models of elements that you can create to processtermination pay.

Note: The delivered termination deductions for Brazil are defined as PeopleSoft Delivered/NotMaintained, which enables you to modify them to fit your needs. You can also create entirely newtermination elements using the delivered elements as your guide.

Deductions Description

FGTS MES AN FGTS Previous Month

FGTS QUITAÇÃ FGTS Settlement

FGTS ART 22 40% of FGTS Art. 22

Termination Process Lists and SectionsThe preceding lists of termination earnings and deductions can be found in the section GR SERESCISÃO. There is no defined process list for terminations, since the regular payroll calculationincludes termination payments.

Note: PeopleSoft delivers a query that you can run to view the names of all delivered elements that aredesigned for Brazil.

Related Links"Understanding Earning and Deduction Elements" (PeopleSoft Global Payroll)

458 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 24 Processing Termination Pay

"Understanding Processing Elements" (PeopleSoft Global Payroll)"Understanding How to View Delivered Elements" (PeopleSoft Global Payroll)

Copyright © 1988, 2022, Oracle and/or its affiliates. 459

Processing Termination Pay Chapter 24

460 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 25

Processing Mass Termination andComplementary Termination Payroll

Understanding Mass Termination and ComplementaryTermination Payroll

Global Payroll for Brazil provides the mass termination and complementary termination payrollfunctionality that simplifies the processing of termination and complementary termination pays fora group of employees in the event of a workforce reduction or layoff. The process includes a setupcomponent in which you create an off cycle group for a pay group and pay period, specify the typeof mass process (termination or complement) you wish to run with supporting information, and selectthe employees to be included in it. When the setup is completed, the system extracts the data fromemployees’ Job records and automatically inserts the information into the system as an off cycle ondemand process. For complementary termination payments, it populates all the required variables anddummy positive inputs to ensure that the process runs properly. With the off cycle on demand processprepopulated, you can begin the process like any other off cycle processes you have in the system—createan off cycle request for the off cycle group, run the calculation and finalize the calculation payroll.

As mentioned previously, two types of mass processes are supported: Termination and Complement(additional payments that are paid outside of the normal payroll schedule). With complementarytermination processing, you have the option to process mass salary increases as well. Depending on theprocess selected, the information collected in the setup is slightly different. Refer to the Payee Detail Pagetopic for more information on setting up the mass termination and complementary termination processing.

Setting Up Mass Termination and Complementary Termination ProcessingHere are the high-levels steps for setting up and running mass termination and complementarytermination processes:

1. Define or review the termination setup to be used, which includes the definition of terminationversions and associated termination earnings and deductions.

See Setting Up Termination Versions.

2. (For complementary termination) Update the run type that is used in complementary terminationprocessing, for example, KR RESCISA, with the following information:

Field or Control Description

Allow Duplicates [Selected]

Copyright © 1988, 2022, Oracle and/or its affiliates. 461

Processing Mass Termination and Complementary Termination Payroll Chapter 25

Field or Control Description

Retro Adjustment Sources Specifies all run types for which retroactive adjustmentsneed to be calculated, for example, KR 13SAL, KR1A13SAL, KR FERIAS, and KR FOLHA M.

Note that if there is a complementary termination-specific run type to be used, in addition to the setupjust mentioned, it also needs to be included in the RC BR COMP TERM element.

See "Run Types Page" (PeopleSoft Global Payroll).

3. (For complementary termination) Verify that all elements that need to be calculated for retroactiveadjustments are specified on the "Retro Process Overrides Page" (PeopleSoft Global Payroll) for thecountry of Brazil.

4. (For complementary termination) Create a calendar using the following information:

Field or Control Description

Run Type Enter the termination payroll run type, for example, KRRESCISA.

Note: If you wish to calculate complementary terminationpay in the monthly payroll using the KR FOLHA Mrun type in the calendar, select the same payee selectionrecommended below. Create a positive input (with theamount set to 0) in the regular payroll calendar for theterminated employee, when the complement termination ispaid in a month that is different from the termination date.

Payee Selection Select Active PLUS Payees with.

Also, select Positive Input and Pending Retroactive Changesas additional criteria.

See "Calendars - Definition Page" (PeopleSoft Global Payroll).

5. (For complementary termination) Define a calendar group for the calendar you just created.

Field or Control Description

Process retro triggers [Selected]

Pay Group Select the pay group selected in your calendar.

Calendar ID Select the calendar created for mass process.

See "Calendar Groups Page" (PeopleSoft Global Payroll).

6. Enter parameters for the mass termination or complementary termination process.

462 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 25 Processing Mass Termination and Complementary Termination Payroll

See Mass Term & Comp Data Page and Payee Detail Page.

7. Create the off cycle request, review the off cycle request data, and perform calculation.

Global Payroll off cycle processing functionality provides four off cycle types: manual payments,reversals and corrections, unscheduled payments, and advances. Global Payroll for Brazil usesadvances to process requests for mass terminations and complementary terminations.

See "Initiating Off Cycle Transactions" (PeopleSoft Global Payroll).

8. Review payroll results.

Using the Results by Calendar Group component, you can view the calculation results (earnings anddeductions, accumulators and supporting elements) of employees included in the process.

See "Viewing Results by Calendar Group" (PeopleSoft Global Payroll).

Related LinksDefining Mass Termination and Complementary Termination Processing

Defining Mass Termination and Complementary TerminationProcessing

This topic discusses how to define the mass termination and complementary termination processing.

Pages Used to Define Mass Termination and Complementary TerminationProcessing

Page Name Definition Name Usage

Mass Term & Comp Data Page GPBR_MASS_TER_COMP Specify calendar information for themass termination or complementarytermination process.

Payee Detail Page GPBR_TER_COMP_PYE Specify employees to be processed inthe mass termination or complementarytermination process.

Off Cycle On Demand Page GP_ONDEMAND Create off cycle requests for themass termination or complementarytermination process.

Mass Term & Comp Data PageUse the Mass Term & Comp Data page (GPBR_MASS_TER_COMP) to specify calendar information forthe mass termination or complementary termination process.

Copyright © 1988, 2022, Oracle and/or its affiliates. 463

Processing Mass Termination and Complementary Termination Payroll Chapter 25

Navigation:

Global Payroll & Absence Mgmt >Termination Processing >Mass Termination RequestBRA >Mass Term & Comp Data

This example illustrates the fields and controls on the Mass Term & Comp Data page.

The page layout of the Mass Term & Comp Data page is identical to the Mass Term Simulation DataPage.

Field or Control Description

Off Cycle Group Displays the name of the off cycle group that was specifiedearlier for the request.

Period ID Displays the selected period for the process.

The period needs to be defined in the system before it can beselected. The system populates the begin and end dates on thispage based on the selected period.

Payment Date Enter the payment date for the mass process.

Source Calendar Run ID Select the calendar group that was created for the massprocess.

464 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 25 Processing Mass Termination and Complementary Termination Payroll

Field or Control Description

Create Calendar Group or Edit Calendar Group Click to access the Calendar Groups page to create or updatea calendar group for processing off cycle transactions. Oncethe calendar group is created, the button label becomes EditCalendar Group, which you click to edit the calendar groupthat is already created.

Note: (For complementary termination) Make sure that theProcess retro triggers option is selected for the calendargroup.

Processing Status Displays the latest’s payroll calculation process status.

Payee Detail PageUse the Payee Detail page (GPBR_TER_COMP_PYE) to specify employees to be processed in the masstermination or complementary termination process.

Navigation:

Global Payroll & Absence Mgmt >Termination Processing >Mass Termination RequestBRA >Payee Detail

This example illustrates the fields and controls on the Payee Detail - Mass Term & Comp BRA page (1 of2).

Copyright © 1988, 2022, Oracle and/or its affiliates. 465

Processing Mass Termination and Complementary Termination Payroll Chapter 25

This example illustrates the fields and controls on the Payee Detail - Mass Term & Comp BRA page (2 of2).

Use this page to specify payees to be processed in the mass termination or complementary terminationprocess.

Field or Control Description

Off Cycle Group Click to access the Off Cycle On Demand Group page andreview the off cycle transaction that is generated for thecurrent off cycle group behind the scenes.

Mass Termination Data

Field or Control Description

Mass Process Option Select the mass process you want to run, Termination orComplement.

Select Termination for processing termination pays foremployees.

Select Complement if additional income needs to be paid aspart of termination pays for employees.

If Complement is selected, the Complement Setup sectionappears on this page to collect additional information for theprocess.

466 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 25 Processing Mass Termination and Complementary Termination Payroll

Field or Control Description

Off Cycle Reason Select the reason for running this off cycle process.

Termination Setup

The Termination Setup section and Termination Data section are identical.

Field or Control Description

Period Begin Date and Period End Date Enter the begin and end dates for the selected process.

Action Select an action for the termination process.

Reason Code Select a reason for the termination process.

Run Type Positive Input

Field or Control Description

Run Type Select a run type for the process.

(For complementary termination) Typically this run typewould be the same one that was used to calculate the originaltermination, for example, KR RESCISA. If there is acomplementary termination-specific run type to be used, itneeds to be included in the RC BR COMP TERM bracketelement.

Complement Setup

This section is displayed if the mass process option is Complement. It includes the Termination Datasection and Increase Data section (if the Salary Increase option is selected).

Field or Control Description

Salary Increase Select if you want to process mass salary increases foremployees. When enabled, the system looks for salaryincreases that are entered in the job data.

When this option is enabled, enter additional information inthe Increase Data section that appears for use in the calculationprocess.

Copyright © 1988, 2022, Oracle and/or its affiliates. 467

Processing Mass Termination and Complementary Termination Payroll Chapter 25

Field or Control Description

Calendar ID Select a calendar ID for the complement payroll to beprocessed and paid.

(For complementary termination) The system populates theRC VR TERM variable (with the numeric value set to 1) in thecalendar specified in this field.

Increase Data

This section is displayed if the Salary Increase field is selected. Use this section to specify the payperiod, as well as the action and action reason for the increase.

Selection Criteria

Field or Control Description

Group ID Select an existing group of payees to be used for the selectedprocess. These groups are established using the group buildfeature.

You can also create a new group by clicking the Create aGroup ID button.

If you select a group, the rest of the fields are unavailable foredits. This field is disabled when you use any of the followingfilters to select employees for the process.

Create a Group ID Click to create a group for use in the selected process.

Establishment ID Select an establishment as a filter for its associated payees tobe included the selected process.

Union Code Select a union as filter for its associated payees to be includedthe selected process.

Business Unit Select a business unit as filter for its associated payees to beincluded in the selected process.

You need to select a business unit prior to selecting adepartment or a job code as the additional filter.

Department Select a department as an additional filter for its associatedpayees to be included the selected process.

468 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 25 Processing Mass Termination and Complementary Termination Payroll

Field or Control Description

Job Code Select a job code as an additional filter for its associatedpayees to be included the selected process.

Insert/Update Payees Click to populate the Payee Detail section with payees thatmeet the specific selection criteria.

Delete Payees Click to remove payees from the Payee Detail section.

Additional Element Payment

Field or Control Description

Element Name Enter additional earning elements that needs to be paid as partof the selected process.

Unit, Rate, and Amount Enter the unit, rate, and amount as necessary.

Payee Detail

This section lists the payees that are populated by the system based on the specified selection criteria. Youcan also add payees manually.

The system populates this section with information that is specified in other sections (for example,termination data and job data) on this page.

Note: Make sure that the termination data is entered in the Job Data component for employees in orderfor the mass termination and complementary termination process to run properly.

Off Cycle On Demand PageUse the Off Cycle On Demand page (GP_ONDEMAND) to create the off cycle requests for the masstermination or complementary termination process.

Navigation:

• Global Payroll & Absence Mgmt >Absence and Payroll Processing >Off Cycle >Off Cycle OnDemand

• Click the Off Cycle Group button on the Payee Detail page.

Copyright © 1988, 2022, Oracle and/or its affiliates. 469

Processing Mass Termination and Complementary Termination Payroll Chapter 25

This example illustrates the fields and controls on the Off Cycle On Demand page (termination andcomplementary termination process).

The process uses the off cycle advance payment functionality that is provided by Global Payroll corearchitecture to calculate earnings and deductions for terminated payees outside of the normal payrollcycle.

Click the Create Request button to add a request for the off cycle process. The button label is changed toEdit Request for you to edit the request, after it is created.

Click the Calculate button to calculate the off cycle request.

For more information about off cycle processing and steps for entering off cycle requests, see"Understanding Off Cycle Processing" (PeopleSoft Global Payroll).

Related LinksUnderstanding Mass Termination and Complementary Termination Payroll

470 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 26

Managing Year-End Reporting

Understanding RAIS Reporting

The RAIS report (GPBRRA01), produced for the Ministerio do Trahalho e Emprego (Ministry of Labor),identifies employees who received wages or a salary during the year. It is used by the government toverify the contributions to the social security fund for years of service (FGTS), to provide statisticalinformation for labor market research, and for other purposes.

PrerequisitesBefore you can generate the annual RAIS report, you must enter RAIS parameters for each establishmenton the "Additional Info - Brazil Page" (PeopleSoft Human Resources Administer Workforce). Select theinscription type (CEI or CNPJ) and complete the following sections of that page:

• RAIS Data

• Union Code Contributions

• RAIS Responsible

Also, be sure to enter the establishment's national ID for CNPJ in the Establishment ID section at thebottom of the page.

Labor Reform Update

As part of the Labor Reform implemented in late year 2017, adjustments are made to the RAIS report tosupport the income reporting of:

• Pregnant apprentices, who have Trainee as the employee class on the "Job InformationPage" (PeopleSoft Human Resources Administer Workforce), and specify a pregnant date on theFGTS and Stability page that falls within the reporting year.

• Part-time employees, who are specified as part-time on the Job Information page.

• Remote employees, who have Telecommuting as the working time type on the "(BRA) AdditionalInformation BRA Page" (PeopleSoft Human Resources Administer Workforce).

• Employees with intermittent work periods.

Defining Company Parameters for the RAIS Report

This topic discusses how to define a company’s RAIS parameters.

Copyright © 1988, 2022, Oracle and/or its affiliates. 471

Managing Year-End Reporting Chapter 26

Pages Used to Define a Company's RAIS Parameters

Page Name Definition Name Usage

RAIS Parameters Page GPBR_PARM_RAIS Define basic parameters for RAISreporting.

RAIS Values Page GPBR_PARM_RAIS2 Select the elements that define themonthly remuneration values for RAISreporting.

RAIS Absence Parameter Page GPBR_ABS_RAIS Define absence parameters for RAISreporting.

RAIS Parameters PageUse the RAIS Parameters page (GPBR_PARM_RAIS) to define basic parameters for RAIS reporting.

Navigation:

Set Up HCM > Product Related > Global Payroll & Absence Mgmt > Reports > RAIS ParametersBRA > RAIS Parameters

This example illustrates the fields and controls on the RAIS Parameters page.

Field or Control Description

Base Date for Collective Agreement Enter the month of the negotiations for the collectiveagreement.

472 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 26 Managing Year-End Reporting

Field or Control Description

Establishment Responsible Identify the establishment that is responsible for managing thecollective agreement on behalf of the company.

Get Company Legal Name

Identify which name is to appear on the RAIS report: the name of the company or the name of theestablishment selected in the Establishment Responsible field.

Company Usage

Use these fields if you want to include additional data in the report for each employee, such as EMPLID(employee ID) or DEPTID (department ID). This data can help you research and verify employee data inthe report. You can select any field from the PS_JOB record. When you produce the report, the systemincludes the first 20 positions of the data from the selected (combined) fields, truncating data that exceedsthis limit.

Contractual Salary

For each salary type that your company uses, identify the earning elements, rate codes (or both) that areused to calculate the contractual salary.

Field or Control Description

Contract Salary Type Select from the following: Commission, Daily, Fortnight, Hourly, Monthly, Per Task, or Weekly. (Define a payee'scontract salary type on the Job Information page in PeopleSoftHR.)

Element Type Select from the following: Earning or Rate Code.

Note: Rate codes read the value that is entered on the Compensation page in PeopleSoft HR.

Related Links"Compensation Page" (PeopleSoft Human Resources Administer Workforce)

RAIS Values PageUse the RAIS Values page (GPBR_PARM_RAIS2) to select the elements that define the monthlyremuneration values for RAIS reporting.

Navigation:

Set Up HCM > Product Related > Global Payroll & Absence Mgmt > Reports > RAIS ParametersBRA > RAIS Values

Copyright © 1988, 2022, Oracle and/or its affiliates. 473

Managing Year-End Reporting Chapter 26

This example illustrates the fields and controls on the RAIS Values page (1 of 2).

This example illustrates the fields and controls on the RAIS Values page (2 of 2).

The sections of the RAIS Values page correspond to sections of the RAIS report. Select the elements thatprovide the values for each section.

Field or Control Description

Variable Name Select the variable that stores the current minimum wage.PeopleSoft delivers, but does not maintain, the variable FP VRSAL MIN NAC for the national minimum salary.

Monthly Remuneration for RAIS

Field or Control Description

Element Type Options are Deduction, Earning, Monthly Rate, and RateCode.

474 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 26 Managing Year-End Reporting

Paid in the Vacation Payroll

List the earning elements that are used to pay the 13th salary advance for vacations, and the earning ordeduction elements that return the difference between the 13th salary advance and the recalculated firstinstallment.

Field or Control Description

Value Description Options are 13th. Salary Advance and Diff 13th. SalaryPayment.

First Installment

List the earning and deduction elements that are used to pay the first installment of the 13th salary.

Final Installment

List the earning and deduction elements that are used to pay or adjust the final installment of the 13thsalary.

Field or Control Description

Value Description Options are 13th. Salary Payment, 13th. Salary IndemnityTerm (13th salary indemnity termination), 13th. Salary Prop.Termination (13th salary proportional termination), and Differ13th. Salary.

Indemnity of Previous Notification

These fields apply to employees who are terminated before the end of their contract and to employeeswho receive less than 30 days notice when the union requirement is 30 days notice. Select the earning ordeduction elements that are used to calculate the pay difference between the contract end date and the 30-day notice period.

See Setting Up Payee Data.

Union Contributions

Use these fields to identify the earning or deduction elements that are used to calculate employeedeductions for union contributions.

Field or Control Description

Contribution Type Options are: Associative Contribution, ConfederativeContribution, Union Contribution, and Welfare Contribution.

Copyright © 1988, 2022, Oracle and/or its affiliates. 475

Managing Year-End Reporting Chapter 26

Payments in Termination

Use these fields to identify the earning or deduction elements that are used to calculate employeepayments in termination.

Field or Control Description

Termination Payment Type Options are: Bank of Hours, FGTS Fine, IndemnifiedVacations, Union Adjustments, and Other Compensations.

RAIS Absence Parameter PageUse the RAIS Absence Parameter page (GPBR_ABS_RAIS) to define absence parameters for RAISreporting.

Navigation:

Set Up HCM > Product Related > Global Payroll & Absence Mgmt > Reports > RAIS ParametersBRA > RAIS Absence Parameter

This example illustrates the fields and controls on the RAIS Absence Parameter page.

Field or Control Description

Accumulator Name Select the accumulator that stores the number of days or hoursworked for RAIS reporting purposes.

Detail

Use the Absence Take Element andAbsence Reason fields to identify the five most frequent types ofabsences in terms of days. Link each of these absence types to the corresponding RAIS absence reason.

Field or Control Description

RAIS Absence Reason Options are Illness not related to work, Illness related to work, Mandatory Military Service, Maternity or Paternity Leave, Route Labor Accident, or Typical Labor Accident.

476 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 26 Managing Year-End Reporting

Generating the RAIS Report

This topic discusses how to generate RAIS reports.

Page Used to Generate the RAIS Report

Page Name Definition Name Usage

RAIS Report BRA Page GPBR_RC_RAIS Generate the annual RAIS report.

RAIS Report BRA PageUse the RAIS Report BRA page (GPBR_RC_RAIS) to generate the annual RAIS report.

Navigation:

Global Payroll & Absence Mgmt > Year-End Processing > RAIS Report BRA > RAIS ReportBRA

This example illustrates the fields and controls on the RAIS Report BRA page.

Field or Control Description

Calendar Year Select the reporting year (the year represented by the reportdata).

Generation Date Select the date for which you are creating the report.

Copyright © 1988, 2022, Oracle and/or its affiliates. 477

Managing Year-End Reporting Chapter 26

Identifier for Mail Address

Your selection here determines the address that appears on the report. It works in conjunction with theRAIS Rep Type field on the Additional Info - Brazil page, where you select an employee, non-employee,or company.

• From Responsible Person

If you select this option, the system uses the address of the employee, non-employee, or companyidentified on the Additional Info - Brazil page.

• From Establishment

If you select this option, the system uses the address of the employee's establishment, theestablishment designated as headquarters (when non-employee is selected), or the address of theselected company.

Note: The log file for the report includes a warning when the system uses the headquartersestablishment. (The Establishment Address page identifies whether an establishment represents theheadquarters unit.)

See "(BRA) Setting Up Brazilian Workforce Tables" (PeopleSoft Human Resources AdministerWorkforce).

Delivery Type

Select First Delivery if you are producing the RAIS report for the first time. SelectRectification if thisreport corrects a previously submitted version. Enter the generation date of the originally submitted reportin theDate field.

Establishment Selection

Enter one or more establishments for which the RAIS Report is generated. The system generates thereport only for the specified establishments.

Reviewing the Log File and Resolving ErrorsWhen you generate the RAIS report, the system produces a log file that lists any errors or warnings youneed to resolve. The following table lists the potential errors and warnings and the pages that you use toresolve them.

Issue Page or Component

Company without parameters or without legal entity. Company component (COMPANY_TABLE)

Establishment without an inscription type (CEI or CNPJ), without CNAE, or with an incomplete or missing address.

Company without headquarters unit.

Additional Info - Brazil page (ESTAB_TBL_BRA)

478 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 26 Managing Year-End Reporting

Issue Page or Component

NonValid Information: On the run control page forthe RAIS report you instructed the system to use theestablishment's mailing address for the report, however anonemployee is identified as responsible for the report onthe Additional Info - Brazil page.

Additional Info - Brazil page (ESTAB_TBL_BRA) and RAISReport BRA page (GPBR_RC_RAIS)

City without code. City Codes BRA page (CITY_CODES_BRA)

Employee without nationality, education level, or ethnicgroup (which is required when a regulatory region of BRAis specified).

Modify a Person - Regional page (PERSONAL_DATA3)

Employee with legal name that exceeds 30 characters, orwithout legal name where the principal name exceeds 30characters.

Employee without gender, person registry (CPF) nationalID, or work card (CTPS) national ID.

Modify a Person - Biographical Details (PERSONAL_DATA1)

Union without CNPJ. Union Location (UNION_TABLE1)

Related Links"(BRA) Setting Up Brazilian Workforce Tables" (PeopleSoft Human Resources Administer Workforce)"Understanding the Process of Updating Person and Job Information" (PeopleSoft Human ResourcesAdminister Workforce)"Setting Up Unions" (PeopleSoft Human Resources Manage Labor Administration)"Setting Up Person of Interest Types" (Application Fundamentals)

Copyright © 1988, 2022, Oracle and/or its affiliates. 479

Managing Year-End Reporting Chapter 26

480 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 27

Using the General Ledger Interface

Running the General Ledger Interface Process

Page Used to Run the General Ledger Interface Process

Page Name Definition Name Usage

Send Costs to GL BRA Page GPBR_GL_PREPARE Initiate the processes for calculation ofgeneral ledger data, finalization of theGeneral Ledger Interface, and statisticaldata updates.

Understanding the General Ledger Interface ProcessThe Calculate phase of General Ledger Interface (GLI) processing populates the GP_GL_DATA andGP_ACC_LINE_STG tables.

When ready, complete the standard core GLI process by running the Finalize process.

See "Running the General Ledger Process and Sending Data" (PeopleSoft Global Payroll)

Send Costs to GL BRA PageUse the Send Costs to GL BRA page (GPBR_GL_PREPARE) to initiate the processes for calculation ofgeneral ledger data, finalization of the General Ledger Interface, and statistical data updates.

Navigation:

Global Payroll & Absence Mgmt > Time and Labor / GL Costs > Send Costs to GL BRA

Copyright © 1988, 2022, Oracle and/or its affiliates. 481

Using the General Ledger Interface Chapter 27

This example illustrates the fields and controls on the Send Costs to GL BRA page.

The fields on the this run control page for Brazil are identical to those on the "Send Costs to GLPage" (PeopleSoft Global Payroll) in the Global Payroll core application.

482 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 28

Global Payroll for Brazil Reports

Global Payroll for Brazil Reports: A to Z

The table in this topic lists the Global Payroll for Brazil reports, sorted by report ID.

For more information about running these reports, refer to:

• The corresponding topic in this product documentation.

• PeopleTools: Process Scheduler

• PeopleTools: BI Publisher for PeopleSoft

• PeopleTools: SQR Language Reference for PeopleSoft

For samples of these reports, see the Report Samples that are published with this online documentation.

Report ID and ReportName

Description Navigation Run Control Page

GPBRMA01

Report name varies (asspecified by user on runcontrol page)

This report shows workers’information based on theirpayroll results, and lists theelements participation in socialwelfare contributions andincome tax.

Global Payroll & AbsenceMgmt > Absence andPayroll Processing >Reports >MANAD ReportBRA >MANAD File ProcessBRA

GPBR_RC_MANAD

GPBR_ES_PCLOSE

eSocial Period Control (eSocial Fechamento dePeriodo)

This report displays pendingevents and calendar groups thatare identified for companieswhen the GPBR_ES_PERCprocess is run to closecompetency periods for eSocialperiodic event processing.

Note: This report is availableonly when pending events orcalendar groups are found.

Global Payroll & AbsenceMgmt > Absence andPayroll Processing >Reports >eSocialBRA >eSocial PeriodControls

GPBR_ESOC_PER_CTRL

Copyright © 1988, 2022, Oracle and/or its affiliates. 483

Global Payroll for Brazil Reports Chapter 28

Report ID and ReportName

Description Navigation Run Control Page

GPBR_RC_HRS_CA

Schedule OverrideAgreement

GPBR_HRS_CRD

Hours CompensationAgreement

Extension Agreement: Thisreport is an agreement betweenthe Employer and the Employeeindicating that the employeeagrees to extend his or herschedule when working morethan 44 hours a week.

Compensation Agreement:This report shows that theemployee's schedule agreeswith the employer's schedulefor the employee.

Global Payroll & AbsenceMgmt > Absence and PayrollProcessing > Reports >Compensation AgreementBRA > CompensationAgreement BRA

GPBR_RC_HRS_CA

GPBR_RC_RBD

Benefits by DisabilityBRA

This report is required topay any benefit related to adisability.

Global Payroll & AbsenceMgmt > Social Security/Insurance > Benefits byDisability BRA >Benefits byDisability BRA

GPBR_RC_RBD

GPBRBA01

Banking

Generates an EFT flat file. Global Payroll & AbsenceMgmt > PaymentProcessing > Create PaymentFile BRA > Create EFTPayment File BRA

GPBR_RC_EFTBANK

GPBRDE01

Depend StatemntIncome Tax BRA

Using this report, the employeedeclares his or her eligibledependents for income taxpurposes. This report is usedduring the hiring processand also in case of anydata change that affects theemployee's income tax status. This declaration should besigned by the employee. Withthis statement the employeebecomes legally responsible forthis information. The employeeis also responsible for keepingthis information up to date bynotifying human resources.

Global Payroll & AbsenceMgmt > Absence and PayrollProcessing > Reports >IRRF Dependent StatementBRA > Dependnt StatmntIncomeTax BRA

GPBR_RC_INCTAX

GPBRDE02

Family AllowanceReport

Generates a report that lists theemployees that are eligible forFamily Allowance, based on theemployee's dependent data.

Global Payroll & AbsenceMgmt > Absence and PayrollProcessing > Reports >Family Allowance RegistryBRA > Family AllowanceRegistry BRA

GPBR_RC_FAM_ALLOW

484 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 28 Global Payroll for Brazil Reports

Report ID and ReportName

Description Navigation Run Control Page

GPBRDE03

Term Resp - FamAllowance BRA

Generates a report that lists theemployees that are no longereligible for Family Allowance, based on the employee'sdependent data.

Global Payroll & AbsenceMgmt > Absence and PayrollProcessing > Reports >Family Allow. Term of RespBRA > Family Allow. Termof Resp BRA

GPBR_RC_EFAM_ALLOW

GPBRFE01

Vacation Receipt/Notice

Generates one of two reports. The first (the vacation receipt), provides information for adefined period of vacation, including either informationon the acquisitive period or theamounts of vacation time paid. This report serves as a payslipfor vacations. The second (vacation notice), provides therequired 30-day notice of anemployee's vacation dates.

Global Payroll & AbsenceMgmt > Absence and PayrollProcessing > Reports >Vacation Receipt/NoticeBRA > Vacation Receipt\Notice BRA

GPBR_RC_VAC_REC

GPBRFR01

Financial Register BRA

A summary report that showsearnings, deductions andcalculations bases for a selectedrange of months within acalendar year.

Global Payroll & AbsenceMgmt > Absence and PayrollProcessing > Reports >Financial Register BRA >Financial Register BRA

GPBR_RC_FIN_REG

GPBRGP01

GPS Report (Guia dePrevidencia Socialreport)

A monthly report used to paysocial security amounts toINSS. Enter between 01 to 13as the month of the year forwhich the GPS report runs. 13 stands for the 13th monthsalary.

Global Payroll & AbsenceMgmt > Social Security/Insurance > GPS ReportBRA > GPS Report BRA

GPBR_RC_GPS

GPBRRC01

GRFC Report BRA (Guia de recolhimientoRescisório report BRA)

A mandatory report used to paythe FGTS (Fundo de Garantiado Tempo de Serviço). Usethis report when a terminationoccurs (with employer decisionunfair cause as the reason) andyou need a printed report to paythe FGTS.

Global Payroll & AbsenceMgmt >TerminationProcessing > GRFC ReportBRA >GRFC Report BRA

GPBR_RC_GRFC

GPBRRR01

Results Register

Displays, by payee, the resultsof a payroll calculation, forthe earnings, deductions, andaccumulators you selected onthe Element Lists BRA page. Reports results by segment. Apayroll status or Open or Closedappears at the top of the report. Produce after you calculate orfinalize a payroll run.

Global Payroll & AbsenceMgmt > Absence and PayrollProcessing > Reports >Payroll Results RegisterBRA > Payroll ResultsRegister BRA

GPBR_RC_PAYRSL

Copyright © 1988, 2022, Oracle and/or its affiliates. 485

Global Payroll for Brazil Reports Chapter 28

Report ID and ReportName

Description Navigation Run Control Page

GPBRSD01

UnemploymentInsurance Report

Generates a Caixa EconomicaFederal unemploymentinsurance form, consistingof an UnemploymentInsurance Request, and aDismissal Notice. Produceafter employment terminationcalculation is run.

Global Payroll & AbsenceMgmt > TerminationProcessing > UnemploymentInsurance BRA >Unemployment Insurance RptBRA

GPBR_RC_UNEMP

GPBRSF01

SEFIP Process

Generates a FGTS PaymentForm and Information to SocialSecurity (GFIP) flat file to sendto Fundo de Garantia do Tempode Serviço (FGTS).

Global Payroll & AbsenceMgmt > Social Security/Insurance > SEFIP ReportBRA > SEFIP Report BRA

GPBR_RC_SEFIP

GPBRPS01

Payslip for Brazil

Prints the payslip for theselected establishment, groupID, or employees for theselected calendar group.

Global Payroll & AbsenceMgmt > Payslips > PrintPayslips BRA > Create/PrintPayslips BRA

GPBR_RC_PAYSLIP

GPBRTE01

Termination ContractReport

Generates a report thatformalizes the employeetermination with the union. The report includes all earningsand deductions the employeehas to receive as part of thetermination process, andtherefore serves as a payslipfor the termination payment. The Termination ContractReport includes the followingfive sections: Employer Data, Employee Data, ContractData, Earnings and Deductionscalculation results, andSignature. Generate onlyafter the contract terminationcalculation has been completed.

Global Payroll & AbsenceMgmt > TerminationProcessing > TRCT ReportBRA > Termination ContractRpt BRA

GPBR_RC_TER_CON

GPBRDA01

DARF Report

Generates the DARF report. Global Payroll & AbsenceMgmt > Taxes > DARFReport BRA > DARF ReportBRA

GPBR_RC_DARF

GPBRDI01

Monthly DIRF ReportBRA

Generates the monthly DIRFreport.

Global Payroll & AbsenceMgmt > Taxes > MonthlyDIRF Report BRA >Monthly DIRF Report BRA

GPBR_RC_DIRF_MENS

486 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 28 Global Payroll for Brazil Reports

Report ID and ReportName

Description Navigation Run Control Page

GPBRDI02

DIRF Report BRA

The Declaration of Withholdingtax (DIRF -Declaração doImposto de Renda Retido naFonte) is the report made forthe source payer that lists thevalue of the withheld at sourceincome tax.

Global Payroll & AbsenceMgmt > Year-EndProcessing > DIRF ReportBRA > DIRF Report BRA

GPBR_RC_ANNDIRF

GPBRIR01

IREN Report BRA

Generates the IREN report. Global Payroll & AbsenceMgmt > Taxes > IRRFReport BRA > IREN ReportBRA

GPBR_RC_IREN

GPBRME01

Averages Report

Generates the Averages reportincluding selection optionsfor establishment, group ID, department, and employees.

Global Payroll & AbsenceMgmt > Absence andPayroll Processing >Reports > Averages ReportBRA >Averages Report BRA

GPBR_RC_AVG

BRCAT01

CAT Report Brazil

CAT (Comunicado de Acidentede trabalho). Notice ofAccident of work is the formthat must be directed to theINSS – National Instituteof Social welfare amongother documents to receivethe benefit of SICKNESSBENEFIT OR RETIREMENTBY DISABILITY, caused by anemployee's work accident.

Workforce Monitoring >Health and Safety >Reports > CAT ReportBRA > CAT Report BRA

CATRC_INCIDENT_BRA

BRCGED01

CAGED

The Cadastro Geral deEmpregados e Desempregados– CAGED (General Registerof Employed and UnemployedIndividuals) is a permanentregister of employee hirings anddismissals.

Workforce Monitoring >Meet Regulatory RqmtsBRA > CAGED File/ReportBRA >CAGED File/ReportBRA

CAGED_RC_BRA

BRPPP01

PPP Report

The PPP (ProfileProfissiográfico Previdenciário)provides information to INSSrelated to an employee'sexposure to harmful agents.

Workforce Monitoring >Health and Safety >Reports > PPP Report BRA

PPP_RC_BRA

GPBRFE02

Vacations Credit Report

This report enables you to listthe acquisitive periods for ayear by establishment, group IDor selected employees.

Global Payroll & AbsenceMgmt > Absence and PayrollProcessing > Reports >Vacation Credit ReportBRA >Vacation CreditReport BRA

GPBR_RC_VAC_CR

Copyright © 1988, 2022, Oracle and/or its affiliates. 487

Global Payroll for Brazil Reports Chapter 28

Report ID and ReportName

Description Navigation Run Control Page

GPBRGR01

Union ContributionReport

A company discounts and paysa union contribution for itsemployees equivalent to onenormal working day. Typically, the contribution is discountedin March and paid through thisreport in April.

Global Payroll & AbsenceMgmt > Absence and PayrollProcessing >Reports >GRCS Report BRA >GRCSReport BRA

GPBR_RC_GRCS

GPBRRA01

RAIS Report BRA

The RAIS (Relação Anual dasInformações Sociais) report, produced for the Ministerio doTrahalho e Emprego (Ministryof Labor), identifies employeeswho received wages or a salaryduring the year.

Global Payroll & AbsenceMgmt > Year-EndProcessing > RAIS ReportBRA

GPBR_RC_RAIS

GPBRRC02

GRRF Report BRA

The GRRF (Guia deRecolhimiento Rescisorio doFGTS) Rescisorio CollectionGuide of the FGTS acceleratesthe processing of employeeretirements from the company.

Global Payroll & AbsenceMgmt > TerminationProcessing > GRRF ReportBRA > GRRF Report BRA

GPBR_RC_GRRF

GPBRSC01

INSS Salary ContribReport BRA (INSSsalary contributionreport BRA)

This is the Salary ContributionBase report for employeeson Illness (RELAÇÃODOS SALÁRIOS DECONTRIBUIÇÃO.)

Global Payroll & AbsenceMgmt > Social Security /Insurance > INSS SalaryContribution BRA > INSSSalary Contrib Report BRA

GPBR_RC_SALCON

GPBRTC01

Transport CouponFormat

The Transportation Coupon(DECLARAÇÃO E TERMODE COMPROMISSO VALETRANSPORTE) is used as apromise of public transportationbetween home and work foremployees

Global Payroll & AbsenceMgmt > Absence and PayrollProcessing > Reports >Transport Coupon FormatBRA >Transport CouponFormat BRA

GPBR_RC_TRCOUP

Related LinksGlobal Payroll for Brazil eSocial Event Layouts

Global Payroll for Brazil eSocial Event Layouts

Global Payroll for Brazil delivers report layouts for all eSocial events that need to be reported to theGovernment of Brazil when they occur.

488 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 28 Global Payroll for Brazil Reports

Event Event Category

S-1000 - Employer Data Basic Table

Initial Event

S-1005 - Establishment and Building Site Table Basic Table

Initial Event

S-1010 - Wage Types Table Basic Table

Initial Event

S-1020 - Tax Location Table Basic Table

Initial Event

S-1030 - Job Code Table Basic Table

Initial Event

S-1050 - Work Shift and Time Labor Table Basic Table

Initial Event

S-1060 - Workplace Table Basic Table

Initial Event

S-1070 - Administrative and Legal Proceedings Basic Table

Initial Event

S-1200 - Compensation Periodic

S-1210 - Miscellaneous Payments Periodic

S-1280 - Complementary Information to Periodic Events Periodic

S-1295 - Request for Totalization for Contingent Payment Periodic

S-1298 - Reopening Periodic Events Periodic

S-1299 - Closing Periodic Events Periodic

S-1300 - Employer Union Contribution Periodic

Copyright © 1988, 2022, Oracle and/or its affiliates. 489

Global Payroll for Brazil Reports Chapter 28

Event Event Category

S-2190 - Pre-Hiring Event Non Periodic

S-2200 - Employees Initial Loading and Hiring Non Periodic

Initial Event

S-2205 - Personal Data Changes Non Periodic

S-2206 - Employment Contract Changes Non Periodic

S-2210 - Accident at Work Communication (CAT) Non Periodic

S-2220 - Worker Health Monitoring – ASO Non Periodic

S-2221 - Toxicological Exam for Professional Drivers Non Periodic

S-2230 - Temporary Absence Non Periodic

S-2240 - Environmental Working Conditions Non Periodic

S-2250 - Termination Previous Notification Non Periodic

S-2298 - Employee Reinstatement Non Periodic

S-2299 - Termination Termination

S-2300 - Workers who have no employment relationship - Begin Non Periodic

Initial Event

S-2306 - Workers who have no employment relationship - Changes Non Periodic

S-2399 - Workers who have no employment relationship - End Termination

S-3000 - Event Exclusion Non Periodic

S-5001 - Social Contributions by Employee PeopleSoft query

S-5002 - Income Tax Withholding by Employee PeopleSoft query

S-5003 - FGTS Employee PeopleSoft query

490 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 28 Global Payroll for Brazil Reports

Event Event Category

S-5011 - Social Contributions by Employer PeopleSoft query

S-5012 - IRRF Information Consolidated by Employer PeopleSoft query

S-5013 - FGTS by Company PeopleSoft query

Event InactivationGlobal Payroll for Brazil inactivates several events in the S-1.0 version because their reports are no longerrequired by the Government. These events are:

• S-1030 - Job Code Table

• S-1050 - Work Shift and Time Labor Table

• S-1060 - Workplace Table

• S-1295 - Request for Totalization for Contingent Payment

• S-1300 - Employer Union Contribution

• S-2221 - Toxicological Exam for Professional Drivers

• S-2250 - Termination Previous Notification

• S-5012 - IRRF Information Consolidated by Employer

S-1000 - Employer DataBasic table event. This event reports employer’s registration information, rates, and other data necessaryfor the completion and validation of other eSocial events, including calculation contributions.

Information provided in this event change over time, and when that happens, separate events will be sentto report specific changes.

General Rules for Basic Table Events

Here are several general rules that apply to all basic table events, after the initial data loading for them arecompleted and eSocial becomes effective:

Note: Basic table events consist of a wide variety of company information; job code is used in theexamples provided in this section.

• In order for events to be generated and submitted properly for companies implementing eSocial:

• Companies must be enabled and configured using the Company Parameters component (eventrules, setID setup, and XML option setup).

Copyright © 1988, 2022, Oracle and/or its affiliates. 491

Global Payroll for Brazil Reports Chapter 28

• The effective dates (or begin dates) of basic table changes (including insertion, change, or deletionof data) must either be equal to or greater than the eSocial on PeopleSoft date of companies on theCompany Parameters Page. For example:

Effective date: used by S-1000 and S-1005 events

Begin date: used by the S-1010 event

Both dates: used by the S-1020 event

• The eSocial system (of the Brazilian government) accepts only one report from any Basic Table eventcode at any given period (month and year) for any eSocial-enabled company, whereas in PeopleSoft,effective dates for data rows are captured in the form of day, month, and year. When there are morethan one effective-dated row for an event code during the same month and year period, the latestone is submitted to eSocial. Each time a new effective-dated row is added in PeopleSoft, the systemchecks to see if an event has already been sent for the same month and year period. If yes, a changeevent, in which the new row information is entered in the alteracao group tag of the XML file, isgenerated to send the update to the eSocial system. If no, an inclusion event, in which the new rowinformation is entered in the inclusao group tag, is generated instead.

• In this example, suppose that three effective-dated job code rows are entered in PeopleSoft:

1. KRSI1 setID, 120000 job code, Administrator, effective date: September 01, 2016, activeeffective status

2. KRSI1 setID, 120000 job code, Director, effective date: September 03, 2016, active effectivestatus

3. KRSI1 setID, 120000 job code, President, effective date: September 20, 2016, active effectivestatus

• If these rows are processed all at the same time (for example, initial data loading), one Job Codeevent gets generated for the latest data row (#3), and the row information is populated in theinclusion section of the generated XML file.

• If these rows are entered and processed at different times after eSocial becomes effective, threedifferent Job Code events get generated as a result. The row information of the first event ispopulated in the inclusion section of the generated XML file. The second event contains rowinformation of #2 in the change section of its XML file, and the third event with row informationof #3 in the change section as well.

• Here is another example for effective-date changes. Suppose that three effective-dated job code rowsare entered in PeopleSoft, and the effective date of one row is changed:

1. KRSI1 setID, 120000 job code, Director, effective date: September 01, 2016, active effectivestatus

2. KRSI1 setID, 120000 job code, President, effective date: September 20, 2016, active effectivestatus

3. KRSI1 setID, 120000 job code, Senior President, effective date: changed from October 04, 2016to September 25, 2016, active effective status

492 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 28 Global Payroll for Brazil Reports

• If the old effective date of the changed row is the only date of its month and year period, and thenew effective date is the latest date of its month and year period (like the example), two differentJob Code events get generated as a result. The old effective date is populated in the exclusion (theexclusao XML file tag) section of the first generated event. In the second event, the informationof the new effective date (Senior President for effective date September 2016) is populated in thechange section of its XML file.

• If the old effective date of the changed row is the only date of its month and year period, forexample:

KRSI1 setID, 120000 job code, Director, effective date: September 01, 2016, active effectivestatus

KRSI1 setID, 120000 job code, President, effective date: September 20, 2016, active effectivestatus

KRSI1 setID, 120000 job code, Senior President, effective date: changed from October 04, 2016to November 01, 2016, active effective status

One Job Code event gets generated. In this Job Code event, the old and new effective dates arepopulated in the change section of its XML file.

• If the old effective date is not the only one and is the latest date of its month and year period, andthe new effective date is one but not the latest of its month and year period, for example:

KRSI1 setID, 120000 job code, Director, effective date: September 01, 2016, active effectivestatus

KRSI1 setID, 120000 job code, President, effective date: changed from September 20, 2016 toOctober 1, 2016, active effective status

KRSI1 setID, 120000 job code, Senior President, effective date: October 04, 2016, active effectivestatus

One Job Code event gets generated. In this Job Code event, the new row information (Director)for September 2016 is populated in the change section of its XML file. The existing informationfor October 2016 stays intact because the changed row is not the latest data row.

• If the old and new effective dates are not the latest or the only date of their month and year period,no events are generated.

• This example shows a few effective-dated row deletion scenarios.

• If a row is deleted, and it is the only row in its month and year period, for example:

KRSI1 setID, 120000 job code, Director, effective date: September 03, 2016, active effectivestatus

KRSI1 setID, 120000 job code, President, effective date: September 20, 2016, active effectivestatus

KRSI1 setID, 120000 job code, Senior President, effective date: October 04, 2016, active effectivestatus (deleted)

Copyright © 1988, 2022, Oracle and/or its affiliates. 493

Global Payroll for Brazil Reports Chapter 28

One Job Code event gets generated. In this Job Code event, the deleted row information ispopulated in the exclusion (the exclusao XML file tag) section of its XML file.

• If a row is deleted, and it is the latest of the rows in its month and year period, for example:

KRSI1 setID, 120000 job code, Director, effective date: September 03, 2016, active effectivestatus

KRSI1 setID, 120000 job code, President, effective date: September 20, 2016, active effectivestatus (deleted)

KRSI1 setID, 120000 job code, Senior President, effective date: October 04, 2016, active effectivestatus

One Job Code event gets generated. In this Job Code event, the deleted row information ispopulated in the change section of its XML file.

• If a row is deleted, and it is not the latest or the only date of its month and year period, no event isgenerated.

• This example shows a few effective-dated row insertion scenarios.

• If a row is added, and it is the latest of the rows in its month and year period, for example:

KRSI1 setID, 120000 job code, Director, effective date: September 20, 2016, active effectivestatus

KRSI1 setID, 120000 job code, Senior President, effective date: October 04, 2016, active effectivestatus

KRSI1 setID, 120000 job code, Vice President, effective date: October 20, 2016, active effectivestatus (added)

One Job Code event gets generated. In this Job Code event, the added row information ispopulated in the change section of its XML file.

• If a row is added, and it is the only row in its month and year period, for example:

KRSI1 setID, 120000 job code, Director, effective date: September 20, 2016, active effectivestatus

KRSI1 setID, 120000 job code, Senior President, effective date: October 04, 2016, active effectivestatus

KRSI1 setID, 120000 job code, Vice President, effective date: November 01, 2016, activeeffective status (added)

One Job Code event gets generated. In this Job Code event, the added row information ispopulated in the inclusion section of its XML file.

• If a row is added, and it is not the latest or the only date of its month and year period, no event isgenerated.

494 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 28 Global Payroll for Brazil Reports

• When a change is made to a basic table (for example, job code) and the change does not apply to theeffective date, PeopleSoft generates an event (with update in the change section) only if the changehappens to the data row with the latest date of its month and year period.

Related LinkseSocial Basic Initial PageeSocial Basic Table Event Page

S-1005 - Establishment and Building Site TableBasic table event. This event layout provides a breakdown of FPAS/third party or establishments(branches) of the taxpayer, as well as information relating to the CNAE prevailing rate and RATconstruction. Information collected in the event is used in the calculation of contributions levied on thesalaries of employees for those establishments.

Note: The S-1000 - Employer Data event must be transmitted prior to sending this event.

Refer to the S-1000 - Employer Data section for general rules that apply to basic table events.

Related LinkseSocial Basic Initial PageeSocial Basic Table Event Page

S-1010 - Wage Types TableBasic table event. This event layout is used to load all elements (wage type codes) initially and track allchanges related to earnings and deductions, their social and taxation bases, nature of the elements, andimpacts to specific features such as 13th Salary, DSR, vacation and terminations.

Note: The S-1000 - Employer Data event must be transmitted prior to sending this event.

Companies are associated with wage types tables on the "(BRA) Company Details BRAPage" (Application Fundamentals). The initial data loading process takes, for each eSocial-enabledcompany, the earnings and deduction elements available in the wage types table that the companyassociates with, and submit them to eSocial using the S-1010 event. Wage types table information witha begin date that is equal to or greater than the eSocial on PeopleSoft date of a company is submitted toeSocial for that company. If a company has more than one effective-dated row and each is associated witha different wage types table, an S-1010 event will be generated for each wage types table that meets thebegin date requirement.

After the initial loading process is completed, when a change occurs to a wage types table, S-1010events are submitted to eSocial for all companies that are associated with that wage types table. When achange is made to exemption proceeding, an S-1010 event is sent to the eSocial system for the associatedcompany only.

Wage types table changes must be sent to eSocial no later than the seventh day of the month following theupdate occurrence, or prior to the transmission of any event that requires this information for validation,whichever comes first.

Refer to the S-1000 - Employer Data section for general rules that apply to basic table events.

Copyright © 1988, 2022, Oracle and/or its affiliates. 495

Global Payroll for Brazil Reports Chapter 28

Scenarios

This example describes a few scenarios for submitting wage types table information and exemptionproceeding details to the eSocial system:

• If an element row is added to a wage types table, for example:

1 wage types table ID; 2501 wage type code, PREMIO element, INSS: 92, IRRF: 11, FGTS: 11, begindate: September 1, 2016

Because this element is associated with a code that requires exemption proceeding details to beentered, the proceeding information is specified for a particular company using that element, forexample:

1 wage types table ID, KRC company, 3265659789 proceeding number, CP (INSS) proceeding ID,PREMIO element, begin date: September 1, 2016

One wage types table event gets generated for the element row, and the row information is populatedin the inclusion section (the inclusao group tag) of the generated XML file.

• If a company (KRI) is newly linked to the wage types table mentioned above on the Company DetailsBRA page, and it needs to specify exemption proceeding details for an element (PREMIO) thatalready has proceeding code identified, for example:

1 wage types table ID; 2501 wage type code, PREMIO element, INSS: 92, IRRF: 11, FGTS: 11, begindate: November 1, 2016

1 wage types table ID, KRI company, 2822587222 proceeding number, CP (INSS) proceeding ID,PREMIO element, begin date: November 1, 2016

One wage types table event gets generated for the element row, and the row information is populatedin the inclusion section of the generated XML file. Note that a new begin date is selected for theelement to avoid error when generating the event.

• If data is updated in an element row that has been submitted to eSocial, for example, the DSR optionis selected on an element row, one wage types table event gets generated for each company that islinked to that element and begin date. The updated information is populated in the change section (thealteracao group tag) of the XML file.

• If the begin date of an existing element row is updated along with other changes that requireexemption proceeding details to be entered, for example:

1 wage types table ID; 1205 wage type code, ADIC NOTURNO element, INSS: changed from 11 to92, IRRF: changed from 11 to 92, FGTS: 11, begin date: changed from September 1, 2016 to January1, 2017

1 wage types table ID, KRC company, 2566225322 proceeding number, CP (INSS) proceeding ID,ADIC NOTURNO element, begin date: January 1, 2017

1 wage types table ID, KRC company, 1452252229 proceeding number, IRRF proceeding ID, ADICNOTURNO element, begin date: January 1, 2017

One wage types table event gets generated for the element row, and the row information is populatedin the inclusion section of the generated XML file if the new begin date is the only date of its monthand year period. If proceeding details are missing, error message is generated in the event monitor.

496 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 28 Global Payroll for Brazil Reports

• If the begin date of an existing element row is updated along with a change that requires exemptionproceeding details to be entered, for example:

1 wage types table ID; 1205 wage type code, ADIC NOTURNO element, INSS: changed from 11 to92, IRRF: 11, FGTS: 11, begin date: changed from September 1, 2016 to January 1, 2017

Multiple companies use the same wage type code and element, but only one company has specifiedexemption proceeding details, for example:

1 wage types table ID, KRC company, 2566225322 proceeding number, CP (INSS) proceeding ID,ADIC NOTURNO element, begin date: January 1, 2017

One wage types table event gets generated for the element row, and the row information is populatedin the inclusion section of the generated XML file for the KRC company. Error messages aregenerated in the event monitor for other companies that didn't specify proceeding details for theupdated element.

• If the begin date of an existing element row is updated along with other changes that no longer requireadditional proceeding details to be entered:

1 wage types table ID; 1205 wage type code, ADIC NOTURNO element, INSS: changed from 92 to11, IRRF: changed from 92 to 11, FGTS: 11, begin date: changed from January 1, 2017 to February 1,2017

One wage types table event gets generated for the element row, and the row information is populatedin the inclusion section of the generated XML file if the new begin date is the only date of its monthand year period. No action is necessary for the element's proceeding details with the old begin date(January 1, 2017).

• If proceeding details for a few elements are deleted, one wage types table event gets generated foreach element for the associated company. In each event, the deleted row information is populated inthe exclusion section (the exclusao group tag) of the XML file.

Related LinksWage Types Table PageExemption Proceedings PageeSocial Basic Initial PageeSocial Basic Table Event Page

S-1020 - Tax Location TableBasic table event. This event layout captures changes (insertion, change and deletion of records) inestablishments and service takers for companies. Information collected is used to validate other eSocialevents, such as S-1200 - Compensation, S-2200 - Employees Initial Loading and Hiring, and S-2206 -Employment Contract Changes events.

Note: The S-1000 - Employer Data event must be transmitted prior to sending this event.

Refer to the S-1000 - Employer Data section for general rules that apply to basic table events.

Related LinkseSocial Basic Initial Page

Copyright © 1988, 2022, Oracle and/or its affiliates. 497

Global Payroll for Brazil Reports Chapter 28

eSocial Basic Table Event Page

S-1030 - Job Code Table

Important! This eSocial report is no longer required and therefore has been inactivated in the S-1.0version.

Basic table event. This event layout captures changes (insertion, change and deletion of records) in theJob Code table. Information consolidated in this table is used to validate other eSocial events, such asS-2200 - Employees Initial Loading and Hiring, and S-2206 - Employment Contract Changes events.

Note: The S-1000 - Employer Data event must be transmitted prior to sending this event.

Refer to the S-1000 - Employer Data section for general rules that apply to basic table events.

Related LinkseSocial Basic Initial PageeSocial Basic Table Event Page

S-1050 - Work Shift and Time Labor Table

Important! This eSocial report is no longer required and therefore has been inactivated in the S-1.0version.

Basic table event. This event layout captures changes (insertion, change and deletion of records) in theShifts component. Financial statement information in this table is used to validate other eSocial events.

Note: The S-1000 - Employer Data event must be transmitted prior to sending this event.

Refer to the S-1000 - Employer Data section for general rules that apply to basic table events.

Related LinkseSocial Basic Initial PageeSocial Basic Table Event Page

S-1060 - Workplace Table

Important! This eSocial report is no longer required and therefore has been inactivated in the S-1.0version.

Basic table event. This event layout captures changes (insertion, change and deletion of records) ofworkplaces for companies. A Workplace Table event is triggered when a workplace is defined on the"Workplace Table BRA Page" (PeopleSoft Human Resources Monitor Health and Safety).

Refer to the S-1000 - Employer Data section for general rules that apply to basic table events.

For S-1060 events to be generated and submitted properly for companies:

498 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 28 Global Payroll for Brazil Reports

• The eSocial functionality has to be enabled on the eSocial Parameters BRA Page.

• Companies must be enabled and configured using the Company Parameters component.

• The S-1060 event must be activated on the Events Activation Page and listed on the Basic TableEvents Page, and not to be inactivated in companies’ parameter setup.

Generally, when a workplace is created on the "Workplace Table BRA Page" (PeopleSoft HumanResources Monitor Health and Safety), the system generates an S-1060 event:

• For each listed establishment, if the workplace location is set to Employer Establishment.

• For each listed establishment and service taker, if the workplace location is set to Service TakerEstablishment.

• For the listed third party establishment, if the workplace location is set to Third Party Establishment.

Initial Loading

The S-1060 event is a basic table event that is also included in the initial load process for basic tables(GPBR_ESOC_ILB) as default. When the initial load process runs for the S-1060 event and a company,the system generates an S-1060 event for each establishment (service taker, or third-party establishment)that is associated with the current row of the workplace definition of that company. If the effective date ofthe workplace definition is earlier than (<) the Health/Safety Go Live date (for example, January 1, 2019),the go-live date is used as the <iniValid> date of the event.

Note: The initial load process does not generate events for future-dated workplace definitions. If aworkplace has a future-dated row at the time of initial load, the system creates a driver record for it, whichwill then be handled by the basic table process (GPBR_ESOC_MBT) later.

After the initial loading of workplaces is completed, the eSocial system reports any new, deleted, orchanges to workplaces to the Government using the S-1060 event.

Online Transactions After Initial Loading

Here are several examples that describe the behaviors of the S-1060 event when workplaces are created,updated, or deleted from the PeopleSoft system after initial loading process is completed:

• If a new row is added to a workplace definition, and its effective date (for example, December 15,2018) is greater than the date (for example, December 1, 2018) of the current row that was sent to theGovernment, making it the new current row for the same month-year period, the system generates anS-1060 event (change event) for each associated entity (establishment, service taker, or third-partyestablishment), in which the information from the new current row (with the December 15, 2018 date)is entered in the alteracao group tag of the event’s XML file. The <iniValue> tag value (2019-01) inthese events remain the same.

If a new row is added to a workplace definition, and this time the effective date is earlier than the dateof the current row that is submitted to the Government, no event update is expected.

If a new row is added to a workplace definition after the go-live date, and it is the only row in themonth-year period (for example, February 2019) of its effective date, the system generates an S-1060event (inclusion event) for each associated entity, in which the information of this new row is enteredin the inclusao group tag of the XML file.

Copyright © 1988, 2022, Oracle and/or its affiliates. 499

Global Payroll for Brazil Reports Chapter 28

• If the effective date of the current row is changed from December 1, 2018 to February 1, 2019 (a datethat belongs to a different month-year period), and this row becomes the only row in the new month-year period, the system generates an S-1060 event (inclusion event) for each associated entity withthe information of this new row in the inclusao group tag, and generates an S-1060 event (changeevent) for each associated entity with information from the row that is now current for the December2018 month-year period in the alteracao group tag). Suppose that the effective date of the current rowis changed to a different month-year period but it does not become the most current row in the newperiod, no new S-1060 event is generated.

If the effective date of the current row is changed (from February 1, 2019 to January 1, 2019), andas a result of the update, it becomes the most current row in the new month-year period (January2019), and the old month-year period (February 2019) no longer has rows. In this case, the systemgenerates an S-1060 event (exclusion event) for each associated entity, in which the information fromthe February 2019 row is specified in the exclusao group tag, and generates an S-1060 event (changeevent) for each associated entity with the information of this new current row (January 2019) in thealteracao tag.

If the effective date of the current row is changed (from May 1, 2019 to June 1, 2019), and the rowbecomes the only row in the new month-year period (June 2019). In this case, the system generates anS-1060 event (change event) for each associated entity by specifying the updated effective date in the<novaValidade> tag, as the new value (June 2019) is the only row in the period and does not alreadyexist in the Government’s environment.

• If the workplace information (for example, description) is changed in the current row, the systemgenerates an S-1060 event (change event) for each associated entity with the updated information.

If the information is changed but is not in the most current row of the month-year period, no eventupdate is expected.

• If a new entity (establishment or service taker) is added to the current row (newly added or existing)of the workplace information after an initial load, the system generates an S-1060 event (inclusionevent) for the newly added entity. If an associated entity is removed from the row, the systemgenerates an S-1060 event (exclusion) for it.

Clicking the All Establishments (or All Service Takers) button on the Workplace Table BRA pageupdates the corresponding grid with all active establishments (or service takers) for the associatedcompany. If new establishments are added and some removed because they are no longer active, thesystem generates an S-1060 event:

• (Inclusion event) For each newly added entity.

• (Exclusion event) For each deleted entity.

• (Change event) For each entity that is still associated with the company workplace.

• If the current row is deleted from the workplace definition, the system generates an S-1060 event(change event) for each associated entity with information from the row that is now current for thesame month-year period.

If the current row is deleted and it was the only row in the month-year period, the system generates anS-1060 event (exclusion event) for each associated entity.

If a row is deleted but it is not the current row of the month-year period, no event update is expected.

500 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 28 Global Payroll for Brazil Reports

Related LinkseSocial Basic Initial PageeSocial Basic Table Event Page

S-1070 - Administrative and Legal ProceedingsBasic table event. This event captures changes (insertion, change, and deletion of records) ofadministrative and legal proceedings for employers, taxpayers, or entities with collective representationof workers against government agencies, which influence the calculation of social contributions, taxes, orFGTS.

The system triggers an S-1070 event when you create, update or delete proceeding information on the"Administrative/Legal Proceedings BRA Page" (PeopleSoft Human Resources Administer Workforce).Information entered on this page is also used in other eSocial events and in the calculation of taxes andFGTS.

The Initial Loading process rules for the S-1070 event and other Basic Table events are similar. Forexample, if there are multiple effective-dated rows on or before the company’s eSocial on PeopleSoftdate (also referred to as the company’s “go-live” date), the process selects the row with an effective datethat is the same as (if not, closest to) the go-live date, and creates a driver for it using the go-live date forthe year and month period (YYYY/MM) for the driver record. For effective-dated rows that are after thego-live date, the Initial Loading process creates one driver in each period (YYYY/MM) for the row thathas the latest effective date in that period. These drivers will be mapped and processed by the eSocialBasic Tables Initial process (GPBR_ES_ILB), as determined by the limit date on the run control page.As for future-dated rows, the system creates drivers for them as well. These drivers will be mapped andprocessed by the eSocial Basic Tables process (GPBR_ESOC_MBT), as determined by the limit date onthe run control page.

Refer to the S-1000 - Employer Data section for general rules that apply to basic table events.

General Rules

Here are several rules that apply to the Administrative and Legal Proceedings event:

• Only active administrative and legal proceedings will be considered.

• Complementary data will only be mapped for the Judicial type of proceedings that are created for Taxonly or Tax and FGTS and used in the creation of XML files.

• Tax suspension information will only be mapped for proceedings that are created for Tax only or Taxand FGTS and used in the creation of XML files.

Setup Tasks

Because Global Payroll for Brazil delivers support for the S-1070 event after the initial eSocialimplementation in PeopleSoft, for customers who like to implement S-1070 event processing inPeopleSoft, they need to follow these steps to prepare their environments:

1. Enable the Administrative and Legal Proceedings functionality on the "Adm/Legal ProceedingsParameters BRA Page" (PeopleSoft Human Resources Administer Workforce).

This is a prerequisite for S-1070 event processing.

Copyright © 1988, 2022, Oracle and/or its affiliates. 501

Global Payroll for Brazil Reports Chapter 28

2. Enter proceeding information on the "Administrative/Legal Proceedings BRA Page" (PeopleSoftHuman Resources Administer Workforce).

3. Select the Import Historical Data option on the Events Setup Page for the S-1070 event. The eventmust be inactive for the option to display.

Warning! Perform this step only if you have been using a different system to process S-1070 events,and would like to switch it over to Global Payroll for Brazil (where the rest of your eSocial events arebeing processed).

4. Add Government-accepted proceeding data (data that was previously processed in a different system)to text files to be loaded into the PeopleSoft system. Then load the historical data on the ImportHistorical Data BRA Page. Refer to the same topic for the expected format of the text file for dataimport.

Warning! Perform this step only if you have been using a different system to process S-1070 events,and would like to switch it over to Global Payroll for Brazil (where the rest of your eSocial events arebeing processed).

5. Activate the S-1070 event on theEvents Setup Page and Events Activation Page.

6. Perform initial loading for the S-1070 event on the eSocial Basic Initial Page.

Warning! Perform this step only if you are implementing eSocial in Global Payroll for Brazil as anew company, in which case the Initial Loading process will also need to be run for other Basic Tableevents.Before executing the Initial Loading process for the S-1070 event, be sure to evaluate theGovernment's implementation schedule for eSocial.

Start adding, updating, and deleting proceeding information in the PeopleSoft system. The eSocial BasicTables process on the eSocial Basic Table Event Page handles the mapping and XML file creation forS-1070 event drivers that are generated for online transactions.

Scenarios

In these scenarios, assume that:

• Company eSocial on PeopleSoft date (“go-live” date): Jan 1, 2016.

• Driver for a proceeding record (effective date: Dec 1, 2015) has been added to PeopleSoft throughthe initial loading process and reported successfully to the Government. Driver date: Jan 1 2016 anddriver status: GSUC.

Here are several examples that describe the behaviors of the S-1070 event when proceeding information iscreated, updated, or deleted from the PeopleSoft system as online transactions.

• If a new effective-dated row is added, and the effective date (Dec 10, 2015) is earlier than the go-live date but later than the existing row (Dec 1, 2015), the system generates an S-1070 event (changeevent) with information of the new row in the change section (the alteracao group tag) of its XML filefor the 2016-01 period.

If a new effective-dated row is added, and the effective date (Nov 1, 2015) is earlier than the date ofthe existing row, no event will be generated.

502 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 28 Global Payroll for Brazil Reports

• If the effective date of the existing row is changed from Dec 1, 2015 to Mar 1, 2016, and the changemakes this row the only row in the new date period (and the prior date period no longer has anyrow), the system generates an S-1070 event (change event) with the new date period (2016-03) in thenovaValidade tag within the alteracao group tag for the 2016-01 period, because the new value doesnot exist in the Government environment yet.

If the effective date of the existing row is changed and the new effective date (Dec 10, 2015) isearlier than the go-live date but later than the existing row (Dec 1, 2015), the result is similar to whenyou add a new effective-dated row—an S-1070 event (change event) is generated with the changedinformation in the alteracao group tag for the 2016-01 period.

• If the current effective-dated row (Dec 1, 2015) is deleted from the PeopleSoft system, and a row withan earlier date (Jan 1, 2014) still exists, the system generates an S-1070 event (change event) withinformation of the Jan 1 row in the alteracao group tag for the 2016-01 period.

If the deleted effective-dated row is the one with the earlier date (Jan 1, 2014), no event will begenerated.

• If a new effective-dated row is added, and its effective date is the latest (Jan 30, 2018) in the dateperiod, the system generates an S-1070 event (change event) with information of the new row in thealteracao group tag for the 2018-01 period.

• If a new effective-date row is added (Jan 1, 2019) and it is the only row in that date period, the systemgenerates an S-1070 event (inclusion event) with information of the new row in the inclusao group tagfor the 2019-01 period.

• If the effective date of the existing row is changed from Jan 1, 2018 to Jan 1, 2019, and the changemakes this row the older of the two rows in the new date period (and the prior date period no longerhas any row), the system generates an S-1070 event (exclusion event) with information for the2018-01 period.

• If the effective date of the existing row is changed from Jan 15, 2020 to Feb 1, 2020, and the changemakes this row the only row in the new date period (and the prior date period has another row), thesystem generates an S-1070 event (change event) with information of the row in the prior date periodfor the 2020-01 period, and an S-1070 event (inclusion event) with information of the moved row forthe 2020-02 period.

S-1200 - CompensationPeriodic event. This event layout provides detailed payroll information of each company employee ornon-employee for the specified competency period (month and year).

Information recorded in compensation events remains outstanding until after an event to close thecompetency period is sent to eSocial.

General Rules

Here are several general rules that apply to Compensation and Miscellaneous Payments event layouts:

• S-2200 and S-2300 events are preconditions for S-1200 - Compensation and S-1210 - MiscellaneousPayments events, as they collectively identify the payees (employees and non-employees) and theiremployment information needed for filing these two payroll events.

Copyright © 1988, 2022, Oracle and/or its affiliates. 503

Global Payroll for Brazil Reports Chapter 28

• A company needs to be associated with a wage types table on the "(BRA) Company Details BRAPage" (Application Fundamentals) in order for S-1200 and S-1210 events to be created for it.Information that is entered on the Run Types Page and Health Data Page of the Wage Types Tablecomponent is used in S-1200 and S-1210 event processing.

• S-1200 and S-1210 events are keyed by company, national ID CPF and eSocial reg number of theemployee, and payroll period.

As a general rule, only one S-1200 event and one S-1210 event are sent for the same company andemployee for any given period. If the employee has more than one active employment relationship(more than one EMPL_RCD) with the same company, the payroll amounts of all jobs are summed andthat total amount will be reported to the government.

An exception to this rule is when S-1200 and S-1210 events need to be created for run types withdifferent payroll types (annual or monthly). For example, it is common that employees receive theannual 13th month salary payment in addition to other monthly payments for the month of December.In this case, one S-1200 event will be created for the run type with the annual payroll type, and asecond one will be created for the run type with the monthly payroll type. The same is true for S-1210events.

The relationships between run types, eSocial payroll events, and payroll types are established on theRun Types Page.

• If an employee has another job assignment within the same company recently, and the new jobinformation is not yet included in the S-1200 (or S-1210) event that's created for the employee withhis or her current job, the new job information and total payroll amount (for all of the employee’sjobs) will be added and updated in that S-1200 (or S-1210) event if the event has not yet beensubmitted, and rectified in the event if it has been sent to the government.

• Global Payroll for Brazil supports the S-1200 (or S-1210) event reporting of employees who havemultiple employment relationships with different companies (companies that may or may not useGlobal Payroll for Brazil for payroll event reporting).

• Each S-1200 event and its associated S-1210 event are linked by payslip ID that is issued monthlyfor each payee. The payroll process assigns a number to each processed payment, and the paymentamount declared in the S-1200 event must also have a corresponding net amount to be reported inan S-1210 event (linked to the S-1200 event with the same payslip ID) with the date on which thepayment was made.

• If an individual was terminated with a rescission calculation during a competency period, the payrollinformation will be submitted to the government using either the S-2299 - Termination or S-2399- Workers who have no employment relationship - End event layout instead of S-1200. The netpayment will still be reported using an S-1210 event.

• If the company ID is updated in the job data of an individual after he or she is reported in the eSocialsystem, it is important that the finalized payroll of that competency period for the old company bereversed or canceled so that an exclusion of the S-1200 (or S-1210) event for the individual can beexecuted. A new calendar needs be calculated and finalized in the new company so that a new S-1200(or S-1210) event can be reported to eSocial for the individual and the new company.

• If an action with payroll impact (for example, termination, hire, or bonus pay) occurs in a period forwhich an S-1200 (or S-1210) event has already been submitted to the government, the S-1200 (orS-1210) event is rectified or excluded as needed provided that the period is not closed (absence of asubmitted S-1299 event), or is reopened (presence of a submitted S-1298 event).

504 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 28 Global Payroll for Brazil Reports

If the period is currently closed, and the S-1200 (or S-1210) event setup allows for processing afterperiod closure, the S-1200 (or S-1210) event can still be rectified or excluded as necessary.

If the period is currently closed, and the event setup does not allow for processing after period closure,the S-1200 (or S-1210) event will not be generated, and this result will be logged.

If an action occurs in a period for which an S-1200 (or S-1210) event is not yet submitted to thegovernment, corresponding driver data is updated accordingly and will be used for processing (orreprocessing) the S-1200 or (S-1210) event.

• Retroactive changes (such as outdated union labor conventions, change in absence type from sickto accident, or additional termination payments) pertaining to a closed period can be submittedby running S-1200 (or S-1210) events without the need to reopen the period. Such exceptionsare permitted for these action reasons: SEFIP 650, SEFIP 660, and termination complementaryinformation.

• When the payroll event AE process is triggered on eSocial Payroll Events page, it performs checksto make sure that the selected companies are active for eSocial reporting, the specified competencyperiod is equal to or comes after the Adhere to eSocial date (month and year) and is not closed forperiodic events, and the selected events are active. If any of these checks fails, the process stops andinformation is logged.

• The Identify Calendars option is the first processing option for S-1200 and S-1210 events. Itis responsible for finding all the applicable calendars needed for creating selected events for thespecified competency period and companies. All employees of selected companies and identifiedcalendars who have compensation data within the specified competency period are included in thepayroll event process run.

A calendar needs to satisfy a few requirements to be considered in the payroll event creation process.See the Identify Calendars option description in the Processing Phases and Options section for moreinformation.

In a simple example where the calculation of a calendar is finalized, an S-1200 event is generatedif the Period ID (representing the begin and end dates of the calendar month) is the same as thecompetency period. An S-1210 event is also created if the payee's payment date falls within thecompetency period.

However, if the Period ID or the payment date is not the same as or does not fall within thecompetency period, for instance:

• If Period ID or payment date of the payroll entry falls before the competency period, S-1200 orS-1210 is created with the Previous Competency status.

• If Period ID or payment date of the payroll entry falls after the competency period, S-1200 orS-1210 is created with the Next Competency status.

• After the payroll event AE process is run, process results are available for review on the eSocialProcessed Calendars - eSocial Payroll Events Page and eSocial Processed Employees - eSocialPayroll Events Page. These pages contain general information about the calendars that are identifiedfor S-1200 and S-1210 events, and event statuses for each payee who was included in the process forthe specified calendar ID and competency period.

Copyright © 1988, 2022, Oracle and/or its affiliates. 505

Global Payroll for Brazil Reports Chapter 28

For payees who are associated with calendars that are not in the Finalized (70) or Finalized withBank (75) calculation status, their S-1200 and S-1210 statuses are set to Awaiting Finalize Calendar.It means that preparation of payroll information for these payees is on hold until their calendarcalculations are finalized.

Note: For payees who have multiple employment relationships with the same company, it is importantthat all their payrolls have already been initiated before the Identify Calendars option is run. TheirS-1200 and S-1210 statuses are set to Awaiting Finalize Calendar until all of their associated calendarcalculations are finalized (70 or 75).

Related LinkseSocial Payroll Events PageRun Types PageHealth Data Page

S-1210 - Miscellaneous PaymentsPeriodic event. This event layout provides net payment information of each company employee or non-employee for the specified competency period (month and year). Different from the S-1200 event inwhich a payee’s detailed payroll information is reported by employee and accrual month, the S-1210event records the net payment for each payee by payment date.

Refer to the S-1200 - Compensation section for general rules that apply to the Miscellaneous Paymentsevent layout.

Related LinkseSocial Payroll Events PageRun Types PageHealth Data Page

S-1280 - Complementary Information to Periodic EventsPeriodic event. This event layout provides payroll tax relief information that is used in the calculation ofcompanies' social security contributions on salary payments.

This event reports payroll unburdening information about companies to the government. If a companyis partially replaced, it needs to submit to the authority the percentage of payroll tax reduction on amonthly basis using the S-1280 event. If it is fully replaced, submit the event with the zero tax reductionpercentage monthly also.

General Rules

Here are several rules for the Complementary Information to Periodic Events event:

• When the payroll event AE process is triggered on eSocial Payroll Events page, it performs checksto make sure that the selected companies are active for eSocial reporting, the specified competencyperiod is equal to or comes after the Adhere to eSocial date (month and year) of selected companiesand is not closed for periodic events, and the selected events are active. If any of these checks fails,the process stops and information is logged for further user actions.

506 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 28 Global Payroll for Brazil Reports

• The payroll tax exemption setup for companies’ establishment headquarters on the "Additional Info- Brazil Page" (PeopleSoft Human Resources Administer Workforce) determines if and how S-1280events are created. Suppose that the payroll event AE process is invoked to create an S-1280 eventfor a selected company and competency period, the process looks up the company’s establishmentheadquarter row that pertains to the competency period, and:

If the Other Sectors field value is set as Fully Replaced in its establishment headquarter, the systemsubmits an S-1280 event. Here is an example of the data captured in this event:

• The IndApuracao tag: 1 (monthly)

• The perApur tag: Competency year and month

• The indSubstPatr tag: 1 (fully replaced)

• The percRedContrib tag: 0 (tax reduction percentage number)

In addition to monthly S-1280 events, a company needs to report tax exemptions annually as well (for13th month salary for instance). The system checks the payroll tax exemption record that is enteredon the eSocial Payroll Tax Exempt BRA Page for the company and competency period. If the recordexists and the period type is set to Annual, the system submits an S-1280 event for the annual typeinformation on the competency month. Here is an example of the data captured in this event:

• The IndApuracao tag: 2 (annually)

• The perApur tag: Competency year

• The indSubstPatr tag: 1 (fully replaced)

• The percRedContrib tag: 0 (tax reduction percentage number)

If the Other Sectors field value is set as Partially Replaced in its establishment headquarter, thesystem extracts the period type and tax reduction percentage information that is entered on the eSocialPayroll Tax Exempt BRA Page for the company and competency period, and populates it in theevent. If the tax reduction percentage is not filled out for partially replaced company headquarters, theprocess for creating the S-1280 event cannot continue and a log will be generated as a result. Here isan example of the data captured in an S-1280 event for the Monthly period type:

• The IndApuracao tag: 1 (monthly)

• The perApur tag: Competency year and month

• The indSubstPatr tag: 2 (partially replaced)

• The percRedContrib tag: (tax reduction percentage number)

Here is an example of the data capture in an S-1280 event for the Annual period type:

• The IndApuracao tag: 2 (annually)

• The perApur tag: Competency year

• The indSubstPatr tag: 2 (partially replaced)

• The percRedContrib tag: (tax reduction percentage number)

Copyright © 1988, 2022, Oracle and/or its affiliates. 507

Global Payroll for Brazil Reports Chapter 28

• If incorrect information is submitted to the government, rectifications of S-1280 events can besent (for example, through deleting, changing or adding new tax exemption information, changingheadquarters, or changing tax exemption rules in the headquarter) for periods when the changesoccurred. The receipt number of the S-1280 event pending correction along with the data change willbe included in the rectification event.

• If the change is not on the period type or tax reduction percentage, nothing happens.

• If the data has not been submitted to the government previously, it will be updated in the driverrecords and be reported in the next S-1280 event created for the same company and period. Norectification will be created.

• If the tax exemption information is deleted (for example, removal of header information or allinformation, or changing to a different period) from the eSocial Payroll Tax Exempt BRA page afterthe information was previously submitted to the government, an exclusion of the S-1280 event willneed to be created.

If an exclusion is created by mistake and has been reported to the government successfully, to undothe mistake you need to reenter the correct data on the page so that a new S-1280 event with that datacan be submitted to the government again. If, however, the exclusion (created by mistake) has not yetbeen reported to the government, it will be replaced when the correct data gets updated in the driverrecords.

• Global Payroll for Brazil can undo exclusions and rectifications that are created by mistake, as long asif they are not yet submitted to the government.

Related LinkseSocial Payroll Events PageeSocial Payroll Tax Exempt BRA Page

S-1295 - Request for Totalization for Contingent Payment

Important! This eSocial report is no longer required and therefore has been inactivated in the S-1.0version.

Periodic event. This event layout requests the aggregation amount of social contributions and income taxbased on the information already reported to the government. Submit this event in the case when thereare issues with the S-1299 event that prevents it from being submitted successfully. Note that the S-1295event is not mandatory, and there is no validation taking place while the event is being processed.

Enter the calculation period, one or more companies, and period type for creating the events on theeSocial Period Controls Page.

Note: The system delivers the S-1295 event with the default effective date on the Events Setup Pageand Events Activation Page. To use this event, Oracle recommends that you update the effective dateaccording to the periodic event go-live date that is specified on the Company Parameters Page.

508 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 28 Global Payroll for Brazil Reports

S-1298 - Reopening Periodic EventsPeriodic event. This event layout reopens a closed period for update. Submit this event if certain payrollor payment information corrections (such as retroactive payroll calculation, complementary payment,and so on) or new information relating to movement needs to be reported to the government for a periodthat is already closed. This event must be transmitted and accepted by the government before anyrectifications can be sent.

Suppose that you create an event to send in corrections to payroll calculations that were submitted earlierfor a competency period. If an S-1299 event is already reported to close this period, and the event (the oneto use to send corrections) does not have the Allowed after period closed option enabled, you need tosubmit an S-1298 event to first reopen the closed period.

When the S-1298 event is selected to run on the eSocial Period Controls Page for a specified period,period type, and list of companies, the system checks to make sure that for each selected company andperiod, a receipt number from the government for a previously submitted S-1299 event already exists.After the S-1298 event is created, reprocess the event that has the corrections. Lastly, submit the S-1299event to close the period again. If the receipt number of a submitted S-1299 event for that period is notfound, no S-1298 event is created.

Review the log file for a list of companies and competency periods that were processed successfully, aswell as errors or issues that were identified during the process run.

Related LinksProcessing Phases and OptionseSocial Period Controls Page

S-1299 - Closing Periodic EventsPeriodic event. This event layout informs the government about the closing of a competency period forthe transmission of eSocial events. Submit this event after all events are transmitted and accepted by thegovernment for a specified competency period. In general, no more information is expected to report tothe government for the specified competency period after the acceptance of the closing event.

General Rules

Here are several rules for the Closing Periodic Events event:

• When the S-1299 event is selected to run on the eSocial Period Controls Page for a specified periodand list of companies, the system performs checks to make sure that the period is open or reopened,and that there are no pending events or non-finalized calendars for each selected eSocial-activecompany before an S-1299 event can be created. Events are considered pending if they have errors ordo not have receipt numbers returned from the government.

As the Validate Calendar and Events option is selected in the run control page for S-1299 eventprocessing, and pending events or non-finalized calendars have been identified, the information islogged for further review and user actions (for example, skip or reprocess pending events, follow upwith a payroll clerk to finalize calendars), and no S-1299 event is created. They need to be followedup on prior to submitting an S-1299 event again.

Copyright © 1988, 2022, Oracle and/or its affiliates. 509

Global Payroll for Brazil Reports Chapter 28

• If additional events (for example, corrections to data reported during open period, or new eventspertaining to movement of the period) need to be submitted after the period is closed, exceptions canbe made for events that have the Allowed after period closed option enabled in their setup.

If the Allowed after period closed option is not enabled in the setup of an event layout, late eventsfor it can still be considered for submission if a S-1298 event is sent to reopen the closed period.

If the Allowed after period closed option is not enabled in the setup of an event layout of any eventtype, and no S-1298 event has been generated to reopen a closed period, any run control requeststo process events of this layout after a closed period will be denied. These unprocessed, or blocked,events will be logged for eSocial personnel to follow up and take appropriate actions.

• If periodic events of different pay frequencies (monthly and annually) are reported for the sameperiod, an S-1299 event will be submitted to the government for each frequency.

• A company is considered a company without movement if it doesn’t have any S-1200, S-1210,and S-1280 event processing for a competency period. To close a period for a company withoutmovement, the S-1299 event (XML file) created has the No Movement flag turned on and the<compSemMovto> tag set to the month and year of the period that’s being closed.

If the company continues to not have any S-1200, S-1210, and S-1280 event processing monthlyin the years that follow, an S-1299 event needs to be submitted for each of these years in January(and can be skipped for the rest of the year). The No Movement flag is turned on and the value of the<compSemMovto> tag is set to the month and year of the last competency period when the companyreported not having any movement.

The system provides the Company Without Movement Page where you can review a list of S-1299events that were submitted for companies without movement. The report is queried by company andit lists, for each data row, the period during which the company didn’t have any movement and thereceipt number of the S-1299 event.

A PDF report with information about pending events and calendar groups is generated for companyadministrators to review and take actions accordingly.

Related LinksProcessing Phases and OptionseSocial Period Controls PageCompany Without Movement Page

S-1300 - Employer Union Contribution

Important! This eSocial report is no longer required and therefore has been inactivated in the S-1.0version.

Periodic event. This event layout reports the union dues of companies and identifies if these contributionsare compulsory or voluntary in nature.

For compulsory union contributions, events are expected once a year, usually in January. As forvoluntary union contributions, events are not expected on a regular basis; they should be submitted whencontributions are made according to the agreements signed with respective unions.

510 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 28 Global Payroll for Brazil Reports

General Rules

Here are several rules for the Employer Union Contribution event:

• The S-1300 event can be processed together or independent of (before or after) the S-1200 andS-1210 events in a competency period as long as the period remains open.

• When the S-1300 event is selected to run on the eSocial Payroll Events page for a specified periodand list of companies, the system performs checks on each selected company to make sure that theassociated union contribution information has already been entered on the eSocial Employer UnionContrib Page before an S-1300 event can be created.

For annual union contributions, select Compulsory as the contribution type. For monthly unioncontributions, select assistance, associative, or confederate as the contribution type.

• You can enter multiple rows of union contributions for any given company, period and period typethat is specified on the eSocial Employer Union Contribution page.

If the information is submitted for a compulsory, annual union contribution, the information (unioncode, contribution type, and amount) of all rows is included in a single S-1300 event for thatcompany, competency year (month is not needed for annual type event), and annual period type.

If the information is submitted for a voluntary, monthly union contribution, the information of all rowsis also included in a single event for that company, competency period (year and month), and monthlyperiod type.

Note: A maximum of two S-1300 events can be submitted for a company in any given competencyperiod if deemed necessary, one for the annual period type and one for the monthly period type.

• When new union contribution data is added for the first time, an S-1300 event is generated to submitthe information to the government. But if the new data is added to a row with existing data that hasbeen submitted previously, a rectification will be generated for the submitted S-1300 event with newlyadded data. Similarly, if a change (for example, amount change) or deletion (for example, removalof a row of union contribution) is made for data that is already sent to the government, a rectificationwill be sent to the government for the original S-1300 event. The rectification event contains thereceipt number of the original event, and the current union contribution information after the changeor deletion is made.

If all rows of union contributions are deleted, an S-3000 - Exclusion event will be submitted toremove the deleted information from the government.

• If the period type of a submitted union contribution for a company is changed from Annual orMonthly, and a monthly union contribution for the same company and competency period is alreadysubmitted to the government, the system submits an S-3000 - Exclusion event to delete the annualtype event, and a rectification event for the original S-1300 monthly event. The rectification eventcontains the receipt number and the current union information of the original event, plus the newinformation that was previously grouped as annual type contribution.

Related LinkseSocial Period Controls PageeSocial Employer Union Contrib Page

Copyright © 1988, 2022, Oracle and/or its affiliates. 511

Global Payroll for Brazil Reports Chapter 28

S-2190 - Pre-Hiring EventLabor event. See Understanding Pre-Hiring Events.

Related LinkseSocial Pre-Hiring Event PageeSocial Pre-Hiring Monitor PageeSocial Pre-Hiring Monitor - Details Page

S-2200 - Employees Initial Loading and HiringNon periodic event. Use this event layout to:

• Report lists of employees for companies.

This event needs to be invoked when a company is being activated for eSocial reporting, which canbe the time right before eSocial becomes effective, or when the company is newly created or acquiredafter the implementation of eSocial (on the eSocial on PeopleSoft date).

After the initial loading of employees is completed, employee information needs to be reportedwhenever changes are made.

• Report the hiring of employees in companies.

It is triggered when the Hire action is selected in the first row of job data for an employee, and theemployee belongs to an employee classification that is specified on the Labor Regime page.

Hiring must be reported no later than the day before the employee starts to work either through theS-2190 - Pre-Hiring or S-2200 - Employees Initial Loading and Hiring event. If an S-2190 event issent, the rest of the hiring data needs to be submitted by the seventh day of the month following theoccurrence of the hiring, using the S-2200 event.

After the submission of hiring events, changes to the employee’s personal data need to be sent toeSocial through S-2205 - Personal Data Changes events, and job data through S-2206 - EmploymentContract Changes events.

General Rules

Here are several rules for the Employees Initial Loading and Hiring event:

• It applies to employees with employment relationships (employees are associated with employeeclassifications that are specified on the Labor Regime Page, with a selected work type.

• It reports the employee data row with the most current effective date that is either earlier than or equalto (< or =) the eSocial on PeopleSoft date.

• For an employee to be included in the report, the employee’s hire date needs to be equal to or laterthan (= or >) the Company creation date, as well as equal to or earlier than (= or <) the eSocialimplementation (eSocial on PeopleSoft) date.

Information of individuals who are hired after the eSocial implementation date needs to be submittedusing either this event (for employees) or the S-2300 - Workers who have no employment relationship- Begin event (for non-employees).

512 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 28 Global Payroll for Brazil Reports

• The eSocial Reg. Number field value on the "(BRA) Additional Information BRA Page" (PeopleSoftHuman Resources Administer Workforce) is required for employees with employment relationships.

Employees are not specific to or keyed by company, and can work for more than one company at atime. Therefore, any personal data change (personal data table are keyed by EMPLID) of an employeeneeds to be submitted to eSocial for all companies with which the employee has employmentrelationships.

Job data is keyed by EMPLID and EMPL_RCD. With that, changes in job data need to be submittedto eSocial for the company associated with the employment record. If the employee has multipleemployment relationships, the same number of S-2200 events need to be generated. In those events,the personal data section remains the same, the job data section, however, contains data that is distinctfor each relationship.

• If an employee is in temporary absence, the <dtIniAfast> and <codMotAfast> tags of the S-2200event are populated with the initial absence date and absence reason.

• If an employee was terminated before the implementation of eSocial, the <dtDeslig> tag of the eventis populated with the termination date.

• If the only component or table that was updated for an employee is not effective-dated, and themaximum effective date for all components and records used to generate the event is earlier than orequal to (< or =) the eSocial implementation date, a rectification event is generated for the S-2200event.

• An update in the CPF national ID, PIS, or birth date of an employee is considered a critical change.When it occurs, a rectification is generated for the S-2200 or S-2300 event as appropriate.

• If the update is made in the company or employee class in the employee’s job data, an S-3000 - EventExclusion is generated for the corresponding event, followed by a new initial loading event for theemployee.

• If an employee has personal data and job data rows that are effective-dated after the eSocial onPeopleSoft date, while the S-2200 event takes care of the current effective-dated row (the mostcurrent effective date that is earlier than or equal to eSocial on PeopleSoft date), future rows will bereported using the S-2205 - Personal Data Changes and S-2206 - Employee Contract Changes eventsrespectively.

Related LinkseSocial Employee Initial PageeSocial Non Periodic Event Page

S-2205 - Personal Data ChangesNon periodic event. This event layout captures changes to individual’s personal information after thecompletion of the initial loading process. It includes, but not limited to, updates on education level,marital status, contact information, national ID information, tax exemption and so on in the Personal Datacomponent, and other related pages such as the Personal Information BRA and Disabilities BRA pages.

Copyright © 1988, 2022, Oracle and/or its affiliates. 513

Global Payroll for Brazil Reports Chapter 28

General Rules

These general rules apply to data change events, which include S-2205 - Personal Data Changes, S-2206- Employment Contract Changes, and S-2306 - Workers Who Have No Employment Relationship -Changes:

• When a data change occurs in any component or page involved in the data change event, the systemchecks the type of employment relationship that the individual has with the company. It gets theemployee class information of the individual from the job data, and finds out if he or she is anemployee using the setup on the Labor Regime page (employee if a work type is selected).

If the data change occurs in the Job Data component, the system also checks the setup of the OtherAction/Reason page to identify which event layout to use.

If the system is unable to identify all the information needed on these setup pages for the data changeincident (for example, the individual’s employee class is not configured on the Labor Regime page, orthe data change action is not set up on the Other Action/Reason page), no event is generated.

• When a data change occurs, the system checks if any event was already sent to eSocial with the sameeffective date <dtAlteracao>. If yes, it generates a rectification event for the sent event with the samechange date instead of creating a new one.

Note: The term change date refers to the effective date of the changed (add, update, or delete) datarow. For information from tables that are not effective-dated, the change date refers to different dates.For example, if a change is made to the phone or email information on the Contact Information pageof the Personal Data component, the change date refers to the current date.

• Employee data is not specific to any company (personal data tables are keyed by EMPLID, notEMPL_RCD). Therefore, when a data change of an individual needs to be reported to eSocial, thatchange, in the form of XML file, has to be submitted for all companies with which the individual hasemployment relationships. This is referred to as the splitting of events for multiple companies and ispart of the mapping process.

If the individual has multiple employment relationships with the same company, only one event isgenerated.

• If the change date falls within the closed period, the system sets the status of the event that isgenerated or rectified for the data change to Action Required. Events in this status requires userintervention; administrators can search for events by this status from the eSocial monitor and addressthem individually.

Personal Data Change Rules

Personal data changes for individuals can result in one or more events depending on a number ofinformation, such as the change date, eSocial on PeopleSoft date, individual’s last hire date, and the setupon the Labor Regime page and Other Action/Reason page.

• Suppose that a date change for an individual needs to be submitted to eSocial, the system decideswhich events to create or rectify based on these general conditions:

• If the change date is equal to or later than (= or >) the eSocial on PeopleSoft date, and later than(>) individual’s last hire date, the system generates a new event or rectifies the existing S-2205 -Personal Data Changes event.

514 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 28 Global Payroll for Brazil Reports

• If the change date is equal to or later than (= or >) the eSocial on PeopleSoft date, and earlierthan or equal to (< or =) individual’s last hire date, the system rectifies the existing S-2200 -Employees Initial Loading and Hiring or S-2300 - Workers who have no employment relationship- Begin event, as well as the S-2205 event if needed.

• If the change date and individual’s last hire date are both earlier than (<) the eSocial on PeopleSoftdate, the system rectifies the existing S-2200 - Employees Initial Loading and Hiring or S-2300event.

• If the change date is earlier than (<) the eSocial on PeopleSoft date, and individual’s last hire dateis later than or equal to (> or =) the eSocial on PeopleSoft date, the system rectifies the existingS-2200 or S-2300 event, as well as the S-2205 event if needed.

Note: If the change date is earlier than (<) the eSocial on PeopleSoft date, an event is generated onlyif the change date is the most current one that is earlier than the eSocial on PeopleSoft date.

• If a rectification for an existing event, or a new event is generated, all events with the same event codeand greater effective date than the rectified or generated event need to be rectified. For example:

• (Update address) On August 15, address information of an employee was added and sent toeSocial. Event used: S-2200 - Employees Initial Load and Hiring. Effective date: September 1.

On October 1, marital status was specified for the same employee and sent to eSocial. Event used:S-2205 - Personal Data Changes. Effective date or change date: October 1.

On November 1, address information is updated for the same employee. Effective date: September1.

In this case of address update, the system sends rectifications to S-2200 and S-2205 (change dateOctober 1) events.

• (Add dependent) On August 15, address information of an employee was added and sent toeSocial. Event used: S-2200 - Employees Initial Load and Hiring. Effective date: September 1.

On October 1, marital status was specified for the same employee and sent to eSocial. Event used:S-2205 - Personal Data Changes. Effective date or change date: October 1.

On November 1, address information is added for the same employee and sent to eSocial. Eventused: S-2205 - Personal Data Changes. Effective date or change date: November 1.

On November 15, a dependent is added for the same employee. Effective date: September 1.

In this case of adding a dependent, the system sends rectifications to S-2200 and S-2205 (changedates: October 1 and November 1) events.

• When an event is being created, the system fills it with information with the current effective datefrom relevant table records. For example, if a new dependent (a wife) is added for an employeewith October 1 as the effective date, the values (such as marital status, which would be updatedtogether with the new dependent) that are used to fill out the corresponding event have theeffective date equal to October 1 in their table records.

• If a data row is added, updated, or deleted, its effective date is not the most current one of theassessment period (month and year) and is earlier than (<) the eSocial on PeopleSoft date, no event isgenerated.

Copyright © 1988, 2022, Oracle and/or its affiliates. 515

Global Payroll for Brazil Reports Chapter 28

• If a data row is added, updated, or deleted, its effective date is the most current one of the assessmentperiod, and is earlier than (<) the eSocial on PeopleSoft date, the system sends a rectification for theS-2200 or S-2300 event, as well as for the S-2205 event if needed. In this example, suppose that theeSocial on PeopleSoft date is September 1:

On August 20, a name was added and sent to eSocial. Event used: S-2200 - Employees Initial Loadand Hiring. Effective date: August 20.

On August 20, a dependent was added and sent to eSocial. Event used: S-2200 - Employees InitialLoad and Hiring. Effective date: August 20.

On August 30, the dependent was deleted.

In this case of row deletion, the system sends a rectification for the S-2200 event to remove thedependent information from eSocial.

• If a data row is deleted, its effective date is earlier than (<) the eSocial on PeopleSoft date and isearlier than or equal to (< or =) the individual’s last hire date, the last hire date is later than or equalto (> or =) eSocial on PeopleSoft date, the system sends a rectification event for the S-2200 orS-2300 event, as well as the S-2205 event if needed. Suppose that the eSocial on PeopleSoft date isSeptember 1 and the individual’s last hire date is September 2:

On August 30, a name was added and sent to eSocial. Event used: S-2200 - Employees Initial Loadingand Hiring. Effective date: August 30.

On August 30, a dependent was added and sent to eSocial. Event used: S-2200 - Employees InitialLoading and Hiring. Effective date: August 30.

On September 2, the dependent was deleted.

In this case of row deletion, the system sends a rectification event for the S-2200 event, as well as theS-2205 event if needed.

• Changes to employees’ CPF national ID, PIS, and birth date cannot be reported through data changeevents. To change this type of information, rectifications must be submitted for S-2200 events foremployees, and S-2300 events for individuals without employment relationships.

The system also sends rectifications to all S-2205 events that were sent prior to updates on IDs andbirth dates.

In addition, if the company or employee classification is changed in an employee’s job data, anS-3000 - Event Exclusion event needs to be generated for the corresponding event (S-2200, S-2298 orS-2300), followed by a new event.

Other Rules

• For data changes in table records that not effective-dated (for example, PERS_NID, PERSON_BRA,PERSONAL_PHONE, EMAIL _ADDRESS, PERSON, and PERSONAL_INFO_BRA), the systemsends rectification events to corresponding events (S-2200, S-2300 and S-2205).

• Several data changes on the Personal Information BRA page (PERSONAL_INFO_BRA) impactS-1200 - Compensation events, not personal data change events. For example, NIF data, or the taxexemption date, is used when the system generates rectifications to S-1200 events.

516 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 28 Global Payroll for Brazil Reports

If a death certificate number is entered on the Personal Information BRA page, the system generates arectification to the termination event for the individual.

Related LinkseSocial Non Periodic Event Page

S-2206 - Employment Contract ChangesNon periodic event. This event layout captures changes in employments for employees after thecompletion of the initial loading process. These changes include, but not limited to, compensation andschedule payment, length of contracted work, work, position or function, journey work and so on in theJob Data component, and other related pages such as the Additional Information BRA and Unions pages.

If the last Employment Contract Changes event was sent incorrectly, a rectification event or an exclusionevent for it will be submitted to update or cancel the information.

General Rules

Refer to the General Rules section of the S-2205 - Personal Data Changes event.

Employment Contract Changes Rules

• If a rectification for an existing event or a new event is generated, all events with the same eventcode and greater effective date than the rectified or generated event need to be rectified as well. Forexample:

(Update address) On September 10, an individual was hired and the job data information was sent toeSocial. Event used: S-2200 - Employees Initial Loading and Hiring. Effective date: September 10.

On October 1, salary information was added for the employee and it was sent to eSocial. Event used:S-2206 - Employee Contract Changes. Effective date or change date: October 1.

On October 10, the job code for the employee is updated for the same employee, and the informationis sent to eSocial. Effective date: September 10.

In this job data update example, the system sends rectifications to S-2200 and S-2206 (change dateOctober 1) events.

• If a data row is added, updated, or deleted, no event is generated, if:

• Its effective date is not the most current one of its month and year period, and

• Its effective date is earlier than or equal to (< or =) the eSocial on PeopleSoft date, and

• Its last hire date is earlier than (<) the eSocial on PeopleSoft date.

• If a data row is added, updated, or deleted, rectification events may be sent to S-2200, S-2300,S-2206, S-2306 as needed, if:

• Its effective date is the most current one of its month and year period, and

Copyright © 1988, 2022, Oracle and/or its affiliates. 517

Global Payroll for Brazil Reports Chapter 28

• Its effective date is earlier than (< ) the eSocial on PeopleSoft date.

For example, on August 31 2016, an employee’s hire and salary information was loaded to eSocial.Event used: S-2200 - Employees Initial Load and Hiring. Effective date: July 01, 2015.

On September 1 2016, more salary information was added for the employee and the information wassent to eSocial. Event used: S-2206 - Employee Contract Changes. Effective date or change date:October 1 2016.

On September 5 2016, salary information is updated for the employee, and the information is sent toeSocial. Effective date: July 01 2015.

In this salary update example, the system sends rectifications to S-2200 and S-2206 (change dateOctober 1) events.

• This example shows an effective-dated row deletion scenario. Suppose that these rows exist in thePeopleSoft system:

From the Job Data component:

• KR00011 emplID, Hire action and Add reason, effective date: June 01, 2014

• KR00011 emplID, Hire action and Add reason, effective date: July 01, 2014

• KR00011 emplID, Pay action and Merit reason, effective date: July 01, 2015, event used: S-2200

• KR00011 emplID, DTA action and DTA reason, effective date: September 01, 2016, event used:S-2206

• KR00011 emplID, Pay action and Merit reason, effective date: September 01, 2016, event used:S-2206 (rectification), change date: September 01, 2016

• KR00011 emplID, DTA action and DTA reason, effective date: November 01, 2016, event used:S-2206, change date: November 01, 2016

• KR00011 emplID, DTA action and DTA reason, effective date: January 01, 2017, event used:S-2206, change date: January 01, 2017

From the Payee Parameters page:

• KR00011 emplID, begin date: June 01, 2014

• KR00011 emplID, begin date: June 01, 2015, event used: S-2200

• KR00011 emplID, begin date: September 01, 2016, event used: S-2206

• KR00011 emplID, begin date: October 01, 2016, event used: S-2206, change date: October 1,2016 (deleted)

• KR00011 emplID, begin date: December 01, 2016, event used: S-2206, change date: December 1,2016

If a row is deleted, and:

• Its effective date is equal to or greater than (= or >) the eSocial on PeopleSoft date (for example,September 1, 2016), and

518 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 28 Global Payroll for Brazil Reports

• Its effective date is greater than (>) the last hire date, and

• The data row is the only one in its month and year period.

The system generates an S-3000 - Event Exclusion event for the event with <dtAlteracao> thatis equal to effective date of the deleted row. In this example, the exclusion event is generated forthe S-2206 event with the effective date of October 1, 2016. In addition, rectifications are sentfor events with <dtAlteracao> that are later than the excluded event. In this example, these eventsinclude the two S-2206 events with November 01, 2016 and January 01, 2017 effective dates fromthe Job Data component, and the S-2206 event with the December 1, 2016 effective date from thePayee Parameter page.

• This example shows an effective-dated row update scenario. Suppose that these rows exist in thePeopleSoft system:

From the Job Data component:

• KR00011 emplID, Hire action and Add reason, effective date: September 01, 2016, event used:S-2200

• KR00011 emplID, DTA action and DTA reason, effective date: September 15, 2016, event used:S-2206, change date: September 15, 2016

• KR00011 emplID, DTA action and DTA reason, effective date: changed from October 01, 2016 toNovember 1, 2016, event used: S-2206, change date: October 01, 2016

• KR00011 emplID, Pay action and Merit reason, effective date: December 01, 2016, event used:S-2206, change date: December 01, 2016

From the Payee Parameters page:

• KR00011 emplID, begin date: September 01, 2016, event used: S-2206

• KR00011 emplID, begin date: November 01, 2016, event used: S-2206

• KR00011 emplID, begin date: January 01, 2017, event used: S-2206

If the effective date of a row is updated, and:

• Its (old) effective date is equal to or greater than (= or >) the eSocial on PeopleSoft date (forexample, September 1, 2016), and

• Its (old) effective date is greater than (>) the last hire date, and

• The data row is the only one in its month and year period.

The system generates an S-3000 - Event Exclusion event for the event with <dtAlteracao> that isequal to old effective date of the updated row. In this example, the exclusion event is generated forthe S-2206 event with the effective date of October 1, 2016. A new event (S-2206) is generatedfor the new effective-dated row of November 1, 2016. In addition, rectifications are sent forevents with <dtAlteracao> that are later than the exclusion event. In this example, these eventsinclude the two S-2206 events with November 01, 2016 and December 01, 2016 effective datesfrom the Job Data component, and the two S-2206 events with November 1, 2016 and January 01,2017 effective dates from the Payee Parameter page.

Copyright © 1988, 2022, Oracle and/or its affiliates. 519

Global Payroll for Brazil Reports Chapter 28

• If multiple contract data actions are performed on the same day, and these changes trigger the sameevent, only one instance of this event is generated. For example, if you update a work shift code,change an employee’s risk level on the Payee Parameters page, and update a job code on the same day(October 1, 2016), and all of these changes need to be submitted to eSocial through the S-2206 event,the PeopleSoft system generates one S-2206 event with <dtAlteracao> set as October 1, 2016.

Employment Contract Changes Rules for Retroactive Payments

Sometimes, employees receive retroactive payments due to changes in contracts with their unions.These changes can be the result of collective agreements, collective disputes, collective conventions orlegislative updates. The employer is responsible for reporting information of these salary increases to theGovernment, which then uses the data to calculate retroactive payroll using the S-1200 event accordingly.

Here is a list of rules that apply to the Employment Contract Changes event when reporting union-specificretroactive payments for employees (these rules are not applicable to non-employees):

• For S-2206 events to be generated for employees who receive retroactive payments due to unioncontract changes, they must be associated with unions on the "Job Labor Page" (PeopleSoft HumanResources Administer Workforce) (the Union Code field).

For unions with contractual changes, be sure to fill out the Union Contract Revision section ofGeneral Parameters Page. The system uses information provided here to determine the begin and enddates of the retroactive payroll, among other things.

In addition, you also need to select the Collective Agreement Indicator option for a Data Changeaction and reason combination on the Other Action/Reason Page. The system uses this action andreason code for union-specific retroactive payroll processing. Oracle recommends that the same DataChange action for Sefip 650 be used for this purpose.

• When an employee job data row is added with the action and reason combination that is usedfor collective agreement, a positive compensation change percent on the "CompensationPage" (PeopleSoft Human Resources Administer Workforce), and an effective date that falls withinthe begin and end dates of the contract revision specified for the associated union of the employee,the system generates an S-2206 event with that effective date (also referred to as the effect date in thissection).

Note: If the action and reason of the added row is not used for collective agreement, an S-2206 eventis generated without the effect date.

If the employee was hired before the begin date of the contract revision, the effective date of the jobdata row should be set as the same as the begin date.

If the employee was hired after the begin date of the contract revision, the effective date of the jobdata row should be set as the same as the hire date, and the effective sequence to 1.

If other effective-dated job data rows exist after the begin date, the effective sequence of these rowsmust be adjusted in order for the retroactive payroll calculation to be done properly.

The S-2206 event captures information such as the effect date ({dtEf} tag), alteration date({dtAlteracao} tag, the system date of the action and reason setup that is specified for collectiveagreement), contractual change description from the union revision setup ({dscAlt} tag), and newsalary amount ({vrSalFx} tag).

520 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 28 Global Payroll for Brazil Reports

• Note that retroactive salary payments are reported in S-2206 events with corresponding effect dates({dtEf} tag). For other updates of employees (for example, job code changes, shift changes and so on)that also use the S-2206 event layout to report to the Government but are unrelated to union-specificretroactive salary change, the system captures the updated value from the job data row that has themaximum effective date for the month when the change took place, and reports it without an effectdate ({dtEf} tag).

• If the system is supposed to generate an S-2206 event for a newly added employee job data row butthe required union information is missing, mapping errors are returned so that the administrator cantake appropriate actions.

• For any salary update in job data rows that took place during the specified union revision period, noS-2206 events are generated if the compensation change percent value is equal to or less than zero.This scenario applies when the S-2206 event that was generated for the newly added salary changerow is pending, and subsequent effective-dated rows are updated with the new salary amount as wellbut the change percent remains zero.

• The Government can accept more than one S-2206 event with the same alteration date, as long as theeffect dates are different.

Related LinkseSocial Non Periodic Event Page

S-2210 - Accident at Work Communication (CAT)Non periodic event. This event layout reports workplace accidents involving employees, even if they wereaway from their work activities when accidents happened. An Accident at Work Communication event istriggered when work incident or injury is reported using the Injury Details BRA or Incident Details BRAcomponent.

Work accidents need to be sent to eSocial by the next business day after the occurrence of accidents, andimmediately in case of death.

General Rules

Here are several general rules that apply to the Worker Health Monitoring – ASO event:

• To activate S-2210 event reporting for companies:

• The eSocial functionality has to be enabled on the eSocial Parameters BRA Page.

• Companies must be enabled and configured using the Company Parameters component.

• The S-2210 event must be activated on the Events Activation Page and listed on the Non PeriodicEvents Page, and not to be inactivated in companies’ parameter setup.

• An Accident at Work Communication (CAT) event is triggered when a work incident or injury isreported using the Injury Details BRA or Incident Details BRA component with the Accident incidenttype, and the incident date entered is equal to or greater than the Health/Safety Go Live date. NoS-2210 event is generated if either condition is not met.

Copyright © 1988, 2022, Oracle and/or its affiliates. 521

Global Payroll for Brazil Reports Chapter 28

Scenarios

Here are several examples that describe the behaviors of the Accident at Work Communication event:

• For each Accident incident row, do not enter more than one row for the Death Communication orInitial CAT type in the CAT Information section. Multiple rows are supported for the Reopened CATtype.

• If the injured employee works for multiple companies, the system submits an S-2210 event to eachone of them.

• When the system creates an S-2210 event for an incident with the Reopened or Death CommunicationCAT type, it takes the receipt number from the latest S-2210 event that was submitted for the sameincident with the Initial CAT type, and populates the value in the nrRecCatOrig tag of the new event.

For example, an S-2210 event was created and submitted to the Government two months ago for anincident with the Initial CAT type. A month later, the system submitted a rectification for the sameevent to the Government. Now, as the system creates an S-2210 event for the same incident row withthe Reopened (or Death Communication) CAT type row, it takes the receipt number that it receivedfor the rectification from the Government, and populates it in the nrRecCatOrig tag of the new event.

• If a work accident results in an absence of the injured employee, an S-2230 - Temporary Absenceevent needs to be submitted as well. Customers need to report absence for the employee on theAbsence Event BRA page so that the temporary absence event can be created accordingly.

• If changes are made to work accidents that were reported using the Injury Details BRA or IncidentDetails BRA component, the system sends rectifications for corresponding S-2210 events. Thesame is true for sending exclusion events for S-2210 events, if work accidents were excluded fromassociated components.

• If an S-2210 event happens to be rectified or excluded, any S-2230 event created as a result of it needsto be rectified or excluded as well. This is not done automatically and customers need to make thechange in absence on the Absence Event BRA page.

Related LinkseSocial Non Periodic Event Page"Incident Details BRA - CAT Information Page" (PeopleSoft Human Resources Monitor Health andSafety)

S-2220 - Worker Health Monitoring – ASONon periodic event. This event layout records and tracks the health of workers through occupationalhealth certificates (ASOs). An ASO (Atestado de Saúde Ocupacional) is a certificate that a doctor issuesafter completing a medical examination on a worker. It includes information about the tests that areperformed during the exam and their findings, as well as the clinical evaluation made by the doctor. Thiscertificate is part of an occupational health examination program, PCMSO (Programa de Controle Médicode Saúde Ocupacional), and it helps to determine if the worker is fit for the specific function that he or sheis hired to perform. Companies may request workers to take medical examinations when they are hired,need to take examinations periodically as requested by PCMSO, change jobs, return to work, are subjectto specific monitoring, and are terminated.

522 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 28 Global Payroll for Brazil Reports

Note: The S-2200 Employees Initial Loading and Hiring or S-2300 Workers who have no relationship -Begin event must be transmitted prior to sending this event.

General Rules

Here are several general rules that apply to the Worker Health Monitoring – ASO event:

• To activate S-2220 event reporting for companies:

• The eSocial functionality has to be enabled on the eSocial Parameters BRA Page.

• Companies must be enabled and configured using the Company Parameters component.

• The S-2220 event must be activated on the Events Activation Page and listed on the Non PeriodicEvents Page, and not to be inactivated in companies’ parameter setup.

• To support S-2220 event reporting, the system changes the display of person ID to employeeID in each ASO exam result on the "ASO Exam Results BRA Page" (PeopleSoft HumanResources Monitor Health and Safety) and prepopulates the employee record number with the valuefrom the employee’s job data. If the person ID does not have a corresponding entry in the Job Datacomponent (for example, an individual took the exam before hired by the company formally), thesystem populates the default value of 0 in the Empl Record field. When the job data is created laterfor the individual after the hire is completed, and the corresponding employee record number is not0, it is the company’s responsibility to make the correction on the ASO Exam Results BRA pageaccordingly

Prior to implementing the S-2220 event, run a one-time process on the ASO Exam Procedure Pageto update employee record numbers in exam results as needed, so that the exam information can beprocessed properly.

• A Worker Health Monitoring – ASO event is triggered when the ASO medical exam result of aworker is reported in the ASO Exam Results BRA component, the ASO date entered is equal toor greater than the Health/Safety Go Live date (for example, January 1, 2019), and that the workerbelongs to an employee classification that is specified on the Labor Regime page.

Scenarios

Here are several examples that describe the behaviors of the S-2220 event when ASO exam results areentered, updated, or deleted from the PeopleSoft system after the Health/Safety Go Live date:

• When an ASO exam result is added to the "ASO Exam Results BRA Page" (PeopleSoft HumanResources Monitor Health and Safety) for a worker, the system creates an S-2220 event usinginformation from the exam result. In addition, it also captures information from the worker’s job datafor the event, for instance:

• If the exam type is Hire, the system takes the information needed from the job data row with aHire action that is configured for eSocial on the Hire Action/Reason Page.

• If the exam type is Job/Position Change, Periodical, Return to Work or Specific Monitoring, thesystem takes the information needed from the latest job data row of the worker.

Copyright © 1988, 2022, Oracle and/or its affiliates. 523

Global Payroll for Brazil Reports Chapter 28

• If the exam type is Termination, the system takes the information needed from the latest job datarow with a Termination action that is configured for eSocial on the Termination Action/ReasonPage.

• When a retroactive ASO exam result (for example, a periodic exam) is added for a worker and itsASO date is not the latest of all the rows, the system generates an S-2220 event with information fromthis exam result and the latest job data row of the worker.

• If data (for example, ASO date, exam type, order of exam and so on) is changed in the latest ASOexam result that is sent to the Government, the system rectifies the S-2220 event for the latest ASOexam with the updated information.

• If a worker changes the employee category in a new job data row, and an ASO exam is performed andits result added as a result of the job function change (as required by the new job function), the systemgenerates an S-2220 event with information from this exam result and the latest job data row of theworker.

Similarly, if a worker changes the employee category in a new job data row, and this time, some data(for example, the ASO date and result indicator) in the existing Hire exam result is updated. In thiscase, the system rectifies the S-2220 event for the hire ASO exam result with the updated data as wellas information from the Hire job data row.

• If a worker transfers to a new company, two job data rows are added for the worker: one forterminating the worker from the old company and the other for hiring the worker to the new companyin the transfer. An ASO exam is performed as a result of the job function change (as required by thenew job function). In this scenario, the system creates an S-2220 event with information from thisexam result and the latest job data row of the worker.

If data is updated in the ASO exam result for the job function change, the system rectifies the S-2220event for the job change exam result with the updated data, and the information from the latest jobdata row of the worker.

Now if the ASO exam result row for the job function change is deleted, the system generates anS-3000 event for the information to be removed from the Government as well.

• A worker can have more than one employment within a company or in different companies. Whenthe first job data row is added (employee record = 0) and an ASO exam result for this hiring is addedto the ASO Exam Results BRA page, the system creates an S-2220 event with information from thisexam result and the Hire job data row for employee record 0. Later, when the second job data row isadded (employee record = 1) and another ASO exam result row for this hiring is inserted, the systemcreates an S-2220 event for the second employment with information from this new exam result andthe Hire job data row for employee record 1.

If a periodic ASO exam result is added for both employee records, the system creates an S-2220 eventfor each employee record, using the exam result and information from the latest job data row for thecorresponding employee record.

• If the ASO date of an ASO exam result row is updated to a date that is earlier than the Health/SafetyGo Live date, or if an ASO exam result row is deleted (whether or not it is the latest row for theworker), the system creates an S-3000 event to remove the ASO exam result from the Government.

524 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 28 Global Payroll for Brazil Reports

Related LinkseSocial Non Periodic Event Page

S-2221 - Toxicological Exam for Professional Drivers

Important! This eSocial report is no longer required and therefore has been inactivated in the S-1.0version.

Non periodic event. This event layout records information of toxicological examinations (drug tests)taken by workers who are employed as professional drivers. Prior to hiring or terminating professionaldrivers, employers are required by law to report information about the toxicological examinations thatdrivers took, such as the exam number, the exam date, the physician who conducted the exam, and thelaboratory where the exam took place.

General Rules

Here are several general rules that apply to the Toxicological Exam for Professional Drivers event:

• To activate S-2221 event reporting for companies:

• The eSocial functionality has to be enabled on the eSocial Parameters BRA Page.

• Companies must be enabled and configured using the Company Parameters component.

• The S-2221 event must be activated on the Events Activation Page and listed on the Non PeriodicEvents Page, and not to be inactivated in companies’ parameter setup.

• A Toxicological Exam for Professional Drivers event is triggered when the drug test of a worker isreported on the "Drug Test BRA Page" (PeopleSoft Human Resources Monitor Health and Safety),the exam date (or expected termination date) entered is equal to or greater than the Health/Safety GoLive date, and that the worker belongs to an employee classification that is specified on the LaborRegime page.

Scenarios

Here are several examples that describe the behaviors of the S-2221 event when drug tests are entered,updated, or deleted from the PeopleSoft system after the Health/Safety Go Live date:

• When a drug test is added on the "Drug Test BRA Page" (PeopleSoft Human Resources MonitorHealth and Safety) before hiring or terminating a worker, the system generates an S-2221 event withinformation from the drug test itself, and the job data of the worker. If the worker is associated withmultiple job data rows, the system takes the data it needs from the row with an effective date thatis either equal to, or (immediate) greater than the exam date. If all job data rows happen to have anearlier effective date than the exam date, the row with the greatest effective date will be used.

• If the occupation code that is specified in the worker’s job data row on the "Job InformationPage" (PeopleSoft Human Resources Administer Workforce) does not require exam to be taken,a mapping error will be generated and the system cannot create an S-2221 event until the error isresolved.

• Drug tests are valid for a period of time and can be reused if time permits. Suppose that a drug testis added for a worker in preparation for hiring, and an S-2221 event is submitted to the Government.

Copyright © 1988, 2022, Oracle and/or its affiliates. 525

Global Payroll for Brazil Reports Chapter 28

The employment is terminated a month later. If the employer confirms that the drug test (used forhiring) is still valid, the same drug test information can be added to the system for the terminatedworker under the Termination exam type. The system rectifies the S-2221 event (created for hiring)with termination information and sends it to the Government.

• If the worker refuses to perform a drug test before termination, the system uses the expectedtermination date that is specified on the Drug Test BRA page to be the exam date for the S-2221event.

• If data (for example, the exam date) is changed in a worker’s drug test after it’s submitted to theGovernment, the system rectifies the S-2221 event with the updated information. In the case wherethe exam date is changed to a date that is earlier than the Health/Safety Go Live date, the systemcreates an S-3000 event to remove the drug test from the Government as the information is no longerrelevant.

• A worker can have more than one employment within a company or in different companies. When thefirst job data row (employee record = 0) and a drug test for this hiring are added to the HCM system,it creates an S-2221 event with information from the drug test and corresponding job data row foremployee record 0. Later, when the second job data row (employee record = 1) and another drugtest for this hiring are inserted, the system creates an S-2221 event for the second employment withinformation from this other drug test and corresponding job data row for employee record 1.

• If a drug test (which was previously submitted to the Government) is deleted from the Drug Test BRApage, the system creates an S-3000 event to remove the drug test information from the Government.If the deleted drug test has never been submitted to the Government (for example, the exam date isearlier than the Health/Safety Go Live date), no event will be generated.

• Any change to drug test-related information outside of the Drug Test BRA page, such as change ofoccupation code in job data, does not trigger the creation, rectification, or exclusion of S-2221 events.

S-2230 - Temporary AbsenceNon periodic event. Use this event layout to communicate the temporary absence (such as maternityleave, sickness, accident at work and vacations as set by the government) or removal of employees, aswell as their amendments and extensions.

General Rules

Here are several rules that apply to the Temporary Absence event:

• For absences that are caused by accidents at work and last shorter than 16 days, or absences thatare not caused by accidents at work and last between three to 15 days, they need to be reported bythe seventh day of the month following the absences or before the submission of payroll events,whichever happens first. Generally, other absence types follow the same rule—report either by theseventh day of the month following the absences, or before payroll events (or termination events ifapplicable).

Employers may submit absence reporting to the government as soon as the day after the absencebegins or when the employee has returned from absence, except for vacation.

• For absences that are caused by accidents at work or grievances and last longer than 16 days, theyneed to be reported by the 16th day of the absence.

526 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 28 Global Payroll for Brazil Reports

• If an employee is absent multiple times for the same incident (accident at work, grievance, orsickness), and the total sum of absence days is more than 15 days within a period of 60 days, theemployer must report to eSocial by the 16th day of the absence.

• For vacation absences, they can be reported eSocial 60 days prior to the vacation start and end dates.

• If an employee on temporary absence has more than one job, an S-2230 event is submitted for each ofthe employee’s EMPL_RCD.

• Setup on the Absence Legal Codes Page and Absence Take and Reason Page is required fortemporary absences to be submitted for eSocial reporting.

• Temporary absences events are sent in chronological order by absence begin date. As for S-3000 -Event Exclusion events for temporary absence, they are sent in descending order by absence end dateand absence begin date.

• Temporary absence events are set to Action Required in the error handling system if the begin or enddate of absences fall within the monthly close period. The same is true for exclusion events that arecreated for these temporary absence events.

• If the receipt number for the original event of a rectification or exclusion event is missing, the event isplaced hold on and reprocessed until the receipt number is identified.

Related LinkseSocial Non Periodic Event Page

S-2240 - Environmental Working ConditionsNon periodic event. This event layout records information about the working environments andconditions of workers. It captures workers’ workplace locations, the types of activities they performthat are considered unhealthy and dangerous, the risks and hazards that they are exposed to at work, aswell as the usage of protection equipment and its effectiveness in keeping workers safe. The informationcollected in this event is also used for special retirement financing.

General Rules

Here are several general rules that apply to the Environmental Working Conditions event:

• For S-2240 events to be generated and submitted properly for companies:

• The eSocial functionality has to be enabled on the eSocial Parameters BRA Page.

• Companies must be enabled and configured using the Company Parameters component.

• The S-2240 event must be activated on the Events Activation Page and listed on the Non PeriodicEvents Page, and not to be inactivated in companies’ parameter setup.

• The S-2200 and S-2300 events must be processed and submitted to the Government already.

• An Environmental Working Conditions event is triggered whenever a working environment, activity,or condition of a worker is reported in the Worker’s Conditions BRA component, the effective dateentered is equal to or greater than the Health/Safety Go Live date (for example, January 1, 2019), andthat the worker belongs to an employee classification that is specified on the Labor Regime page.

Copyright © 1988, 2022, Oracle and/or its affiliates. 527

Global Payroll for Brazil Reports Chapter 28

Note: For initial loading, the process takes the working conditions record of each eligible worker withan effective date that is either the same as the go-live date, or is the most current as of the go-live date,and generates S-2240 events.

Initial Loading

The S-2240 event is a non periodic event that is also included in the initial load process for employee data(GPBR_ES_ILE). When the initial load process runs for the S-2240 event and a company, the systemgenerates an S-2240 event for the worker’s conditions record of each eligible worker that is associatedwith that company. If a worker has multiple worker’s conditions records, the process takes the one withthe same effective date as the company’s Health/Safety Go Live date if available, or the one with the mostcurrent (maximum) effective date as of the go-live date, to be used for initial loading.

Note: The initial load process does not generate events for future-dated worker’s conditions. If a worker’sconditions record has a future-dated row at the time of initial load, the system creates a driver record forit, which will then be handled by the non periodic process (GPBR_ES_MNP) later.After the initial loading of worker’s conditions is completed, the eSocial system reports any new, deleted,or changes to worker’s conditions to the Government using the S-2240 event.

Online Transactions After Initial Loading

Here are several examples that describe the behaviors of the S-2240 event when worker’s conditions arecreated, updated, or deleted from the PeopleSoft system after initial loading process is completed:

• When a worker is hired, rehired, transferred to a company, or has a different worker condition (forexample, a new workplace, a new work activity, a new work hazard, a new protection equipment andso on), Oracle recommends that you add a worker’s conditions record (or an effective-dated row) tothe "Worker Conditions Page" (PeopleSoft Human Resources Monitor Health and Safety) to capturethe information for the worker as soon as possible. When that happens, the system creates an S-2240event using information from both the worker’s conditions record, and the worker’s current job datarow. For instance, you add a worker’s condition record for a worker who just got hired. When thesystem creates an S-2240 event, it uses data from the worker’s condition record and the hire job datarow, which is current as of the effective date of the worker’s condition record.

• When a worker’s conditions record is added for an employee who works at a service taker location,the system generates an S-2240 event for it using information from the worker’s conditions record,current job data, and current payee parameters (where the employee is associated with one or moreservice takers). The system generates a mapping error and cannot create an S-2240 event if:

• The employee does not associate with a service taker on the Payee Parameters Page.

• The employee is associated with a service taker on the Payee Parameters BRA page, but there isno Service Taker Establishment workplace code specified on the Worker Conditions page for theemployee.

• The employee is associated with a service taker on the Payee Parameters BRA page, and a ServiceTaker Establishment workplace code is specified on the Worker Conditions page for the employee,but the service taker is not listed on the "Workplace Table BRA Page" (PeopleSoft HumanResources Monitor Health and Safety).

528 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 28 Global Payroll for Brazil Reports

• When a worker’s conditions record is added with an retroactive effective date (for example, August1, 2019 and the current effective date is September 1, 2019) for a row that is added on the PayeeParameters page for the same retroactive effective date, the system generates an S-2240 event usinginformation from this worker’s conditions record, and the worker’s job data row and payee parametersrow (for example, service taker) that are current as of the retroactive effective date.

• If, after initial loading, a worker’s conditions record is added, and:

• The record has a retroactive effective date (for example, June 1, 2019) that is earlier than theeffective date of the record used in initial loading (for example, June 20, 2019) and the go-livedate, no event will be created.

• The record has a retroactive effective date (for example, June 30, 2019) that is later than theeffective date of the record used in initial loading (for example, June 20, 2019) but earlier than thego-live date, the system rectifies the S-2240 event for the initial loading with information from theworker’s conditions record that has the retroactive date.

• If a worker’s conditions record is added after the worker is terminated (the record’s effective date isgreater than the worker’s termination date), no event will be generated.

• Suppose that a worker’s conditions record is created after a worker is transferred to a differentestablishment of the company and an S-2240 event is submitted to the Government to report thechange.

• If updates are made to the worker’s conditions record (the one added for the transfer, with aneffective date of August 1, 2019 for example), the system rectifies the S-2240 event for themodified worker’s conditions record with the updated data, and the information from the worker’scurrent job data row as of the August 1, 2019 effective date.

• If updates are made to the worker’s conditions record (the one before the transfer, with aneffective date of January 1, 2019 for example), the system rectifies the S-2240 event for themodified worker’s conditions record with the updated data, and the information from the worker’scurrent job data row as of the January 1, 2019 effective date.

• A worker can have more than one employment within a company or in different companies. When thefirst job data row (employee record = 0) and a worker’s conditions record are added for the worker,the system creates an S-2240 event with information from this worker’s conditions record and theHire job data row for employee record 0. Later, when the second job data row (employee record =1) and another worker’s conditions record are inserted, the system creates an S-2240 event for thesecond employment with information from this worker’s conditions record and the Hire job data rowfor employee record 1.

• If a worker’s conditions record (previously submitted to the Government) is deleted, the systemcreates an S-3000 event to remove it from the Government’s system.

• If a worker’s conditions record (the one used in initial loading) is deleted, the system rectifies theS-2240 event for the initial loading with information from the worker’s current worker’s conditionsrecord as of the go-live date.

Copyright © 1988, 2022, Oracle and/or its affiliates. 529

Global Payroll for Brazil Reports Chapter 28

S-2250 - Termination Previous Notification

Important! This eSocial report is no longer required and therefore has been inactivated in the S-1.0version.

Non periodic event. This event layout records the creation or cancellation of previous notificationsbetween contracting parties (employer and employee). A previous notification is a document (anticipatedand mandatory) in which an employer or employee indicates the wish to terminate the currentemployment contract without cause.

Previous notifications, or cancellations of previous notifications, are specified on the TerminationParameters Page.

General Rules

Here are several rules that apply to the Termination Previous Notification event:

• When you enter a notification date and option of a prior notification (also referred to as previousnotification) for the first time on the Termination Parameters page for an employee, the system createsan S-2250 event using the notification date and submits the information to the Government. The samerule applies when you add a new row with a new begin date, and enter prior notification data in thatrow for the first time.

However, if there are multiple rows for an employee in the system, and you enter prior notificationdata for the first time in a row that does not have the most current begin date, no event is created.Suppose that you decide to delete the current row later, which makes the row with prior notificationdata the one that has the most current begin date in the system. In this case, the system creates anS-2250 event for the notification date of this current row.

• Once prior notification data of an employee is submitted to the Government, any change to it triggersthe rectification of the corresponding S-2250 event. For example:

• You update the prior notification data in the only data row that exists for an employee.

• You add a row with a new begin date and enter the same prior notification data as the previousrow.

• You add a row with a new begin date and enter a different notification date.

In this scenario, the system checks if an S-2298 - Employee Reinstatement event was created forthe employee after the notification date of the previous row.

If yes, it means that the employee received a prior notification and was terminated before thereinstatement. In this case, the system needs to create a new S-2250 event for the new notificationdate and submits the information to the Government.

If no, the corresponding S-2250 is rectified.

• Two data rows are available for the employee. Both rows contain prior notification data and theinformation of the most current begin date is submitted to the Government. If you delete thecurrent row, the system rectifies the corresponding S-2250 using the notification date of the onlyrow that is left in the system.

530 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 28 Global Payroll for Brazil Reports

However, if the prior notification data update is made in a row that does not have the most currentbegin date, no event rectification occurs.

• When you delete prior notification data that is already reported to the Government, the system createsan S-3000 - Event Exclusion event to remove the information from the Government side as well. Forexample:

• You delete the prior notification data from the only data row that exists for an employee.

• You delete the row that has the most current begin date and contains the notification data that issubmitted to the Government. The row with the most current begin date left for the employee doesnot have any prior notification data.

• You add a row with a new begin date and clear all prior notification data from this new row.

However, if the prior notification data is deleted in a row that does not have the most current begindate, no S-3000 event is created.

• When you enter a date and reason to cancel a prior notification that is already submitted to theGovernment, the system creates an S-2250 event using the cancelation date that is specified. After theS-2250 event for the cancelation is submitted successfully, do not delete or change that cancelationdata from the row (or delete that whole row) because it will generate exclusion or rectification events.The Government does not accept the exclusion or rectification of events that have already beencanceled.

Related LinkseSocial Non Periodic Event Page

S-2298 - Employee ReinstatementNon periodic event. This event layout provides information about reinstatements of employees (who werepreviously fired by their companies) by judicial decision. It is triggered when an employee is rehiredwith the Reinstate reason, and that employee has an employment relationship that is set up for eSocialreporting.

Employee reinstatements need to be reported by the seventh day of the month following the occurrence ofthe events.

General Rules

Here are several rules that apply to the Employee Reinstatement event:

• It applies to employees with employment relationships (employees are associated with employeeclassifications that are specified on the Labor Regime Page, with a specific work type.

• It applies to terminated employees only.

If an employee was terminated before eSocial becomes effective, and the employee was not includedin the S-2200 - Employees Initial Load and Hiring event that was submitted to eSocial, the S-2200event has to be submitted again, where that the <desligamento> section is filled with the terminationdate of the employee, and be accepted by eSocial prior to sending the S-2298 event.

Copyright © 1988, 2022, Oracle and/or its affiliates. 531

Global Payroll for Brazil Reports Chapter 28

If an employee was terminated after eSocial becomes effective, the S-2299 - Termination event has tobe submitted for the employee before S-2298 event can be sent to reinstate the employee.

• It captures information about employees to fill the <infoReintegr> section of the event layout in theAdditional Information BRA component.

See "(BRA) Providing Additional Information for Brazilian Employees" (PeopleSoft HumanResources Administer Workforce)

• Employees are not specific to or keyed by company, and can work for more than one company at atime. Therefore, any personal data change (personal data table are keyed by EMPLID) of an employeeneeds to be submitted to eSocial for all companies with which the employee has employmentrelationships.

Job data is keyed by EMPLID and EMPL_RCD. With that, changes in job data need to be submittedto eSocial for the company associated with the employment record. If the employee has multipleemployment relationships, the same number of S-2298 events need to be generated. In those events,the personal data section remains the same, the job data section, however, contains data that is distinctfor each relationship.

• If the only component or table that was updated for an employee is not effective-dated, and themaximum effective date for all components and records that are used to generate the S-2298 event isearlier than or equal to (< or =) the employee’s hire date, a rectification event needs to be generatedfor the S-2298 event.

Related LinksHire Action/Reason PageeSocial Non Periodic Event Page

S-2299 - TerminationTermination event. This event layout records the termination of employees. Terminations, as well astransfers between companies, need to be reported to eSocial before payroll events. If a termination isplanned (for example, tendering of a work notice, or end of a fixed term contract), it needs to be reportedto the government by the next business day following the termination. If the termination is not planned,notify the government no later than ten business days following the termination, or before the submissionof an S-1200 event for the terminated individual, whichever comes first.

There are two types of termination events, one for employees (S-2299) and one for non-employees(workers who have no employment relationship with companies they work for) (S-2399). Setup on theLabor Regime BRA page, Termination Legal Code page and Termination Action/Reason page determinesif a termination action and reason performed for an employee in the Job Data component needs toreported to eSocial, whether payment calculation is required in the termination process, and with whichevent to send the information.

General Rules (Termination With or Without Payment Calculation)

Here are several rules that apply to the Termination event (with or without payment calculation):

• When a new effective date is entered in the Job Data component for a termination action and reasonof a worker, the system identifies the type of employment relationship (employee or non-employee)

532 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 28 Global Payroll for Brazil Reports

that the worker has with the company. To do that, it takes the employee class from the job and looksup the work type for that employee class on the Labor Regime BRA page. If the employee class fromthe job is not set up on the Labor Regime BRA page, no driver data or trigger for the termination willbe created. If the employe class setup is available, and the selected work type is CLT, the worker is anemployee; if a different work type is specified, the worker is a non-employee.

Next, the system checks if the specified action and reason on the job is associated with a terminationlegal code (which indicates whether or not payment calculation is required) and an eSocial event onthe Termination Action/Reason page.

When the information is available, the system adds new driver data for this termination using theappropriate eSocial event (S-2299 or S-2399), if the data hasn’t been inserted already.

• Termination events are processed on the eSocial Termination Events Page. When the terminationevent AE process is triggered on the run control page, it performs checks to make sure that theselected companies are active for eSocial reporting, the specified competency period is equal to orcomes after the Adhere to eSocial date (month and year) and is not closed for periodic events, and theselected events are active. If any of these checks fails, the process stops and information is logged.

Both S-2299 and S-2399 events are selected by default on the run control page and cannot bedeselected.

The Prepare Data option is the first processing option for S-2299 and S-2399 events. In this step,driver data that matches the selection criteria is loaded to staging tables, getting ready for XML filesto be generated.

• Information that is saved in different pages regarding an employee’s termination is used for thegeneration of one Termination event only. For example, in addition to the Job Information page, theTermination section of the Termination Parameters Page is also used to capture text information orcomments about terminations. If the begin date of the information on the Termination Parameterspage is earlier than or equal to (< or =) the effective date of the termination action on the JobInformation page for an employee, information from both pages is used to generate a Terminationevent for the employee.

• When a change is made to a termination row in the Job Data component for an employee, the systemchecks if an existing event for the same event code, employee (CPF number) and competency periodis available. If yes, instead of generating a new event, the existing event is rectified if the event isalready submitted to the government.

In order to rectify a submitted event, the event’s receipt number must be present. The rectificationevent needs to be put on hold if the receipt number is not available.

If an existing event is available but it’s not yet submitted to the government, the system updates thedriver data for the changed row.

• If a change in termination reason is made in the Job Data component for an employee, the systemcompares the old action and reason with the new values and see if they reference the same eSocialevent. If they refer to the same eSocial event and the event doesn’t require calculation, the existingTermination event is rectified. However, if the new values reference an eSocial event that requirescalculation, submit an S-3000 - Event Exclusion event to the existing event.

• If a row for the termination action is deleted from the Job Data component for an employee, submitan S-3000 event to the existing termination event if it is already submitted to the government. If theevent is not yet submitted to the government, the system removes the driver data for the deleted row.

Copyright © 1988, 2022, Oracle and/or its affiliates. 533

Global Payroll for Brazil Reports Chapter 28

• If a termination is triggered after a period is closed, and the corresponding termination event setupdoes not allow submission after closed period, no Termination event is created. An error message islogged so that appropriate actions can be taken.

For terminations that require payment to be calculated based on associated wage types tables andsubmitted to the government through termination events, additional setup is needed so that appropriateinformation can be gathered for the calculation:

• For termination types that require payment calculation, set the corresponding termination legal codesto require calculation on the Termination Legal Code page.

• Specify earnings and deduction elements to be used for termination payment calculation on the WageTypes Table page of the Wage Types Table component.

• Specify run types with the Termination or Term Non Empl payment type for termination processingon the Run Types page of the Wage Types Table component. This information is used to identifycalendars to be used in termination payment calculation.

• Specify alimony elements and health data elements to be used in termination payment calculation.

Alimony elements are specified on the Wage Types Table page, with an alimony-related income taxtype value: 51, 52, 53, 54, or 55.

Health data elements are specified on the Health Data page.

Alimony and health data amounts are reported in termination events the same way the terminationresults are recorded on the Earnings and Deductions page—alimony in total amount and health dataamount broken down by element.

• Associate wage types tables with companies on the Company Details BRA page.

Logs will be created to capture issues found in the setup for termination processing.

General Rules (Termination With Payment Calculation)

Here are several rules that apply to the Termination event (with payment calculation):

• To process termination events that require payment calculation, the AE process needs to identifyapplicable calendars to be used in the calculation. A calendar is selected if it meets all theserequirements:

• It is finalized.

• It pertains to a company and competency period that is specified in the Selection Criteria sectionof the eSocial Termination Events page.

The period of the calendar is the same as the competency period that is specified as selectioncriteria.

• It pertains to a run type that is specified on the Run Types page with the payment type set to eitherTermination or Term Non EMPL (termination for non employees), and that run type is linked toone of the selected companies through wage types tables on the Company Details BRA page.

Identified calendars are listed on the eSocial Processed Calendars - eSocial Termination Events Pageafter the AE process is run.

534 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 28 Global Payroll for Brazil Reports

• To process retroactive adjustments for employees, information must also be provided in the UnionContract Revision section of the General Parameters Page for the retroactive calculation to happen.

• Global Payroll for Brazil supports the S-2299 (or S-2399) event reporting of employees who havemultiple employment relationships with different companies (companies that may or may not useGlobal Payroll for Brazil for termination event reporting).

• The mass termination simulation functionality is an offcycle payroll process that provides payrollpersonnel an estimate of the costs (termination pay) incurred in case of a workforce reduction. Ifthe offcycle calendars created for a simulation are applied to payroll, the AE process takes theminto consideration when it is in the process of identifying applicable calendars to be used in thetermination payment calculation. If these offcycle calendars are not applied to payroll, they will be notbe considered for the termination event processing.

For employees that are identified, driver data is added so that termination events can be created forthem when the AE process runs. If an S-1200 event has already been created for the same periodwhen the mass termination occurred, exclude the S-1200 event (if it is submitted to the government),or delete the event’s driver data (if the event has not been sent to the government).

• Wage parcel and nature of indemnity payments pertaining to terminations of employees are to bereported using the S-1210 event.

Related LinksLabor Regime PageTermination Legal Codes PageTermination Action/Reason PageWage Types Table PageRun Types PageHealth Data PageeSocial Termination Events Page

S-2300 - Workers who have no employment relationship - BeginNon periodic event. This event layout provides employment information for workers who have noemployment relationships with companies. Examples include temporary workers, union leaders, non-employee directors, members, and so on. It is used in the initial data loading of employees withoutemployment relationships, and for new hires without employment relationships after of the eSocialimplementation.

General Rules

Here are several rules that apply to the Workers who have no employment relationship - Begin event:

• It applies to employees without employment relationships (employees are associated with employeeclassifications that are specified on the Labor Regime Page, without a specified work type. It istriggered when the Hire action is selected in the first row of job data for an employee withoutemployment relationship.

• It reports the employee data row with the most current effective date that is either earlier than or equalto (< or =) the eSocial on PeopleSoft date.

Copyright © 1988, 2022, Oracle and/or its affiliates. 535

Global Payroll for Brazil Reports Chapter 28

• For an employee to be included in the report, the employee’s hire date needs to be equal to or laterthan (= or >) the Company creation date, as well as equal to or earlier than (= or <) the eSocialimplementation date.

Information of employees who are hired after the eSocial implementation date needs to be submittedusing either the S-2200 or S-2300 event.

• The eSocial Reg. Number field value on the "(BRA) Additional Information BRA Page" (PeopleSoftHuman Resources Administer Workforce) is required for employees with employment relationships.

Employees are not specific to or keyed by company, and can work for more than one company at atime. Therefore, any personal data change (personal data table are keyed by EMPLID) of an employeeneeds to be submitted to eSocial for all companies with which the employee has employmentrelationships.

Job data is keyed by EMPLID and EMPL_RCD. With that, changes in job data need to be submittedto eSocial for the company associated with the employment record. If the employee has multipleemployment relationships, the same number of S-2200 events need to be generated. In those events,the personal data section remains the same, the job data section, however, contains data that is distinctfor each relationship.

• If the only component or table that was updated for an employee is not effective-dated, and themaximum effective date for all components and records used to generate the event is earlier than orequal to (< or =) the eSocial implementation date, a rectification event needs to be generated for theS-2300 event.

• An update in the CPF national ID, PIS, or birth date of an employee is considered a critical change.When it occurs, a rectification is generated for the S-2200 or S-2300 event as appropriate.

• If the update is made in the company or employee class in the employee’s job data, an S-3000 - EventExclusion event is generated for the corresponding event, followed by a new initial loading event forthe employee.

Related LinkseSocial Employee Initial PageeSocial Non Periodic Event Page

S-2306 - Workers who have no employment relationship - ChangesNon periodic event. This event layout updates information concerning contractual workers who do nothave employment relationships with the company, for example, non-employee directors, public serviceemployees who are appointed to councils or boards, and so on.

General Rules

Refer to the General Rules section of the S-2205 - Personal Data Changes event for rules that areapplicable to this event as well..

Related LinkseSocial Non Periodic Event Page

536 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 28 Global Payroll for Brazil Reports

S-2399 - Workers who have no employment relationship - EndTermination event. This event layout records information about the termination of workers who have noemployment relationships (non-employees) with their companies, for example, temporary workers, unionleaders, non-employee directors, members, and so on.

If a termination of a worker with no employment relationship occurs, the company needs to report it to thegovernment no later than the 7th business day after the termination, or before the submission of an S-1299event, whichever comes first.

Wage parcel and nature of indemnity payments pertaining to terminations of non-employees are to bereported through the S-1210 event.

The description for the S-2299 - Termination event applies to the S-2399 event as well. The onlydifference is that the S-2399 event pertains to workers with no employment relationship with theircompanies, whereas the S-2299 event applies to employees.

Related LinkseSocial Termination Events PageRun Types PageHealth Data Page

S-3000 - Event ExclusionNon periodic event. This event layout cancels events that were sent to the government by mistakes bycompanies.

Hire Exclusion

Sometimes, companies need to generate exclusions for hire events to have the hiring information removedfrom the government when:

• The corresponding hires fail through and no longer exist.

When that happens, administrators can run the process on the eSocial Hire Exclusion Page to generatedriver information of exclusions for these hire events. Then, prepare data and create XML files for theexclusion events on the eSocial Non Periodic Event Page to be submitted to the government.

• An employee updates:

Note: The employee information discussed in these scenarios is considered key information to thegovernment. The system reports changes of key information through the exclusion of existing eventsand generation of new events, rather than the rectification of existing events.

• The eSocial register number on the Additional Information BRA page.

In this scenario, the system first generates an exclusion event for the employee’s existing hireevent, and then generates a new hire event with the new eSocial register number.

• The company on the Work Location page.

Copyright © 1988, 2022, Oracle and/or its affiliates. 537

Global Payroll for Brazil Reports Chapter 28

In this scenario, the system first generates an exclusion event for the employee’s existing hireevent, and then generates a new hire event with the new company.

• The employee class from an employee one to a non-employee one (or vice versa) on the JobInformation page.

In this scenario, the system first generates an exclusion event for the employee’s existing hireevent (for example, S-2200), and then generates a new hire event that matches the new employeeclass (for example, S-2300).

No exclusion or hire events will be generated, if the old and new employee classes belong to thesame employee type.

Note: If additional events (S-2205, S-2206 or S-2306) have been submitted successfully to thegovernment following the submission of the existing hiring event, you must first submit exclusion eventsfor all of these events before sending an exclusion event for the hiring event itself.

PeopleSoft HCM provides the ability to delete employment record numbers (ERNs) when these numbersare created in error or are not no longer in use. For eSocial to work properly, you need to configure thesystem to exclude a number of eSocial tables from this process on the "ERN Delete Exception TablesPage" (PeopleSoft Human Resources Administer Workforce). These tables are:

• GPBR_DRVABS_XRF (Exception Type: Exclude, Person ID Field Name: EMPLID; Empl RecordField Name: EMPL_RCD)

• GPBR_DRVCAT_XRF (Exception Type: Exclude, Person ID Field Name: EMPLID; Empl RecordField Name: EMPL_RCD)

• GPBR_DRVCMP_XRF (Exception Type: Exclude, Person ID Field Name: EMPLID)

• GPBR_DRVEMP_XRF (Exception Type: Exclude, Person ID Field Name: EMPLID; Empl RecordField Name: EMPL_RCD)

Related LinkseSocial Non Periodic Event PageeSocial Payroll Events PageeSocial Termination Events Page

S-5001 - Social Contributions by EmployeeThis PeopleSoft query returns a list of social security contributions that were made by employees of thespecified company and competency period.

Query name: GPBR_ES_S5001_SOCIAL_CONTR_EMP

To run this query, enter the company, competency period (for example, 2016-03 for March 2016), andthe calculation indicator (enter 1 for monthly, and 2 for annually) as selection criteria. The informationreturned from this query comes from S-1200, S-2299, or S-2399 events, which were generated for thespecified company and period, and were received by the government successfully. Events that weredeleted using S-3000 events are not included in the query result.

538 Copyright © 1988, 2022, Oracle and/or its affiliates.

Chapter 28 Global Payroll for Brazil Reports

For more information on how to run PeopleSoft queries, see PeopleTools: Query, Running Queries.

S-5002 - Income Tax Withholding by EmployeeThis PeopleSoft query returns a list of income tax withholding by employees of the specified companyand competency period.

Query name: GPBR_ES_S5002_IRRF_EMPLOYEE

To run this query, enter the company and competency period (for example, 2016-03 for March 2016)as selection criteria. The information returned from this query comes from S-1210 events, which weregenerated for the specified company and period, and were received by the government successfully.Events that were deleted using S-3000 events are not included in the query result.

For more information on how to run PeopleSoft queries, see PeopleTools: Query, Running Queries.

S-5003 - FGTS EmployeeThis PeopleSoft query returns the total FGTS amounts that were made for employees of the specifiedcompany and competency period. It shows the total FGTS amount for each employee listed, and theamount is broken down into subtotals by establishment or tax location.

Query name: GPBR_ES_S5003_FGTS_EMPLOYEE

To run this query, enter the company and competency period (for example, 2016-03 for March 2016)as selection criteria. The information returned from this query comes from S-1200, S-2299, or S-2399events, which were generated for the specified company and period, and were received by the governmentsuccessfully. Events that were deleted using S-3000 events are not included in the query result.

For more information on how to run PeopleSoft queries, see PeopleTools: Query, Running Queries.

S-5011 - Social Contributions by EmployerThis PeopleSoft query returns the total social security contributions that were made for employees by thespecified company for the specified competency period.

Query name: GPBR_ES_S5011_SOCIAL_CONTR_COM

To run this query, enter the company, competency period (for example, 2016-03 for March 2016), andthe calculation indicator (enter 1 for monthly, and 2 for annually) as selection criteria. The informationreturned from this query comes from the S-1299 event, which was generated for the specified companyand period, and was received by the government successfully.

For more information on how to run PeopleSoft queries, see PeopleTools: Query, Running Queries.

S-5012 - IRRF Information Consolidated by Employer

Important! This eSocial report is no longer required and therefore has been inactivated in the S-1.0version.

This PeopleSoft query returns the total income tax withholding of employees for the specified companyand competency period.

Copyright © 1988, 2022, Oracle and/or its affiliates. 539

Global Payroll for Brazil Reports Chapter 28

Query name: GPBR_ES_S5012_IRRF_CONSOL_COMP

To run this query, enter the company and competency period (for example, 2016-03 for March 2016) asselection criteria. The information returned from this query comes from the S-1299 event, which wasgenerated for the specified company and period, and was received by the government successfully.

For more information on how to run PeopleSoft queries, see PeopleTools: Query, Running Queries.

S-5013 - FGTS by CompanyThis PeopleSoft query returns the total FGTS amount that was made for employees by the specifiedcompany for the specified competency period.

Query name: GPBR_ES_S5013_FGTS_CONSOL_COMP

To run this query, enter the company and competency period (for example, 2016-03 for March 2016) asselection criteria. The information returned from this query comes from the S-1299 event, which wasgenerated for the specified company and period, and was received by the government successfully. Eventsthat were deleted using S-1298 events are not included in the query result.

For more information on how to run PeopleSoft queries, see PeopleTools: Query, Running Queries.

540 Copyright © 1988, 2022, Oracle and/or its affiliates.