Skip to main content

Payroll

caution

This documentation is incomplete.

Payroll is the compensation that an organization pays to its employees for a given period of time. In inoERP, payroll controls various aspects of salaries paid to employees. The primary components of payroll are

  • Payment Method: Process and method of salary payment: check/cash/wire
  • Payment Calendar: Time of salary payment: exact date of payroll processing
  • Payroll: Combination of payment method and payment calendar (Ex Payroll_01, Payroll_02)
  • Payroll Process: A specific instance of payroll (Payroll_01 for Jan-2025)
  • Payslip: the amount paid to an employee. Payslip has different views for employees with HR and IT roles. Users with IT/HR roles can create bank files.

Payroll Calendar

To create/view/update the payroll calendar, navigate to the "payroll calendar" screen from your dashboard/favorite.

Enter the payroll calendar details or other criteria in the search form and click on the search button to view an existing payroll calendar.

If you don't enter any search criteria, the system will show you all the payroll calendars. If your organization has configured to make any field mandatory for search, you must enter those fields to search payroll calendars.
The application will fetch all the server data and take you to the search result screen. The search result screen looks a bit different on desktop and mobile devices.

If you click on the create new button, the system will open a simple step form to create a new payroll calendar. You can click on the detail right bottom to view all the fields available for the object.

To view the search result in a table format, click on the table icon in the bottom left corner.

To view specific payroll calendar details, click on the menu of that record, and click on view/fetch & view.

You can also click on the expand icon against any item on the search result screen to view the payroll calendar header details, name, description, revision number, etc.

The system will fetch all the selected document detail line data. Depending on the device size, the document details are shown either on the search result screen or on a separate screen.

Compensation Name: Enter a unique payroll calendar name. The calendar name is a mandatory field.

Description: Enter a meaningful description for the payroll calendar

Scroll left, right, up, and down to view all the details. The document line and details are shown in a separate tab. The default configuration shows fields in various functional groups, such as

  • Finance
  • Entity
  • Reference
  • Data
  • Control
  • Etc

You can configure the application to show which fields should be shown under which group. You can also create new groups as per your business requirements.

All Fields
SequenceNameLabelInputTypeField Group
10hrPayrollCalendarIdHr Payroll Calendar IdInputType.textREFERENCE
10srcEntityNameSrc Entity NamedefferedSelectDEFAULT
20srcEntityIdSrc Entity IdInputType.textREFERENCE
30calendarNameCalendar NameInputType.textFieldDEFAULT
40calendarTypeCalendar TypeInputType.selectCONTROL
50descriptionDescriptionInputType.textFieldDEFAULT
100docStatusDoc StatusInputType.selectCONTROL
5060createdByCreated ByInputType.textREFERENCE
5070creationDateCreation DateInputType.textREFERENCE
5080lastUpdatedByLast Updated ByInputType.textREFERENCE
5090lastUpdateDateLast Update DateInputType.textREFERENCE

Calendar Period

The calendar period specifies the start and end date of each period.

You can add multiple payroll calendar periods to each payroll calendar header. Each payroll calendar period shows a payroll calendar year, period number, period name, start, end date, etc.

Navigate to the "payroll calendar period" tab to view/add/update payroll calendar periods.
Click on the add new entity to add a new line. If a line already exists, click on copy entity to copy all the details. You can enable/disable fields allowed to be copied in the menu configuration.

year: Enter the four-digit calendar year number.

Period Number: Enter a numeric value of the period. For the monthly calendar, enter a value between 1 & 12.

Period Name: Enter a unique period name. Period name is used on payroll processing.

Scroll left, right, up, and down view all other fields.

The default configuration shows fields in various functional groups, such as

  • Reference
  • Control
  • Etc

You can configure the application to show which fields should be shown under which group. You can also create new groups as per your business requirements.

Enter all the other fields and click on the save button to save the payroll calendar. The app will post all the data to the server and show the messages returned from the server.

All Fields
SequenceNameLabelInputTypeField Group
10hrPayrollCalendarPeriodIdHr Payroll Calendar Period IdInputType.textREFERENCE
10srcEntityNameSrc Entity NamedefferedSelectDEFAULT
20srcEntityIdSrc Entity IdInputType.textREFERENCE
30hrPayrollCalendarIdHr Payroll Calendar IddefferedSelectREFERENCE
40periodNamePeriod NameInputType.textFieldFINANCE
50periodNumberPeriod NumberInputType.textFieldDATA
60yearYearInputType.numberDEFAULT
70startDateStart DateInputType.dateDATE
80endDateEnd DateInputType.dateDATE
90glPeriodIdGl Period IddefferedSelectREFERENCE
100adjustmentPeriodAdjustment PeriodInputType.checkBoxFINANCE
150periodDescriptionPeriod DescriptionInputType.textFieldFINANCE
5110createdByCreated ByInputType.textREFERENCE
5120creationDateCreation DateInputType.textREFERENCE
5130lastUpdatedByLast Updated ByInputType.textREFERENCE
5140lastUpdateDateLast Update DateInputType.textREFERENCE

Payment Method

To create/view/update the payment method, navigate to the "payment method " screen from your dashboard/favorite.

Enter the payment method details or any other criteria in the search form and click on the search button to view an existing payment method.

If you don't enter any search criteria, the system will show you all the payment methods. If your organization has configured to make any field mandatory for search, you must enter those fields to search payment methods.
The application will fetch all the server data and take you to the search result screen. The search result screen looks a bit different on desktop and mobile devices.

If you click on the create new button, the system will open a simple step form to create a new payment method. You can click on the detail right bottom to view all the fields available for the object.

To view the search result in a table format, click on the table icon in the bottom left corner.

To view specific payment method details, click on the menu of that record, and click on view/fetch & view.

You can also click on the expand icon against any item on the search result screen to view the payment method header details, name, Description, revision number, etc.

The system will fetch all the selected document detail line data. Depending on the device size, the document details are shown either on the search result screen or on a separate screen.

Payment Method: Enter a unique payment method name. Name is a mandatory field.

Legal Org: Select a legal org name. Legal org can be used for defaulting salary accounting entries.

Description: Enter a meaningful description of the payment method

Scroll left, right, up, and down to view all the details. The document line and details are shown in a separate tab. The default configuration shows fields in various functional groups, such as

  • Finance
  • Entity
  • Reference
  • Data
  • Control
  • Etc

currency: Select a currency that will be used for salary payment

Payment Type: Select a payment type. Available options are electronic, check, cash, and others.

You can configure the application to show which fields should be shown under which group. You can also create new groups as per your business requirements.

All Fields
SequenceNameLabelInputTypeField Group
10vvLegalOrgCodeLegal Org CodedefferedSelectENTITY
10hrPayrollPaymentMethodIdHr Payroll Payment Method IdInputType.textREFERENCE
20paymentMethodPayment MethodInputType.textFieldFINANCE
30legalOrgIdLegal Org IddefferedSelectREFERENCE
40paymentTypePayment TypeInputType.selectCONTROL
50startDateStart DateInputType.dateDATE
60endDateEnd DateInputType.dateDATE
70descriptionDescriptionInputType.textFieldDEFAULT
80currencyCurrencydefferedSelectFINANCE
90bankAccountIdBank Account IdInputType.textREFERENCE
100cashAcIdCash Ac IddefferedSelectREFERENCE
110clearingAcIdClearing Ac IddefferedSelectREFERENCE
120bankChargeAcIdBank Charge Ac IddefferedSelectREFERENCE
130salaryPayableAcIdSalary Payable Ac IddefferedSelectREFERENCE
180srcEntityNameSrc Entity NamedefferedSelectDEFAULT
190srcEntityIdSrc Entity IdInputType.textREFERENCE
5140createdByCreated ByInputType.textREFERENCE
5150creationDateCreation DateInputType.textREFERENCE
5160lastUpdatedByLast Updated ByInputType.textREFERENCE
5170lastUpdateDateLast Update DateInputType.textREFERENCE

Payroll

To create/view/update payroll, navigate to the "payroll " screen from your dashboard/favorite.

Enter the payroll details or other criteria in the search form and click on the search button to view an existing payroll.

If you don't enter any search criteria, the system will show you all the payrolls. If your organization has configured to make any field mandatory for search, you must enter those fields to search payrolls.
The application will fetch all the server data and take you to the search result screen. The search result screen looks a bit different on desktop and mobile devices.

If you click on the create new button, the system will open a simple step form to create a new payroll. You can click on the detail right bottom to view all the fields available for the object.

To view the search result in a table format, click on the table icon in the bottom left corner.

To view specific payroll details, click on the menu of that record, and click on view/fetch & view.

You can also click on the expand icon against any item on the search result screen to view the payroll header details, name, Description, revision number, etc.

The system will fetch all the selected document detail line data. Depending on the device size, the document details are shown either on the search result screen or on a separate screen.

Payroll Code: Enter a unique payroll code. The payroll code is a mandatory field.

Calendar Name: Select a calendar name. The calendar name is a mandatory field.

Payment Method: Select a payment method. Payment method is a mandatory field.

Description: Enter a meaningful description for the payroll

Scroll left, right, up, and down to view all the details. The document line and details are shown in a separate tab. The default configuration shows fields in various functional groups, such as

  • Finance
  • Entity
  • Reference
  • Data
  • Control
  • Etc

You can configure the application to show which fields should be shown under which group. You can also create new groups as per your business requirements.

All Fields
SequenceNameLabelInputTypeField Group
10vvHrCalendarNameHr Calendar NamedefferedSelectDEFAULT
10vvHrPaymentMethodHr Payment MethoddefferedSelectFINANCE
20hrPayrollIdHr Payroll IdInputType.textREFERENCE
30payrollNamePayroll NameInputType.textFieldFINANCE
40payrollCodePayroll CodeInputType.textFieldFINANCE
50periodTypePeriod TypeInputType.selectCONTROL
60hrPayrollCalendarIdHr Payroll Calendar IddefferedSelectREFERENCE
70hrPayrollPaymentMethodIdHr Payroll Payment Method IddefferedSelectREFERENCE
80startDateStart DateInputType.dateDATE
90endDateEnd DateInputType.dateDATE
100descriptionDescriptionInputType.textFieldDEFAULT
150glAcProfileHeaderIdGl Ac Profile Header IddefferedSelectREFERENCE
160srcEntityNameSrc Entity NamedefferedSelectDEFAULT
170srcEntityIdSrc Entity IdInputType.textREFERENCE
5110createdByCreated ByInputType.textREFERENCE
5120creationDateCreation DateInputType.textREFERENCE
5130lastUpdatedByLast Updated ByInputType.textREFERENCE
5140lastUpdateDateLast Update DateInputType.textREFERENCE

Payroll Calendar

The payroll calendar specifies the dates on which payroll is processed and salaries are paid to employees.

The payroll calendar tab shows the details of the payroll calendar assigned to the payroll.

Navigate to the "payroll calendar" tab to view payroll calendar details. To view the payroll calendar dates, click on the calendar period buttons.

Period Name: Name of the payroll period

Payroll Payment Method

The payroll payment method specifies how the payroll is processed and salaries are paid to employees.

The payroll payment method tab shows the details of the payroll payment method assigned to the payroll.



Payment Type: This shows the type of payment. For electronic payment system generates bank files with all the fields on the payslip. You can customize the bank file/check print by using JavaScript REST APIs as per your business requirements.

Payroll Actions

Copy action allows you to copy all the payroll details to a new payroll. The system creates the new payroll with "Copy of {{source payroll name}}" as the payroll number. You should change the payroll number to a more meaningful value.

Payroll Process

Payroll Process represents a specific instance run of a payroll. You can create a new payroll process from the payroll action tab by clicking on "Run Next Payroll."

Status

The system creates payroll processes in entered status and as per the stage of payroll system will show any of the below statuses.

  • Entered: The first status of a payroll process. Payroll processes remain in Entered status till you start the "Run Payroll." program
  • Open: Run payroll program is completed successfully. Run payroll process creates all payslip header and line details
  • Confirmed: Payroll has been reviewed by HR and is ready to be paid
  • Paid : Payroll has been paid. You change the status of a payroll to be paid after you get the confirmation from your bank.
  • Cancelled: Payroll has been canceled

To view/update the payroll process, navigate to the "payroll process" screen from your dashboard/favorite.

Enter the payroll process details or any other criteria in the search form and click on the search button to view an existing payroll process.

If you don't enter any search criteria, the system will show you all the payroll processes. If your organization has configured to make any field mandatory for search, you must enter those fields to search payroll processes.
The application will fetch all the server data and take you to the search result screen. The search result screen looks a bit different on desktop and mobile devices.

You can click on the detail right bottom to view all the fields available for the object.

To view the search result in a table format, click on the table icon in the bottom left corner.

To view specific payroll process details, click on the menu of that record, and click on view/fetch & view.

You can also click on the expand icon against any item on the search result screen to view the payroll process header details, name, Description, revision number, etc.

The system will fetch all the selected document detail line data. Depending on the device size, the document details are shown either on the search result screen or on a separate screen.

Payroll Code: The payroll code against which the payroll process is created.

Payment Method: How the payslips on the payroll will be paid. The value defaults from the payroll.

currency: The currency of the payslips. The value also defaults from the payroll.

Scroll left, right, up, and down to view all the details. The document line and details are shown in a separate tab. The default configuration shows fields in various functional groups, such as

  • Finance
  • Entity
  • Reference
  • Data
  • Control
  • Etc

year: The year for which the payroll process is created. The value is shown on payslips. The system defaults this value from the payslip and assigned calendar.

Period Number: The period number for which the payroll process is created. The value is shown on payslips. The system defaults this value from the payslip and assigned calendar.

You can configure the application to show which fields should be shown under which group. You can also create new groups as per your business requirements.

All Fields
SequenceNameLabelInputTypeField Group
10payrollCodePayroll CodeInputType.textFieldFINANCE
10payrollNamePayroll NameInputType.textFieldFINANCE
20periodTypePeriod TypeInputType.selectCONTROL
30hrPayrollPaymentMethodIdHr Payroll Payment Method IddefferedSelectREFERENCE
40paymentMethodPayment MethodInputType.textFieldFINANCE
50legalOrgIdLegal Org IddefferedSelectREFERENCE
60paymentTypePayment TypeInputType.selectCONTROL
70currencyCurrencydefferedSelectFINANCE
80periodNamePeriod NameInputType.textFieldFINANCE
90periodNumberPeriod NumberInputType.textFieldDATA
100yearYearInputType.numberDEFAULT
110startDateStart DateInputType.dateDATE
120endDateEnd DateInputType.dateDATE
130hrPayrollProcessIdHr Payroll Process IdInputType.textREFERENCE
140hrPayrollIdHr Payroll IddefferedSelectREFERENCE
150hrPayrollCalendarPeriodIdHr Payroll Calendar Period IdInputType.textREFERENCE
160hrPayrollScheduleIdHr Payroll Schedule IdInputType.textREFERENCE
170procesNameProces NameInputType.textFieldDEFAULT
180processStatusProcess StatusInputType.selectCONTROL
190glJournalHeaderIdGl Journal Header IdInputType.textREFERENCE
200descriptionDescriptionInputType.textFieldDEFAULT
250srcEntityNameSrc Entity NamedefferedSelectDEFAULT
260srcEntityIdSrc Entity IdInputType.textREFERENCE
5210createdByCreated ByInputType.textREFERENCE
5220creationDateCreation DateInputType.textREFERENCE
5230lastUpdatedByLast Updated ByInputType.textREFERENCE
5240lastUpdateDateLast Update DateInputType.textREFERENCE

Actions

Use actions to process a payroll.

  • Cancel: Cancel a payroll that is not yet processed. You can only cancel a payroll in entered status. Payroll status changes to canceled
  • Run Payroll: Run payroll process creates all payslip header and line details. It also changes the payroll process status from entered to open.
  • Confirm payroll: After manually reviewing all the payslip details, you can confirm a payroll. This process changes payroll status from open to confirm. Confirmed payrolls are ready for payment.
  • Change Payroll Status to Paid: Changes the payroll status to paid.

You can use create bank files and print check programs to create salary payment programs.

Add your custom logic in assets/js/ierp/hr/hr_payroll.js file.

assets/js/ierp/hr/hr_payroll.js
   if (action == "hr_run_payroll") {
let hrPayrollProcessId = data["hrPayrollProcessId"];
if (hrPayrollProcessId) {
return runPayroll(hrPayrollProcessId);
} else {
retDataMap["rd_proceed_message"] =
"Unable to run payroll as no leave hrPayrollProcessId is provided";
}
} else if (action == "hr_confirm_payroll") {
let hrPayrollProcessId = data["hrPayrollProcessId"];
if (hrPayrollProcessId) {
return confirmPayroll(hrPayrollProcessId);
} else {
retDataMap["rd_proceed_message"] =
"Unable to confirm payroll as no leave hrPayrollProcessId is provided";
}
} else if (action == "hr_change_payroll_status_to_paid") {
let hrPayrollProcessId = data["hrPayrollProcessId"];
if (hrPayrollProcessId) {
return confirmPayroll(hrPayrollProcessId);
} else {
retDataMap["rd_proceed_message"] =
"Unable to confirm payroll as no leave hrPayrollProcessId is provided";
}
}else if (action == "hr_create_bank_file") {
//Write your custom logic to create bank file
}else if (action == "hr_create_payroll_check") {
//Write your custom logic to print check
} else {
return data;
}