Gratuity Rule
How to use Gratuity Rule in Payroll: access, working steps, fields, related records and troubleshooting.
Purpose and access
Maintain salary components, structures and assignments, then prepare payroll for the selected period. Review attendance and leave effects, deductions and employee details before submission and payment. Payroll access is private.
This page is a record page in Human Resources → Payroll. Use the link above to open the configured destination; permissions are checked by the destination service.
Before you start
Prepare the required information: Calculate Gratuity Amount Based On, Applicable Earnings Component, Current Work Experience.
Confirm the company, party, dates, units and source references that apply. Select existing links carefully and check for an existing record before creating a duplicate.
Working steps
- Open Gratuity Rule from Human Resources → Payroll, or use ERP Search.
- Filter the list and open the relevant record. To add a record, use Add/New when your role provides that action.
- Complete the editable fields described below. Required fields and validation conditions must be satisfied; read-only values are set by the system or their source records.
- Add the required child rows. Review each row’s identifiers, linked records and values, using the child-table field reference below.
- Save the record and address validation messages. Reload and verify the saved values and relationships.
- Use any additional workflow actions only when the record and your role provide them. Saving this record does not automatically complete a related transaction or external action.
Field reference
These fields come from the installed ERP definition. Hidden fields and password inputs are omitted. Additional conditions, custom scripts and workflow rules can make a field required or read-only in a particular context.
| Field | Type / behavior | How to use it |
|---|---|---|
Disabledisable | Check Optional | Enable or disable the named option only when it matches the intended record behavior. |
Calculate Gratuity Amount Based Oncalculate_gratuity_amount_based_on | Select Required | Choose one of the configured list values. Status fields may be controlled by the record workflow.Available choices
|
Total working Days Per Yeartotal_working_days_per_year | Float Optional | Enter a numeric value using the required unit and precision. |
Work Experience Calculation Methodwork_experience_calculation_function | Select Optional | Choose one of the configured list values. Status fields may be controlled by the record workflow.Available choices
|
Minimum Year for Gratuityminimum_year_for_gratuity | Int Optional | Enter a whole-number value. |
Applicable Earnings Componentapplicable_earnings_component | Table MultiSelect Required | Salary components should be part of the Salary Structure. Linked record: Gratuity Applicable Component |
Current Work Experiencegratuity_rule_slabs | Table Required | Set "From(Year)" and "To(Year)" to 0 for no upper and lower limit. Linked record: Gratuity Rule Slab |
Child tables
Applicable Earnings Component — child-row fields
| Field | Type / behavior | How to use it |
|---|---|---|
Salary Componentsalary_component | Link Required | Choose an existing linked record. Check its company and ownership; typing a label alone does not create a new relationship. Linked record: Salary Component |
Current Work Experience — child-row fields
| Field | Type / behavior | How to use it |
|---|---|---|
From(Year)from_year | Int Required · Read-only | Enter a whole-number value. |
To(Year)to_year | Int Required | Enter a whole-number value. |
Fraction of Applicable Earningsfraction_of_applicable_earnings | Float Required | Enter a numeric value using the required unit and precision. |
Troubleshooting
- Not permitted: verify the account, role and source-document permission. Do not share an administrator login.
- Missing record or address: inspect the relevant Link or Dynamic Link fields; a matching title alone does not establish a relationship.
- Cannot save or change status: review required fields, read-only values, document status and the configured approval transition.
- Unexpected report or portal result: review company/date filters, source-document submission and the approved party or Employee link.