Identifying Events

Active and As of

Select to generate specified events only for active employees.

When selected, specify the Active as of date. Employees who remain active on this date will be included in the employee initial loading events.

Inactive, From and To

Select to generate specified events only for inactive employees (terminated employees).

When selected, specify the termination period. Employees who were terminated during this period will be included in the employee initial loading events.

Company

Select a company for the pre-hiring event. The selected company becomes the default value that is populated in the Employees section.

Hire Date

Select the estimated hire date, which cannot be earlier than the current date. The specified date becomes the default value that is populated in the Employees section.

Employee ID

Select the employee or individual for which the pre-hiring event is launched.

You can select from:

• Employees whose employee IDs are inactive with an effective date less than or equal to the system date. Or

• Individuals whose person IDs do not have employment relationship in job data.

Company

Select the company for the selected individual. Companies that are enabled on the Company Parameters Page for eSocial reporting are available for selection.

Reg Region (regulatory region)

Select the regulatory region to determine the setID for the Empl 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 Information page (JOB_DATA_JOBCODE).

Hire Date

Select the estimated hire date for the selected individual. This date is sent to eSocial as the hire date and it cannot be earlier than the current date.

Business Unit

Select the business unit to determine the setID for the Job Code field.

Job Code

Select the job code used to populate the Brazilian Occupation Cd field automatically.

Brazilian Occupation Cd (Brazilian occupation code)

The system populates this field automatically when you select a job code. This field value is required for eSocial.

Comp Rate and Contract Salary Type

Enter the salary amount of the job, and the salary type of the amount, 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 field appears when the selected contract type is Determinate.

Search Date By

Select to look up events by:

Hire Date

Transaction Date

Then, enter a date range to search for events with hire or transaction dates that fall between the specified date range.

Search Status By

Select to look up events by status. Values are:

Await Exclusion: Select to search for S-2190 events with S-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 completed successfully.

Error: Select to search for events that encountered errors at any stage of the eSocial report process (for example, mapping process, 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 associated with pre-hiring protocol numbers.

Hiring in Progress: Select to search for S-2190 events with S-2200 events that are in the XML Create status.

Pending Hiring: Select to search for S-2190 events with receipt numbers and are associated with S-2200 events.

Wait for Return: Select to search for events (S-2190, S-2200 and S-3000) that are awaiting protocol numbers to be returned from the government.

Withdraw Hiring: Select to search for S-2200 events, which reference S-2190 events, that have been excluded.

Withdraw Pre-Hiring: Select to search for S-2200 events that have been sent as part of employee initial loading and have been excluded, and corresponding receipt numbers returned from the government.

Search By

Select to look up events by:

Company. Select one or more companies, which are enabled in the Company Parameters Page.

Employees. Select one or more employee IDs that are either inactive, or do not have employment relationships in job data.

Select

Select one or more events for an action (already selected) to be performed.

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 the employee.

Details

Click to view additional details of the selected event on the Search Results - Details page (GPBR_ES_HIRE_DET).

Action and Process

Select an action to perform. Values are:

Cancel: Select to set the statuses of selected events to Canceled. Cancelled events can be reprocessed.

Exclude: Select to generate S-3000 events for selected S-2190 events that are in the Pending Hiring status.

Rectify: Select generate rectification drivers for the selected events. Only events with a receipt number can be rectified. When an event is selected for the Rectify action, you can update the employee class and hire date as needed. According to 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 associated S-2200 or S-2300 event must match. If the information (employee class and hire date) was sent incorrectly using the S-2190 event, the event needs to be rectified before sending the S-2200 or S-2300 event. If the CPF or birthdate was sent to the Government using the S-2190 event and the information was incorrect, you need to first update it from the source (the Personal Data component) and rectify the S-2190 event before sending the S-2200 or S-2300 event.

Reprocess: Select to run the pre-hiring AE process again on selected events. This action is available to events that have encountered error.

The Process button appears when an action is selected. Click to process selected events with the selected action.

Competency Year and Competency Month

Specify the time period that is being assessed for termination reporting.

Selection Criteria

Select to process terminations for all companies, or a selection of companies that are selected in the Companies section that appears.

S-2299 Termination and S-2399 Workers who have no employment relationship – End

Displays the two system-delivered termination events (S-2299 and 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 events for terminations (employee, non-employee, or both) that match the specified search criteria.

Submit a termination exclusion event if your wish to remove from the government’s eSocial system termination information that was submitted by mistake.

Search Criteria

Click to search for all finalized termination calendars for employees that were terminated during the specified competency period for the selected companies.

Employees and calendars that are identified for termination are available for viewing by clicking the View Payroll Event Status link that appears.

View Payroll Event Status

Click, if available, to access the eSocial Processed Calendars - eSocial Termination Events page to review a list of payroll calendars that have been identified for S-2299 and S-2399 events.

Period Type

Specify whether this payroll tax exemption is monthly or annually in nature.

If payroll tax exemption entries are entered both monthly and annually for the same company and competency period, two S-1280 events will be created after validation checks are passed.

If the selected period type is Annual, an S-1280 event will be created 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 set as Partially Replaced on the Additional Info - Brazil Page for the establishment headquarter of the selected company.

Period Type

Specify the applicable period type, Monthly or Annual. Do not specify the same period type more than once.

% Tax Due

Specify the percentage of INSS contribution due for the selected period type.

Union Code

Select an applicable union code.

Union codes are set up using the Unions component.

See Also Setting Up Unions

Contribution Type

Select the type of the union contribution to be reported. Values are:

Assistance. The period type for this contribution type is Monthly.

Associative. The period type for this contribution type is Monthly.

Compulsory. The period type for this contribution type is Annually.

Confederative. The period type for this contribution type is Monthly.

Amount

Enter positive non-zero union contribution amount.

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 the Adhere to eSocial date (its month and year) that is specified for each company included in this payroll event process. If the period is invalid, the process stops and an error “Period selected in Run Control page isn't valid” is logged.

If an S-1299 event (Closing Periodic event) exists in the system for the same period and company that is specified on this page, and the event is not cancelled or excluded, the payroll event process stops and an error “Event S-1299 created for this Company in this Period” is logged. However, if an S-1298 event (Reopening Periodic event) also exists for the same period and company, and is associated with a receipt number, which voids the S-1299 event, the payroll event process continues.

Selection Criteria

Select to process payroll events for:

All Companies

Company: A list of companies that are selected in the Companies section.

Employee: A list of employees that are selected in the Employee Selection section.

Period Type

Select:

Annual to generate the selected payroll events for the specified year.

Month to generate the selected payroll events for the specified year and month.

This field appears if the selected competency month is 12 - December.

Company

Specify a company of which employees can be picked for the selected payroll events.

This field appears if the Selection Criteria field is set to Employee.

S-1300 Employer Union Contribution

S-1280 Complementary Information to Periodic Events

Select to process and generate S-1280 event reports in the payroll event process.

See Also S-1280 - Complementary Information to Periodic Events

S-1200 Compensation

Select to process and generate S-1200 event reports in the payroll event process.

Both S-1200 or S-1210 events are processed together. If either one of them is selected, the system selects the other one automatically and makes it unavailable for edits. Additionally, the system also selects the Identify Calendars option to be included 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 the payroll event process.

See Also S-1210 - Miscellaneous Payments

S-3000 Emp Union Contribution, S-3000 Complementary Info., S-3000 Compensation and S-3000 Miscellaneous Pay

If applicable, select to prepare and generate exclusion events for corresponding payroll events.

Submit a payroll exclusion event if you wish to remove from the government’s eSocial system corresponding payroll data that was submitted by mistake.

See Also S-3000 - Event Exclusion

View Payroll Event Status

Click to access the eSocial Processed Calendars - eSocial Payroll Events page to review a list of payroll calendars that have been identified for S-1200 and S-1210 events.

This link appears after the Identify Calendars processing option is run successfully for S-1200 and S-1210 events.

Event Code

Select a periodic control event to, for example, reopen or close a period. As delivered, S-1298 and S-1299 are available for selection.

Competency Year and Competency Month

Specify the period to be reopened or closed.

Selection Criteria

Select:

All Companies to process payroll events for all eSocial-active companies, or

Company to manually select eSocial-active companies from the Companies section that appears for processing.

Period Type

Select the period type of the specified period to reopen. Values are Annual and Monthly. This field appears if the selected competency month is December.