Field reference

Every field on every Payroll form: label in English and Arabic, type, whether it is required, its limits, a valid example and what the system refuses.

On this page (34)
Payroll runs > New runRun record > Freeze inputsRun record (all commands)Run record > ApproveRun record > Exceptions > AcknowledgeRun record > Correction runRun record > Prepare WPS file (SIF)Run record > Prepare payment fileManual inputs > New inputManual inputs > Approve / RejectAdjustments > Void adjustmentPayment file record > Release to bankPayment file record > Bank answerSettlement record > CalculateSettlement record > Sign offSettlement record > Return to preparerSettlement record > Cancel settlementSettlement record > Correct settlementEnd-of-service provisionsEnd-of-service provisions (API)End-of-service provisions > Roll-forwardRule packages > New package / recordRule packages > New package / record (API)Rule package > Add elementRule package > Add element (API)Rule package > Add rulePay groups > New groupPay groups > New group (API)Pay groups (API) > membersPay periods > New periodPay periods > New period (API)Settlement policy recordSettlement policy > ComponentsPayroll app configuration > Fields

Payroll runs > New run

FieldArabic labelTypeRequiredRules and limitsDefaultExampleRefused when
PeriodالفترةSelect (pay period)YesPay periods of this company shown as '<group> <code>'. The group must be active. Only one regular run per period that is not cancelledMONTHLY 2026-09A period that already has a regular run -> 'Period 2026-09 already has the regular run PR-MONTHLY-2026-09-01 (draft). A second one would pay the period twice; cancel that run or raise an off-cycle or correction run instead.'
TypeالنوعSelectYesRegular / Off-cycle. A correction run is raised from the run it corrects; a final run only from a settlementRegularOff-cycle(API) run_type=correction -> 'Choose regular or off-cycle. A correction is raised from the run it corrects.'
Run numberرقم المسيرAuto-PR-<group code>-<period code>-<nn>, nn = runs of that period + 1PR-MONTHLY-2026-09-01
Pay group (via period)مجموعة الرواتبRule-An inactive group is refusedPeriod of an inactive group -> 'This pay group is inactive.'

Run record > Freeze inputs

FieldArabic labelTypeRequiredRules and limitsDefaultExampleRefused when
Rule package in forceحزمة القواعد الساريةRuleYesThe group's package code must have an APPROVED version in force on the period's last day, and its content hash must still matchNo approved package -> 'No approved rule package DEMO-AE is in force on 2026-09-30. Approve one under Configuration.'
People in the runالموظفون في المسيرRuleYesNamed group members, or (no members) everyone on the roster whose contract currency is the group's currency; a leaver with no contract is left outGroup with nobody -> 'No employees fall in this pay group and period.'

Run record (all commands)

FieldArabic labelTypeRequiredRules and limitsDefaultExampleRefused when
Revisionرقم المراجعةHidden numberYesEach command carries the revision you are looking atAct in a stale tab -> 'This payroll run has changed since you opened it (revision 3, you sent 2). Reload and try again.'

Run record > Approve

FieldArabic labelTypeRequiredRules and limitsDefaultExampleRefused when
FingerprintالبصمةHiddenYesThe run fingerprint you reviewed; must equal the run's current oneRecalculated in another tab -> 'The run no longer matches the fingerprint you reviewed.'

Run record > Exceptions > Acknowledge

FieldArabic labelTypeRequiredRules and limitsDefaultExampleRefused when
Why is this acceptable?لماذا هذا مقبول؟Text (prompt)YesMax 500. Needs payroll.approve. Not on a closed or cancelled runJoined mid-month, proration checkedEmpty -> 'This is required.'; on a closed run -> 'This run is finished.'

Run record > Correction run

FieldArabic labelTypeRequiredRules and limitsDefaultExampleRefused when
PayslipالقسيمةSelectYesA payslip of the original (posted or closed) run(API) a payslip of another run -> 'Each line must name a payslip of the original run.'
Element codeرمز العنصرTextYesUpper-cased; must be an element of the run's rule packageBONUS'XYZ' -> 'XYZ is not in the run's rule package.'
Amount (negative reduces)المبلغ (السالب يخفض)DecimalYesNon-zero; negative reduces pay250.000 -> 'A correction line needs a non-zero amount.'; 'abc' ->
ReasonالسببTextYes5 to 500 characters (button disabled under 5)Missed September bonus'oops' (API) -> 'Say why the run is being corrected.'
Idempotency keyمفتاح عدم التكرارHiddenYesSent by the screen; same key + same request returns the first answer; same key + different request refused(API) no key -> 'A correction is a financial command: send an idempotency key.'; reused -> 'That idempotency key was already used for a different request.'

Run record > Prepare WPS file (SIF)

FieldArabic labelTypeRequiredRules and limitsDefaultExampleRefused when
MOHRE establishment number (13 digits)رقم المنشأة (13 رقماً)DigitsYesNon-digits stripped; exactly 13 digits1000000000001'12345' -> 'Give the MOHRE establishment number (13 digits) and the paying agent's routing code (9).'
Paying agent routing code (9 digits)رمز الوكيل (9 أرقام)DigitsYesExactly 9 digits803320101'8033' -> same message as above
Each bank's routing codeرموز البنوكText area (bank=code per line)YesBank code = IBAN characters 5-7 (e.g. AE07 033 ... -> 033); each needs a 9-digit routing code. Every employee needs a MOHRE person reference or labour card number in HR033=803320101Missing a bank -> 'The SIF cannot be written: PI-...: no 9-digit routing code for bank 033'; no labour card -> '...: no MOHRE person reference or labour card number on the employee'
CurrencyالعملةRule-WPS pays in AED onlyA USD instruction -> 'WPS pays in dirhams; an instruction is in another currency.'

Run record > Prepare payment file

FieldArabic labelTypeRequiredRules and limitsDefaultExampleRefused when
Formatصيغة الملفHiddenYesGENERIC-CSV-1 (button Prepare payment file) or WPS-SIF-1 (button Prepare WPS file)GENERIC-CSV-1(API) format=XYZ -> 'Choose the file format: GENERIC-CSV-1 or WPS-SIF-1.'

Manual inputs > New input

FieldArabic labelTypeRequiredRules and limitsDefaultExampleRefused when
EmployeeالموظفSelectYesEmployees of this company (list read from HR employees)EMP-0001 Test Employee A(API) another company's employee -> 'Choose an employee of this company.'
PeriodالفترةSelectYesA pay period of this company(API) none -> 'Choose a pay period.'
Element codeرمز العنصرTextYesMax 30, upper-cased. If an approved package is in force for the period, the element must be in itBONUSBONUS'XMAS' -> 'The rule package DEMO-AE v1 has no element XMAS.'
AmountالمبلغDecimalYesAbove 0 (or quantity x rate via API); not negative1500.000 -> 'An input needs an amount, or a quantity and a rate.'; -5 -> 'This cannot be below 0.'; 'abc' -> 'Send the amount as a decimal string.'
Source reference (unique)مرجع المصدر (فريد)TextConditionalMax 64. Blank = system id. Field setting 'Pay input source reference': Required or Hidden. Same source + version cannot be entered twiceBONUS-2026-09-ASame reference again -> 'The source manual:BONUS-2026-09-A (version 1) is already recorded as input <id> (pending). It cannot be paid twice.'
Source version (API)إصدار المصدرWhole numberNoStarts at 1; a newer version supersedes older ones no run has taken; an older version is refused10 -> 'The source version starts at 1.'; 1 after 2 -> 'Version 1 of manual:X is superseded: version 2 has already been recorded.'
Quantity / Rate / Note (API only)الكمية / المعدل / ملاحظةDecimal / textNoNot on the dialog. Quantity default 1, rate 0, both not negative; note max 500quantity 2, rate 250

Manual inputs > Approve / Reject

FieldArabic labelTypeRequiredRules and limitsDefaultExampleRefused when
DeciderالمعتمدRule-Needs payroll.approve; a different person from whoever entered it; only a pending input no run has takenOwn input -> 'A pay input is approved by somebody other than whoever entered it.'; twice -> 'This input is already approved.'

Adjustments > Void adjustment

FieldArabic labelTypeRequiredRules and limitsDefaultExampleRefused when
ReasonالسببTextYes5 to 500 characters; only a Queued adjustment; needs payroll.approveDuplicate of HR correction'no' -> 'Say why the adjustment is being voided.'; an In-a-run one -> 'Only a queued adjustment can be voided; this one is consumed.'

Payment file record > Release to bank

FieldArabic labelTypeRequiredRules and limitsDefaultExampleRefused when
ReleaserالمُصدرRule-payroll.pay_release; a different person from the file's preparer; file must be Prepared; stored bytes must match SHA-256; bank details unchangedPreparer releases -> 'A payment file is released by somebody other than whoever prepared it.'

Payment file record > Bank answer

FieldArabic labelTypeRequiredRules and limitsDefaultExampleRefused when
Status per instruction (API)حالة التعليمةChoiceYesaccepted / rejected / unknown, with optional reason (max 300). Screen only offers 'accepted all' / 'rejected all'status=paid -> 'Status is accepted, rejected or unknown.'; accepted -> rejected -> 'An accepted instruction cannot be reversed here.'

Settlement record > Calculate

FieldArabic labelTypeRequiredRules and limitsDefaultExampleRefused when
Settlement policy (resolved)سياسة التسويةRuleYesAn approved policy covering the HR termination reason on the last day; else finding 'No approved settlement policy covers this termination reason on the last day.' (blocking)

Settlement record > Sign off

FieldArabic labelTypeRequiredRules and limitsDefaultExampleRefused when
Specialist note per not-configured componentملاحظة المختصTextConditionalEvery 'Not configured - specialist rule required' component needs a note of 5+ characters; each component onceNot applicable: resignation under 1 yearBlank -> 'Every not-configured component needs the specialist's written decision before sign-off.' with 'Acknowledge notice_pay with a note saying what was decided ...'
Review note (optional)ملاحظة المراجعة (اختياري)TextNoMax 500

Settlement record > Return to preparer

FieldArabic labelTypeRequiredRules and limitsDefaultExampleRefused when
ReasonالسببTextYes5 to 500 characters; clears the sign-off'no' -> 'Say why the settlement is sent back.'

Settlement record > Cancel settlement

FieldArabic labelTypeRequiredRules and limitsDefaultExampleRefused when
ReasonالسببTextYesMax 500; only before approvalEmpty -> 'This is required.'; an approved one -> 'This settlement is approved; this step needs it to be draft or calculated or review or reviewed.'

Settlement record > Correct settlement

FieldArabic labelTypeRequiredRules and limitsDefaultExampleRefused when
Lines (payslip, element, amount, note) and reasonبنود التصحيحLinesYesSame rules as a run correction; only within the policy's correction period after postingPosted 40 days ago with a 30-day period -> 'The policy accepts corrections for 30 days after posting; this was posted 40 days ago.'

End-of-service provisions

FieldArabic labelTypeRequiredRules and limitsDefaultExampleRefused when
Month endنهاية الشهرDateYesYYYY-MM-DD; only one proposed run at a time; must be after the last posted oneLast day of this month2026-09-30Same date as a posted run -> 'A provision is already posted for 2026-09-30 or later; provisions move forward only.'; second proposal -> 'A provision run is already waiting to be posted.'
Base componentsمكونات الأساسText (comma list)NoContract earning codes summed as the monthly baseBASICBASICA code the contract lacks -> line note 'no XYZ on the contract' (not refused)
Expense accountحساب المصروفAccount codeConditionalMust exist in this company's chart; blank = 620200 if it exists620200'999999' -> 'Name the end-of-service expense and provision accounts of this company's chart.'
Provision accountحساب المخصصAccount codeConditionalMust exist in this company's chart; blank = 240200 if it exists240200Unknown code -> same message

End-of-service provisions (API)

FieldArabic labelTypeRequiredRules and limitsDefaultExampleRefused when
Divisorالمقسوم عليهDecimalNoAbove zero; day's wage = base / divisor300 -> 'The divisor turns a monthly base into a day's wage; give it above zero.'

End-of-service provisions > Roll-forward

FieldArabic labelTypeRequiredRules and limitsDefaultExampleRefused when
From / Toمن / إلىDateYesYYYY-MM-DD1 Jan this year / this month end(API) start=2026/01/01 -> 'Send the date as YYYY-MM-DD.'

Rule packages > New package / record

FieldArabic labelTypeRequiredRules and limitsDefaultExampleRefused when
CodeالرمزTextYesMax 30, upper-cased. A new package with an existing code becomes the next version (v2, v3)AE-STDEmpty -> 'This is required.'; 31 characters -> 'Keep this to 30 characters.'
NameالاسمTextYesMax 160UAE standard payroll 2026Empty -> 'This is required.'
Arabic name (API)الاسم العربيTextNoMax 160; not on the New package dialogرواتب الإمارات القياسية
Country (API)الدولةTextNoMax 3, upper-casedAEAE'UAEX' -> 'Keep this to 3 characters.'
Effective fromساري منDateYesYYYY-MM-DD2026-10-01'01/10/2026' (API) -> 'Send the date as YYYY-MM-DD.'
Effective to (API / close window)ساري حتىDateNoNot before Effective from. On an approved package it can only be shortenedBefore start -> 'The package cannot end before it starts.'; later than now set -> 'A window can be shortened, not extended.'
Legal source referenceالمرجع القانونيTextConditionalMax 500; required to approveFederal Decree-Law 33 of 2021 (test)Blank at approval -> 'An approved package needs a legal source reference.'
Net pay ledger accountحساب صافي الرواتبAccount codeConditionalMax 30; required to approve and to post2200Blank at approval -> 'Set the ledger account net pay is credited to.'
Part-month basisأساس الشهر الجزئيSelectYesCalendar days of the period / Fixed number of daysCalendar days of the periodFixed number of days(API) 'weeks' -> 'Choose calendar or fixed.'
Days in the basisعدد الأيامDecimalConditionalShown for Fixed; not negative; above 0 to approve30Fixed with 0 at approval -> 'A fixed day basis needs the number of days.'; -1 -> 'This cannot be below 0.'

Rule packages > New package / record (API)

FieldArabic labelTypeRequiredRules and limitsDefaultExampleRefused when
Rounding modeطريقة التقريبChoiceNohalf_up, half_even, down, uphalf_up'bankers' -> 'Choose a rounding mode from the list.'
Rounding placesمنازل التقريبWhole numberNo0 to 627 -> 'Use between 0 and 6 rounding places.'; 'two' -> 'Rounding places is a whole number.'
Variance limit %حد الفرقDecimalNoNot negative; net change above it raises a review exception10-1 -> 'This cannot be below 0.'
DEMO flagتجريبيةYes/NoNoMarks package, runs and journals '[DEMO RULES]'No

Rule package > Add element

FieldArabic labelTypeRequiredRules and limitsDefaultExampleRefused when
CodeالرمزTextYesMax 30, upper-cased, unique in the package; draft package onlyFOODExisting code -> 'This package already has an element with that code.'; approved package -> 'An approved package is immutable. Create a new version to change it.'
NameالاسمTextYesMax 120Food allowanceEmpty -> 'This is required.'
TypeالنوعSelectYesEarning / Deduction / Employer costEarning(API) 'bonus' -> 'Choose earning, deduction or employer cost.'
Ledger accountحساب الأستاذAccount codeConditionalMax 30; required to approve the package5210Blank at approval -> 'Element FOOD has no ledger account.'
Liability account (employer cost)حساب الالتزام (تكلفة صاحب العمل)Account codeConditionalRequired for Employer cost elements to approve2220Blank on an employer cost -> 'Employer cost DEMO_EMPLOYER needs a liability account.'
prorate / taxable / contributoryيتناسب / خاضع للضريبة / خاضع للاشتراكCheckboxesNoprorate = multiplied by the proration factor; taxable and contributory are flags only todayAll offprorate on

Rule package > Add element (API)

FieldArabic labelTypeRequiredRules and limitsDefaultExampleRefused when
SequenceالترتيبWhole numberNoOrder on the payslip100

Rule package > Add rule

FieldArabic labelTypeRequiredRules and limitsDefaultExampleRefused when
Element codeرمز العنصرTextYesUpper-cased; the element must already be in the packageFOOD'ABC' -> 'Add the pay element to the package first.'
CalculationالاحتسابSelectYesFixed amount / Percent of another element / Percent of gross so far / Approved hours x multiplier. Nothing else ('no free-form formula')Fixed amount(API) 'formula' -> 'Choose one of: fixed, percent_of_element, percent_of_gross, per_hour_multiplier. No other calculation is supported.'
OrderالترتيبWhole numberNoRules run in this order; a percent-of-element rule must come after the rule producing its base100Base produced later -> at approval 'Rule for X depends on Y, which a later rule produces: the order is not acyclic.'
AmountالمبلغDecimalConditionalFor Fixed; prorated if the element prorates300
PercentالنسبةDecimalConditionalFor percent kinds; not negative to approve2-5 at approval -> 'Rule for X has a negative percent.'
Base elementالعنصر الأساسTextConditionalFor Percent of another element; must exist and not be itselfBASICItself -> 'Rule for X refers to itself.'; missing -> 'Rule for X is a percent of Y, which is not a package element.'
MultiplierالمضاعفDecimalConditionalFor hours x multiplier; above 0 to approve1.250 -> 'Rule for OVERTIME needs a positive hours divisor and multiplier.'
Hours per month (divisor)ساعات الشهر (المقسوم عليه)DecimalConditionalHourly rate = overtime-eligible monthly pay / divisor; above 02400 -> same message
Cap / Floorالحد الأعلى / الحد الأدنىDecimalNoOptional; floor not above capcap 500Floor 600, cap 500 -> 'Rule for X has a floor above its cap.'; 'abc' -> 'Send the amount as a decimal string.'

Pay groups > New group

FieldArabic labelTypeRequiredRules and limitsDefaultExampleRefused when
CodeالرمزTextYesMax 30, upper-cased, unique in the companyMONTHLYExisting -> 'A pay group with this code exists.'
NameالاسمTextYesMax 120Monthly staffEmpty -> 'This is required.'
CurrencyالعملةTextNoMax 3, upper-cased; only contracts in this currency are paidAEDAED'DIRHAM' -> 'Keep this to 3 characters.'
Rule package codeرمز حزمة القواعدTextNoMax 30; not checked to existDEMO-AE

Pay groups > New group (API)

FieldArabic labelTypeRequiredRules and limitsDefaultExampleRefused when
FrequencyالتكرارChoiceNomonthly, biweekly, weekly; not on the dialogmonthly'daily' -> 'Choose monthly, biweekly or weekly.'
Arabic name / Activeالاسم العربي / نشطText / Yes-NoNoInactive group refuses new runsActive

Pay groups (API) > members

FieldArabic labelTypeRequiredRules and limitsDefaultExampleRefused when
Named membersالأعضاء المحددونEmployee listNoPUT .../groups/{id}/members; none = everyone on the roster in the group currencyAnother company's employee -> 'Some employees do not belong to this company.'

Pay periods > New period

FieldArabic labelTypeRequiredRules and limitsDefaultExampleRefused when
GroupالمجموعةSelectYesA pay group of this companyNone -> 'Choose a pay group.'
StartالبدايةDateYesNo overlap with another period of the group2026-10-01Overlap -> 'This overlaps period 2026-09 (2026-09-01 to 2026-09-30).'
EndالنهايةDateYesNot before Start2026-10-31Before start -> 'The period cannot end before it starts.'
Input cutoffإغلاق المدخلاتDateConditionalBlank = End date. Field setting 'Input cutoff date': Required / Hidden2026-10-25
Pay dateتاريخ الدفعDateNoBlank = End date; not before Start; is the payment value date2026-10-28Before start -> 'The pay date cannot precede the period.'

Pay periods > New period (API)

FieldArabic labelTypeRequiredRules and limitsDefaultExampleRefused when
Period codeرمز الفترةTextNoMax 20; blank = YYYY-MM of Start; unique in the group2026-10Duplicate -> 'This group already has a period with that code.'

Settlement policy record

FieldArabic labelTypeRequiredRules and limitsDefaultExampleRefused when
CodeالرمزTextYesMax 30, upper-cased; existing code = next versionAE-SETTLE
NameالاسمTextYesMax 160UAE settlement policyEmpty -> 'This is required.'
Arabic nameالاسم بالعربيةTextConditionalMax 160. Field setting 'Settlement policy Arabic name': Required / Hiddenسياسة التسوية الإماراتية
Rule package codeرمز حزمة القواعدTextConditionalMax 30; required to approveBlank at approval -> 'Name the rule package family that prices its components.'
Legal source referenceالمرجع القانونيTextConditionalMax 500; required to approveBlank -> 'An approved policy needs a legal source reference.'
Effective from / Effective toساري من / ساري حتىDateYes / NoEnd not before start; two approved policies for one category may not overlap (a newer version of the same code supersedes the older)Today (company date)End before start -> 'The policy cannot end before it starts.'; overlap -> 'Policy X v1 already covers resignation over these dates. Two policies for one category cannot overlap.'
DEMO policyسياسة تجريبيةSwitchNoOff
Termination categoriesفئات الإنهاءTagsConditionalClosed list: Resignation, Dismissal, Mutual agreement, End of contract, Probation not confirmed, Redundancy, Retirement, Death in service, Absconding, Transfer out, Other; at least one to approveResignation(API) 'fired' -> 'Unknown termination reason: fired.'; none -> 'Choose at least one termination category.'
Recovery cap percent (blank: no cap)نسبة سقف الاستردادDecimalNo0 to 10050120 -> 'A share cannot exceed 100.'
Recovery priorityأولوية الاستردادOrdered listNoloan, advance, expense claim, travel advance, asset; each onceLoan, Advance, Expense claim, Travel advance, Asset(API) duplicate -> 'Priority is a list of: loan, advance, expense_claim, travel_advance, asset, each once.'
Correction period (days after posting)مدة التصحيحWhole numberNoNot negative; 0 = no limit30-1 -> 'Correction period cannot be negative.'; '1.5' -> 'Correction period is a whole number of days.'
Always require specialist reviewمراجعة المختص دائماًSwitchNoOn: approval needs the specialist sign-off even with nothing not-configured

Settlement policy > Components

FieldArabic labelTypeRequiredRules and limitsDefaultExampleRefused when
Component keyمفتاح المكوّنTextYesLower-case letters, digits, underscores, starts with a letter, max 40; unique. Standard: unpaid_salary, leave_encashment, end_of_service, notice_payend_of_service'End Service' -> 'A component key is lower-case letters, digits and underscores.'; twice -> 'The component end_of_service appears twice.'
Label / Arabic labelالوصف / الوصف بالعربيةTextNoMax 120; standard keys get default labels
Pay elementعنصر الأجرTextConditionalRequired for every component except unpaid_salary; max 30END_OF_SERVICEBlank -> 'Component end_of_service needs a pay element code.'
Quantity fromالكمية منSelectYesOne unit / Leave days / Service days / Completed months / Completed yearsleave_encashment: Leave days; end_of_service: Completed years; others: One unit(API) 'weeks' -> 'Choose one of: none, leave_days, service_days, service_months, service_years, ae_gratuity_days.'
Base elementsعناصر الأساسCodesNoContract elements summed as the monthly baseBASIC
Leave typesأنواع الإجازةCodesNoLeave types whose balance is encashed; blank = allANNUAL
Min. service daysالحد الأدنى لأيام الخدمةWhole numberNoNot negative; below it the component pays nothing0365-1 -> 'Minimum service days cannot be negative.'; 'one' -> 'Minimum service days is a whole number.'

Payroll app configuration > Fields

FieldArabic labelTypeRequiredRules and limitsDefaultExampleRefused when
Pay input source referenceمرجع مصدر مدخل الراتبField rule-Required: a manual input needs its source reference. Hidden: not shown, the system makes one, and one sent is refused
Input cutoff dateتاريخ إغلاق المدخلاتField rule-Required: a period needs its cutoff date. Hidden: not shown, cutoff = period's last day, a date sent is refused
Settlement policy Arabic nameالاسم العربي لسياسة التسويةField rule-Required: a policy is not saved without it. Hidden: not shown; a name sent on create or change is refused. Belongs to the Final settlements feature