Requirements
Connecting ZenHR takes an active account plus OAuth client credentials, granted by signing in with your account — no other setup is required.[3]
Get your ZenHR credentials
You’ll be redirected to sign in and approve access — your password is never shared with WEXTL.
- Client IDtextRequired
Log inot ZenHR → Appliaction → Click on New Application, fill the details and copy your UID (Client ID).
[1] - Client SecretpasswordRequired
Log inot ZenHR → Appliaction → Click on New Application, fill the details and copy your Client Secret.
[1]
Integration requests 179 permissions:
read:attendance_recordcurrencies:exchange_rateconversion_details:exchange_ratecreate:attendance_detailbulk_insert:attendance_detailqr_clocking:attendance_detaildestroy:provision_historyread:integration_mapcreate:integration_mapupdate:integration_mapread:work_locationread:branchcreate:branchupdate:branchdestroy:branchread:termination_setupcreate:termination_setupupdate:termination_setupdestroy:termination_setupread:terminationcreate:terminationdestroy:terminationread:employeecreate:employeeupdate:employeeaccessed_employees_branches:employeeread_company_employees:employeeread:financial_infocreate:financial_infoupdate:financial_infodestroy:financial_inforead:overtime_requestcreate:overtime_requestread:overtimecreate:overtimeupdate:overtimedestroy:overtimeread:financial_transaction_requestcreate:financial_transaction_requestread:governmental_informationread:loancreate:loanupdate:loandestroy:loanread:loan_requestcreate:loan_requestread:countryread:familycreate:familyupdate:familydestroy:familyread:timeoff_transaction_requestcreate:timeoff_transaction_requestread:timeoff_transactioncreate:timeoff_transactionread:vacation_resumption_transactioncreate:vacation_resumption_transactionupdate:vacation_resumption_transactionread:financial_transactioncreate:financial_transactionupdate:financial_transactiondestroy:financial_transactiongrouped_financial_transaction_types_options:financial_transactionread:hr_letterread:professional_infocreate:professional_infoupdate:professional_infodestroy:professional_inforead:timeoffgrouped_timeoffs_options:timeoffread:employee_shiftcreate:employee_shiftupdate:employee_shiftdestroy:employee_shiftread:work_shiftcreate:work_shiftupdate:work_shiftdestroy:work_shiftread:overtime_typecreate:overtime_typeupdate:overtime_typedestroy:overtime_typeread:loan_typecreate:loan_typeupdate:loan_typedestroy:loan_typeread:miscellaneous_requestread:bank_accountcreate:bank_accountread:bankread:bank_branchread:branch_bank_accountread:miscellaneous_typecreate:miscellaneous_typeupdate:miscellaneous_typedestroy:miscellaneous_typeread:missing_punchcreate:missing_punchupdate:missing_punchdestroy:missing_punchread:recurring_transactioncreate:recurring_transactionupdate:recurring_transactiondestroy:recurring_transactionread:request_eventread:competenciescreate:competenciesupdate:competenciesdestroy:competenciesread:airticket_policyread:employee_airticket_balanceread:airticket_transactioncreate:airticket_transactionupdate:airticket_transactiondestroy:airticket_transactionread:documentcreate:documentupdate:documentdestroy:documentread:document_typecreate:document_typeupdate:document_typedestroy:document_typeread:asset_typecreate:asset_typeupdate:asset_typedestroy:asset_typeread:assetcreate:assetupdate:assetdestroy:assetread:self_onboardingread:attendance_transactionread:asset_assignmentcreate:asset_assignmentupdate:asset_assignmentdestroy:asset_assignmenttake_asset:asset_assignmentread:approval_templatecreate:approval_templateupdate:approval_templatedestroy:approval_templateread:employee_airticketsread:asset_activityread:organization_levelread:taskcreate:taskupdate:taskdestroy:tasktask_across_branches:taskread:boarding_templatecreate:boarding_templateupdate:boarding_templatedestroy:boarding_templateread:boardingcreate:boardingupdate:boardingread:password_setupread:positionread:encashmentcreate:encashmentdestroy:encashmentread:business_travel_setupupdate:business_travel_setupread:business_travel_policycreate:business_travel_policyupdate:business_travel_policydestroy:business_travel_policyread:business_tripcreate:business_tripupdate:business_tripdestroy:business_tripread:stbread:time_sheetcreate:time_sheetupdate:time_sheetdestroy:time_sheetread:approvalread:salary_slip_template
Connect ZenHR in WEXTL
- Log in to your WEXTL account, add the ZenHR node module to your workflow, and click Create new credential.
- Optional: In the Credential name field, enter a name for the credential.
- Enter the authentication credentials you copied from your ZenHR account, or follow the on-screen instructions to create the credential.
- If prompted, authenticate your account and confirm access.
- If you want to make changes to your credential in the future, follow the steps in Manage credentials →
Notes
Credentials are org-scoped; share them with teammates from the Credentials picker on any of its nodes.For detailed information on connecting an application, see Connect an application →
ZenHR node modules
The list below is a reference of every ZenHR node module the integration supports. You will be able to pick any of them on the workflow canvas while building automations.
Expand any ZenHR node module below to see exactly what it takes in, what it returns, and what connection it needs.
Watch Branch DocumentsTrigger
Output fields[3]
| Field | Type |
|---|---|
| ID | number |
| Name | text |
| Created at | date |
| Expiry date | date |
| Created by | text |
| Admin only | boolean |
| Document type | object |
| ID | number |
| Name | text |
| Owner | object |
| ID | number |
| Name | text |
| Type | text |
| Attachments | array |
Watch Branch EmployeesTrigger
Output fields[3]
| Field | Type |
|---|---|
| ID | number |
| Branch ID | number |
| Employment number | text |
| Username | text |
| User | object |
| ID | number |
| Short name | object |
| Name | object |
| Picture | object |
| Birthdate | date |
| Hiring date | date |
| Fixing date | date |
26other output fields
Watch Branch TerminationsTrigger
Output fields[3]
| Field | Type |
|---|---|
| ID | number |
| Employee | object |
| Employee ID | number |
| Termination setup | object |
| Termination setup ID | number |
| Termination date | date |
| Financial transaction ids | text |
| Notes | text |
| Salary ID | number |
| Created at | date |
| Updated at | date |
Watch BranchesTrigger
Output fields[3]
| Field | Type |
|---|---|
| ID | number |
| Name | object |
| Ar | text |
| En | text |
| Probation period | object |
| Type | text |
| Period | text |
| Working hours | number |
| Cut off date | number |
| Working days | number |
| Days off | array |
| Location | text |
| Timezone | text |
10other output fields
Watch Branches WorkShiftsTrigger
Output fields[3]
| Field | Type |
|---|---|
| ID | number |
| Name | text |
| Color | text |
| Type | text |
| Flex leave after | number |
| Overtime after | number |
| Morning leave after | number |
| Early out leave before | number |
| Interval margin percentage | number |
7other output fields
Watch Employee ApprovalsTrigger
Output fields[3]
| Field | Type |
|---|---|
| ID | number |
| Branch ID | number |
| Employment number | text |
| Name | object |
| En | object |
| Ar | object |
| Birthdate | date |
| Hiring date | date |
| Fixing date | date |
| Termination date | date |
21other output fields
Watch Employee Bank AccountsTrigger
Output fields[3]
| Field | Type |
|---|---|
| ID | number |
| Owner ID | number |
| Owner type | text |
| Bank branch | object |
| Bank branch ID | number |
| ID | number |
| Bank | object |
| Swift code | text |
| Name | object |
| Iban | text |
| Bank account number | text |
| Percent transfer | number |
| Related establishment number | text |
| Swift code | text |
1other output field
Watch Employee CompetenciesTrigger
Output fields[3]
| Field | Type |
|---|---|
| ID | number |
| Branch ID | number |
| Employment number | text |
| Name | object |
| En | object |
| Ar | object |
| Birthdate | date |
| Hiring date | date |
| Fixing date | date |
| Termination date | date |
21other output fields
Watch Employee FamiliesTrigger
Output fields[3]
| Field | Type |
|---|---|
| ID | number |
| Employee | object |
| ID | number |
| Relation | text |
| Name | object |
| En | object |
| Ar | object |
| Birthdate | date |
| Relation date | date |
| Gender | text |
| Marital status | text |
| Phone number | text |
8other output fields
Watch Employee Financial DataTrigger
Output fields[3]
| Field | Type |
|---|---|
| ID | number |
| Employee | object |
| ID | number |
| Payment method | text |
| Resident | boolean |
| Taxable | boolean |
| Salary count | number |
| Personal exemption | boolean |
| Family exemption | boolean |
| Other exemption | object |
| Amount | number |
| Currency | text |
9other output fields
Watch Employee Financial TransactionsTrigger
Output fields[3]
| Field | Type |
|---|---|
| ID | number |
| Financial transaction type | object |
| ID | number |
| Employee | object |
| ID | number |
| Transaction status | text |
| Direction | text |
| Out of payroll | boolean |
| Amount | object |
| Amount | number |
| Currency | text |
| Notes | text |
| Effective date | date |
5other output fields
Watch Employee LoanTrigger
Output fields[3]
| Field | Type |
|---|---|
| ID | number |
| Employee | object |
| Employee ID | number |
| Amount fils | number |
| Amount currency | text |
| Effective date | date |
| Number of payments | number |
| Name | object |
| Ar | text |
| En | text |
| Loan type | object |
| Loan type ID | number |
| Cancel requested on | date |
7other output fields
Watch Employee OvertimeTrigger
Output fields[3]
| Field | Type |
|---|---|
| ID | number |
| Employee | object |
| ID | number |
| Overtime type | object |
| ID | number |
| From | date |
| To | date |
| Amount fils | number |
| Amount currency | text |
| Status | number |
| Effective date | date |
9other output fields
Watch Employee Professional DataTrigger
Output fields[3]
| Field | Type |
|---|---|
| ID | number |
| Employee ID | number |
| Employment number | text |
| Effective on | date |
| Expires on | date |
| Manager | object |
| ID | number |
| Name | text |
| Position | object |
| ID | number |
| Name | text |
| Site | object |
| ID | number |
| Name | text |
| Department | object |
| ID | number |
| Name | text |
3other output fields
Watch Employee ShiftsTrigger
Output fields[3]
| Field | Type |
|---|---|
| ID | number |
| Employee | object |
| ID | number |
| Work shift | object |
| ID | number |
| From date | date |
| To date | date |
Watch Employee TimeOff TransactionsTrigger
Output fields[3]
| Field | Type |
|---|---|
| ID | number |
| Employee | object |
| ID | number |
| Timeoff | object |
| ID | number |
| From date | date |
| To date | date |
| Amount | number |
| Notes | text |
| Status | text |
| Class name | text |
7other output fields
Watch Employees Miscellaneous RequestsTrigger
Output fields[3]
| Field | Type |
|---|---|
| ID | number |
| Employee | object |
| ID | number |
| Miscellaneous type | object |
| ID | number |
| Notes | text |
| Effective date | date |
| Status | number |
| Cancel requested on | date |
| Created at | date |
| Updated at | date |
Watch OvertimesTrigger
Output fields[3]
| Field | Type |
|---|---|
| ID | number |
| Employee | object |
| ID | number |
| Overtime type | object |
| ID | number |
| From | date |
| To | date |
| Amount fils | number |
| Amount currency | text |
| Status | number |
| Effective date | text |
9other output fields
Watch PositionsTrigger
Output fields[3]
| Field | Type |
|---|---|
| ID | number |
| Name | object |
| Ar | text |
| En | text |
| Job description | text |
| Position type | text |
| Created at | date |
| Updated at | date |
Watch TimeOffsTrigger
Output fields[3]
| Field | Type |
|---|---|
| ID | number |
| Name | object |
| Ar | text |
| En | text |
| Branch | object |
| ID | number |
| Cut holidays | boolean |
| Cut days off | boolean |
| Exceed balance | boolean |
| Accumulative | boolean |
| Class name | text |
| Deduction type | number |
19other output fields
Get a BranchAction
Get a Branch TerminationAction
Get a Branch Work ShiftAction
Get a DocumentAction
Get a Financial Transaction TypeAction
Get a Loan by Global IDAction
Get a PositionAction
Get a Recurring TransactionAction
Get a TimeoffAction
Get a UserAction
Input fields[3]
| Field | Type |
|---|---|
User IDRequired | choice |
Get an EmployeeAction
Get an Employee ApprovalAction
Get an Employee by GL IDAction
Get an Employee LoanAction
Input fields[3]
| Field | Type |
|---|---|
Branch IDRequired | choice |
| Include | choice |
Output fields[3]
| Field | Type |
|---|---|
| ID | number |
| Employee | object |
| Employee ID | number |
| Amount fils | number |
| Amount currency | text |
| Effective date | date |
| Number of payments | number |
| Name | object |
| Ar | text |
| En | text |
| Loan type | object |
| Loan type ID | number |
| Cancel requested on | date |
7other output fields
Get an Employee Timeoff TransactionAction
Get Employee Active Financial DataAction
Get Employee Active Professional DataAction
Get Employee CompetencyAction
Get Employee FamilyAction
Get Employee Financial TransactionsAction
Get Employee Miscellaneous RequestsAction
Get Employee OvertimeAction
Get Employee ShiftsAction
Get Financial TransactionsAction
Input fields[3]
| Field | Type |
|---|---|
Branch IDRequired | choice |
Global IDRequired | text |
Output fields[3]
| Field | Type |
|---|---|
| ID | number |
| Financial transaction type | object |
| ID | number |
| Employee | object |
| ID | number |
| Transaction status | text |
| Direction | text |
| Out of payroll | boolean |
| Amount | object |
| Amount | number |
| Currency | text |
| Notes | text |
| Effective date | date |
5other output fields
Get Loan TypesAction
Get OvertimeAction
Get Overtime by Global IDAction
Get Overtime TypeAction
List Branch DocumentsSearch
Input fields[3]
| Field | Type |
|---|---|
Branch IDRequired | choice |
| Owner ID | choice |
| Owner Type | text |
| Status | text |
| Professional Datum | object |
| Limit | number |
Output fields[3]
| Field | Type |
|---|---|
| ID | number |
| Name | text |
| Created at | date |
| Expiry date | date |
| Created by | text |
| Admin only | boolean |
| Document type | object |
| ID | number |
| Name | text |
| Owner | object |
| ID | number |
| Name | text |
| Type | text |
| Attachments | array |
List Branch EmployeesSearch
Input fields[3]
| Field | Type |
|---|---|
Branch IDRequired | choice |
Created At FromRequired | date |
Created At ToRequired | date |
Updated At FromRequired | date |
Updated At ToRequired | date |
Birthdate FromRequired | date |
Birthdate ToRequired | date |
Hiring Date FromRequired | date |
Hiring Date ToRequired | date |
7other input fields
Output fields[3]
| Field | Type |
|---|---|
| ID | number |
| Branch ID | number |
| Employment number | text |
| Username | text |
| User | object |
| ID | number |
| Short name | object |
| Name | object |
| Picture | object |
| Birthdate | date |
| Hiring date | date |
| Fixing date | date |
26other output fields
List Branch SalariesSearch
Input fields[3]
| Field | Type |
|---|---|
Branch IDRequired | choice |
| Include Fields | array |
| Filter ID | array |
| ID | number |
| Filter Employee ID | array |
| Employee ID | number |
| Filter Month | array |
| Month | number |
| Filter Year | array |
| Year | number |
| Created At From | date |
| Created At To | date |
| Updated At From | date |
3other input fields
Output fields[3]
| Field | Type |
|---|---|
| ID | number |
| Employee | object |
| ID | number |
| Professional datum | object |
| ID | text |
| Financial datum | object |
| ID | number |
| Days worked | number |
| Month | number |
| Year | number |
| From date | date |
| To date | date |
18other output fields
List Branch TerminationsSearch
List Branch Work ShiftsSearch
Input fields[3]
| Field | Type |
|---|---|
Branch IDRequired | choice |
| Order | array |
| From Time | array |
| To Time | array |
| Include | choice |
| Limit | number |
Output fields[3]
| Field | Type |
|---|---|
| ID | number |
| Name | text |
| Color | text |
| Type | text |
| Flex leave after | number |
| Overtime after | number |
| Morning leave after | number |
| Early out leave before | number |
| Interval margin percentage | number |
7other output fields
List BranchesSearch
Input fields[3]
| Field | Type |
|---|---|
Filter by IDRequired | choice |
| Filter by Working Hours | array |
| Working Hours | number |
| Filter by Cut-off Date | array |
| Cut-off Date | number |
| Filter by Working Days | array |
| Working Days | number |
| Filter by Timezone | array |
| Timezone | time |
| Filter by Currency | array |
| Currency | text |
| Filter by Country ID | array |
| Country ID | number |
| Filter by Week Start Day | array |
| Week Start Day | number |
| Filter by Fiscal Day | array |
| Fiscal Day | number |
10other input fields
Output fields[3]
| Field | Type |
|---|---|
| ID | number |
| Name | object |
| Ar | text |
| En | text |
| Probation period | object |
| Type | text |
| Period | text |
| Working hours | number |
| Cut off date | number |
| Working days | number |
| Days off | array |
| Location | text |
| Timezone | text |
10other output fields
List Employee ApprovalsSearch
Input fields[3]
| Field | Type |
|---|---|
| Branch ID | choice |
| Filter by Created At (To) | date |
| Filter by Action Time (From) | date |
| Approvable Type | choice |
| Filter Created At (Exact) | date |
| Order | choice |
| Limit | number |
Output fields[3]
| Field | Type |
|---|---|
| ID | number |
| Branch ID | number |
| Employment number | text |
| Name | object |
| En | object |
| Ar | object |
| Birthdate | date |
| Hiring date | date |
| Fixing date | date |
| Termination date | date |
21other output fields
List Employee Bank AccountsSearch
Input fields[3]
| Field | Type |
|---|---|
Branch IDRequired | choice |
| Limit | number |
Output fields[3]
| Field | Type |
|---|---|
| ID | number |
| Owner ID | number |
| Owner type | text |
| Bank branch | object |
| Bank branch ID | number |
| ID | number |
| Bank | object |
| Swift code | text |
| Name | object |
| Iban | text |
| Bank account number | text |
| Percent transfer | number |
| Related establishment number | text |
| Swift code | text |
1other output field
List Employee CompetenciesSearch
Input fields[3]
| Field | Type |
|---|---|
Branch IDRequired | choice |
| Required Level | array |
| Required Level | number |
| Achieved Level | array |
| Achieved Level | number |
| Include | choice |
| Created At From | date |
| Created At To | date |
| Updated At From | date |
| Updated At To | date |
| Order | array |
1other input field
Output fields[3]
| Field | Type |
|---|---|
| ID | number |
| Competency | object |
| ID | number |
| Competencies category | object |
| Employee | object |
| ID | number |
| Required level | number |
| Achieved level | number |
| Created at | date |
| Updated at | date |
List Employee FamiliesSearch
List Employee Financial DataSearch
Input fields[3]
| Field | Type |
|---|---|
Branch IDRequired | choice |
| Filter Family Exemption | array |
| Family Exemption | boolean |
| Filter Personal Exemption | array |
| Personal Exemption | boolean |
| Filter Taxable | array |
| Taxable | boolean |
| Filter Salary Count | array |
| Salary Count | number |
| Filter Resident | array |
| Resident | boolean |
| Filter Other Exemption | array |
| Other Exemption | number |
| Filter Status | array |
| Status | choice |
| Effective On From | date |
11other input fields
Output fields[3]
| Field | Type |
|---|---|
| ID | number |
| Employee | object |
| ID | number |
| Payment method | text |
| Resident | boolean |
| Taxable | boolean |
| Salary count | number |
| Personal exemption | boolean |
| Family exemption | boolean |
| Other exemption | object |
| Amount | number |
| Currency | text |
9other output fields
List Employee Financial TransactionsSearch
Input fields[3]
| Field | Type |
|---|---|
Branch IDRequired | choice |
| Created At From | date |
| Created At To | date |
| Updated At From | date |
| Updated At To | date |
| Effective Date From | date |
| Effective Date To | date |
| Include | choice |
| Limit | number |
Output fields[3]
| Field | Type |
|---|---|
| ID | number |
| Financial transaction type | object |
| ID | number |
| Employee | object |
| ID | number |
| Transaction status | text |
| Direction | text |
| Out of payroll | boolean |
| Amount | object |
| Amount | number |
| Currency | text |
| Notes | text |
| Effective date | date |
5other output fields
List Employee LoansSearch
Input fields[3]
| Field | Type |
|---|---|
Branch IDRequired | choice |
| Include | choice |
| Integration Map Global ID Filter | text |
| Limit | number |
Output fields[3]
| Field | Type |
|---|---|
| ID | number |
| Employee | object |
| Employee ID | number |
| Amount fils | number |
| Amount currency | text |
| Effective date | date |
| Number of payments | number |
| Name | object |
| Ar | text |
| En | text |
| Loan type | object |
| Loan type ID | number |
| Cancel requested on | date |
7other output fields
List Employee OvertimesSearch
List Employee Professional DataSearch
Input fields[3]
| Field | Type |
|---|---|
Branch IDRequired | choice |
| Created At From | date |
| Created At To | date |
| Updated At From | date |
| Updated At To | date |
| Order | array |
| Limit | number |
Output fields[3]
| Field | Type |
|---|---|
| ID | number |
| Employee ID | number |
| Employment number | text |
| Effective on | date |
| Expires on | date |
| Manager | object |
| ID | number |
| Name | text |
| Position | object |
| ID | number |
| Name | text |
| Site | object |
| ID | number |
| Name | text |
| Department | object |
| ID | number |
| Name | text |
3other output fields
List Employee ShiftsSearch
List Employee Timeoff TransactionsSearch
Input fields[3]
| Field | Type |
|---|---|
Branch IDRequired | choice |
| Filter by Amount | array |
| Amount | number |
| Created At From | date |
| Created At To | date |
| Updated At From | date |
| Updated At To | date |
| From Date From | date |
| From Date To | date |
| To Date From | date |
8other input fields
Output fields[3]
| Field | Type |
|---|---|
| ID | number |
| Employee | object |
| ID | number |
| Timeoff | object |
| ID | number |
| From date | date |
| To date | date |
| Amount | number |
| Notes | text |
| Status | text |
| Class name | text |
7other output fields
List Employees' Miscellaneous RequestsSearch
Input fields[3]
| Field | Type |
|---|---|
Branch IDRequired | choice |
| Effective Date From | date |
| Effective Date To | date |
| Created At From | date |
| Created At To | date |
IncludeRequired | choice |
| Related Entity | choice |
| Order | choice |
| Limit | number |
Output fields[3]
| Field | Type |
|---|---|
| ID | number |
| Employee | object |
| ID | number |
| Miscellaneous type | object |
| ID | number |
| Notes | text |
| Effective date | date |
| Status | number |
| Cancel requested on | date |
| Created at | date |
| Updated at | date |
List OvertimeSearch
Input fields[3]
| Field | Type |
|---|---|
Branch IDRequired | choice |
| include | text |
| Employee Integration Maps | text |
| Employee Integration Maps Global ID | text |
| Limit | number |
Output fields[3]
| Field | Type |
|---|---|
| ID | number |
| Employee | object |
| ID | number |
| Overtime type | object |
| ID | number |
| From | date |
| To | date |
| Amount fils | number |
| Amount currency | text |
| Status | number |
| Effective date | text |
9other output fields
List PositionsSearch
Input fields[3]
| Field | Type |
|---|---|
Branch IDRequired | choice |
| Filter Position Type | choice |
| Filter Created At From | date |
| Filter Created At To | date |
| Filter Updated At From | date |
| Filter Updated At To | date |
| Order | array |
| Limit | number |
Output fields[3]
| Field | Type |
|---|---|
| ID | number |
| Name | object |
| Ar | text |
| En | text |
| Job description | text |
| Position type | text |
| Created at | date |
| Updated at | date |
List Recurring TransactionsSearch
Input fields[3]
| Field | Type |
|---|---|
Branch IDRequired | choice |
| Start Date From | date |
| Start Date To | date |
| End Date From | date |
| End Date To | date |
| Financial Transaction Type ID | text |
| Include | choice |
| Order | array |
| Limit | number |
Output fields[3]
| Field | Type |
|---|---|
| ID | number |
| Financial treansaction type | object |
| ID | number |
| Start date | date |
| End date | date |
| Amount | number |
| Branch currency amounts | object |
| Amount | text |
| Currency | text |
List TimeoffsSearch
Input fields[3]
| Field | Type |
|---|---|
Branch IDRequired | choice |
| Created At From | date |
| Created At To | date |
| Updated At From | date |
| Updated At To | date |
| Order | choice |
| Limit | number |
| Include | choice |
Output fields[3]
| Field | Type |
|---|---|
| ID | number |
| Name | object |
| Ar | text |
| En | text |
| Branch | object |
| ID | number |
| Cut holidays | boolean |
| Cut days off | boolean |
| Exceed balance | boolean |
| Accumulative | boolean |
| Class name | text |
| Deduction type | number |
19other output fields
List UsersSearch
Input fields[3]
| Field | Type |
|---|---|
Include DataRequired | array |
| Data Type | choice |
Filter CriteriaRequired | object |
Employee IDRequired | choice |
Branch IDRequired | array |
| Order | array |
| Limit | number |
Create a Branch Work ShiftAction
Input fields[3]
| Field | Type |
|---|---|
Branch IDRequired | choice |
Work Shift TypeRequired | choice |
Morning Leave AfterRequired | number |
Early Out Leave BeforeRequired | number |
Overtime AfterRequired | number |
Interval Margin PercentageRequired | number |
ColorRequired | text |
Exclude TransactionRequired | boolean |
Flex Leave AfterRequired | number |
7other input fields
Output fields[3]
| Field | Type |
|---|---|
| ID | number |
| Name | object |
| Ar | text |
| En | text |
| Branch | object |
| ID | number |
| Cut holidays | boolean |
| Cut days off | boolean |
| Exceed balance | boolean |
| Accumulative | boolean |
| Class name | text |
| Deduction type | number |
19other output fields
Create a DocumentAction
Create a PositionAction
Create a Recurring TransactionAction
Input fields[3]
| Field | Type |
|---|---|
Branch IDRequired | choice |
Financial Transaction Type IDRequired | number |
Start DateRequired | date |
End DateRequired | date |
AmountRequired | number |
Output fields[3]
| Field | Type |
|---|---|
| ID | number |
| Employee | object |
| ID | number |
| Payment method | text |
| Resident | boolean |
| Taxable | boolean |
| Salary count | number |
| Personal exemption | boolean |
| Family exemption | boolean |
| Other exemption | object |
| Amount | number |
| Currency | text |
9other output fields
Create a TerminationAction
Create a Timeoff Transaction RequestAction
Create a UserAction
Input fields[3]
| Field | Type |
|---|---|
EmailRequired | |
UsernameRequired | |
ProviderRequired | text |
| Name | object |
| English Name | object |
| Arabic Name | object |
| Is Support | boolean |
User IDRequired | text |
| Impersonation | boolean |
Create an EmployeeAction
Input fields[3]
| Field | Type |
|---|---|
Branch IDRequired | choice |
National IDRequired | text |
Personal EmailRequired | |
Labour CardRequired | text |
Labour Card ExpiryRequired | date |
Mobile NumberRequired | text |
Payment MethodRequired | text |
| Hiring Date | date |
| Gender | text |
32other input fields
Output fields[3]
| Field | Type |
|---|---|
| ID | number |
| Branch ID | number |
| Employment number | text |
| Username | text |
| User | object |
| ID | number |
| Short name | object |
| Name | object |
| Picture | object |
| Birthdate | date |
| Hiring date | date |
| Fixing date | date |
26other output fields
Create an Employee FamilyAction
Input fields[3]
| Field | Type |
|---|---|
Branch IDRequired | choice |
RelationRequired | choice |
BirthdateRequired | date |
| Name (English) | object |
First NameRequired | text |
| Second Name | text |
| Third Name | text |
| Last Name | text |
| Name (Arabic) | object |
First NameRequired | text |
| Second Name | text |
| Third Name | text |
| Last Name | text |
| Marital Status | choice |
| Phone Number | text |
| Gender | choice |
| Name | text |
6other input fields
Output fields[3]
| Field | Type |
|---|---|
| ID | number |
| Employee | object |
| ID | number |
| Relation | text |
| Name | object |
| En | object |
| Ar | object |
| Birthdate | date |
| Relation date | date |
| Gender | text |
| Marital status | text |
| Phone number | text |
8other output fields
Create an Employee Financial TransactionAction
Input fields[3]
| Field | Type |
|---|---|
Branch IDRequired | choice |
Financial Transaction Type IDRequired | number |
Amount FilsRequired | number |
Amount CurrencyRequired | text |
Effective DateRequired | date |
Due DateRequired | date |
| Notes | text |
| Cancel Requested | boolean |
| Paid Cash | boolean |
11other input fields
Output fields[3]
| Field | Type |
|---|---|
| ID | number |
| Financial transaction type | object |
| ID | number |
| Employee | object |
| ID | number |
| Transaction status | text |
| Direction | text |
| Out of payroll | boolean |
| Amount | object |
| Amount | number |
| Currency | text |
| Notes | text |
| Effective date | date |
5other output fields
Create an Employee LoanAction
Input fields[3]
| Field | Type |
|---|---|
Branch IDRequired | choice |
StatusRequired | number |
Amount (Fils)Required | number |
Amount CurrencyRequired | text |
Effective DateRequired | date |
Number of PaymentsRequired | number |
| Name | object |
Arabic NameRequired | text |
English NameRequired | text |
Instalment (Fils)Required | number |
Instalment CurrencyRequired | text |
5other input fields
Output fields[3]
| Field | Type |
|---|---|
| ID | number |
| Employee | object |
| Employee ID | number |
| Amount fils | number |
| Amount currency | text |
| Effective date | date |
| Number of payments | number |
| Name | object |
| Ar | text |
| En | text |
| Loan type | object |
| Loan type ID | number |
| Cancel requested on | date |
7other output fields
Create an Employee Loan RequestAction
Input fields[3]
| Field | Type |
|---|---|
Branch IDRequired | choice |
StatusRequired | number |
Amount (Fils)Required | number |
Amount CurrencyRequired | text |
Effective DateRequired | date |
Number of PaymentsRequired | number |
| Name | object |
Arabic NameRequired | text |
English NameRequired | text |
Instalment (Fils)Required | number |
Instalment CurrencyRequired | text |
5other input fields
Create an Employee Miscellaneous RequestAction
Create an Employee Overtime RequestAction
Input fields[3]
| Field | Type |
|---|---|
Branch IDRequired | choice |
FromRequired | date |
ToRequired | date |
Amount FilsRequired | number |
Amount CurrencyRequired | text |
StatusRequired | number |
| Effective Date | date |
| Duration | number |
| Cancel Requested On | text |
4other input fields
Create an Employee ShiftAction
Create an Employee TerminationAction
Create Employee CompetencyAction
Create Employee Financial DataAction
Input fields[3]
| Field | Type |
|---|---|
Branch IDRequired | choice |
SS Participation DateRequired | date |
Family ExemptionRequired | boolean |
Personal ExemptionRequired | boolean |
TaxableRequired | boolean |
Salary CountRequired | number |
Basic Salary FilsRequired | number |
Basic Salary CurrencyRequired | text |
SS Salary FilsRequired | number |
11other input fields
Output fields[3]
| Field | Type |
|---|---|
| ID | number |
| Employee | object |
| ID | number |
| Payment method | text |
| Resident | boolean |
| Taxable | boolean |
| Salary count | number |
| Personal exemption | boolean |
| Family exemption | boolean |
| Other exemption | object |
| Amount | number |
| Currency | text |
9other output fields
Create Employee Financial Transaction RequestsAction
Input fields[3]
| Field | Type |
|---|---|
Branch IDRequired | choice |
Financial Transaction Type IDRequired | number |
Amount FilsRequired | number |
Amount CurrencyRequired | text |
Effective DateRequired | date |
Due DateRequired | date |
| Notes | text |
| Cancel Requested | boolean |
| Paid Cash | boolean |
11other input fields
Create Employee OvertimeAction
Input fields[3]
| Field | Type |
|---|---|
Branch IDRequired | choice |
FromRequired | date |
ToRequired | date |
Amount FilsRequired | number |
Amount CurrencyRequired | text |
StatusRequired | number |
| Effective Date | date |
| Duration | number |
| Cancel Requested On | text |
4other input fields
Output fields[3]
| Field | Type |
|---|---|
| ID | number |
| Employee | object |
| ID | number |
| Overtime type | object |
| ID | number |
| From | date |
| To | date |
| Amount fils | number |
| Amount currency | text |
| Status | number |
| Effective date | date |
9other output fields
Create Employee Professional DataAction
Create OvertimeAction
Input fields[3]
| Field | Type |
|---|---|
Branch IDRequired | choice |
From DateRequired | date |
To DateRequired | date |
Amount FilsRequired | number |
Amount CurrencyRequired | text |
StatusRequired | number |
Effective DateRequired | date |
DurationRequired | number |
| Cancel Requested On | date |
4other input fields
Output fields[3]
| Field | Type |
|---|---|
| ID | number |
| Employee | object |
| ID | number |
| Overtime type | object |
| ID | number |
| From | date |
| To | date |
| Amount fils | number |
| Amount currency | text |
| Status | number |
| Effective date | text |
9other output fields
Delete a Branch Work ShiftAction
Input fields[3]
| Field | Type |
|---|---|
Branch IDRequired | choice |
Delete a DocumentAction
Input fields[3]
| Field | Type |
|---|---|
Branch IDRequired | choice |
Delete a Recurring TransactionAction
Input fields[3]
| Field | Type |
|---|---|
Branch IDRequired | choice |
Delete a TerminationAction
Input fields[3]
| Field | Type |
|---|---|
Branch IDRequired | choice |
Delete a UserAction
Input fields[3]
| Field | Type |
|---|---|
User IDRequired | choice |
Delete an Employee FamilyAction
Input fields[3]
| Field | Type |
|---|---|
Branch IDRequired | choice |
Delete an Employee LoanAction
Input fields[3]
| Field | Type |
|---|---|
Branch IDRequired | choice |
Delete an Employee TerminationAction
Input fields[3]
| Field | Type |
|---|---|
Branch IDRequired | choice |
Delete an Employee's ShiftsAction
Input fields[3]
| Field | Type |
|---|---|
Branch IDRequired | choice |
Delete an OvertimeAction
Input fields[3]
| Field | Type |
|---|---|
Branch IDRequired | choice |
Delete Employee CompetencyAction
Input fields[3]
| Field | Type |
|---|---|
Branch IDRequired | choice |
Competency IDRequired | number |
Required LevelRequired | number |
| Name | object |
| Name (English) | text |
| Name (Arabic) | text |
Delete Employee Financial DataAction
Input fields[3]
| Field | Type |
|---|---|
Branch IDRequired | choice |
Delete Employee Financial TransactionsAction
Input fields[3]
| Field | Type |
|---|---|
Branch IDRequired | choice |
Delete Employee OvertimeAction
Input fields[3]
| Field | Type |
|---|---|
Branch IDRequired | choice |
Delete Employee Professional DataAction
Input fields[3]
| Field | Type |
|---|---|
Branch IDRequired | choice |
Make an API Calluniversal
Update a Branch Work ShiftAction
Input fields[3]
| Field | Type |
|---|---|
Branch IDRequired | choice |
| Work Shift Type | choice |
| Morning Leave After | number |
| Early Out Leave Before | number |
| Overtime After | number |
| Interval Margin Percentage | number |
| Color | text |
| Exclude Transaction | boolean |
| Flex Leave After | number |
7other input fields
Output fields[3]
| Field | Type |
|---|---|
| ID | number |
| Name | object |
| Ar | text |
| En | text |
| Branch | object |
| ID | number |
| Cut holidays | boolean |
| Cut days off | boolean |
| Exceed balance | boolean |
| Accumulative | boolean |
| Class name | text |
| Deduction type | number |
19other output fields
Update a DocumentAction
Update a Financial Transaction TypeAction
Input fields[3]
| Field | Type |
|---|---|
Branch IDRequired | choice |
Global IDRequired | text |
Name (English)Required | text |
Name (Arabic)Required | text |
DirectionRequired | choice |
Is FixedRequired | boolean |
One TimeRequired | boolean |
Output fields[3]
| Field | Type |
|---|---|
| ID | number |
| Name | object |
| Ar | text |
| En | text |
| Amount | text |
| Payroll status | text |
| Is fixed | boolean |
| One time | boolean |
| Direction | text |
| Min | text |
| Max | text |
12other output fields
Update a Loan by Global IDAction
Input fields[3]
| Field | Type |
|---|---|
Branch IDRequired | choice |
Global IDRequired | text |
Amount (in Fils)Required | number |
Amount CurrencyRequired | text |
Effective DateRequired | date |
Number of PaymentsRequired | number |
| Name | object |
Name (Arabic)Required | text |
Name (English)Required | text |
Instalment (in Fils)Required | number |
Instalment CurrencyRequired | text |
5other input fields
Output fields[3]
| Field | Type |
|---|---|
| ID | number |
| Employee | object |
| ID | number |
| Overtime type | object |
| ID | number |
| From | date |
| To | date |
| Amount fils | number |
| Amount currency | text |
| Status | number |
| Effective date | date |
9other output fields
Update a PositionAction
Update a Recurring TransactionAction
Input fields[3]
| Field | Type |
|---|---|
Branch IDRequired | choice |
| Financial Transaction Type ID | number |
| Start Date | date |
| End Date | date |
| Amount | number |
Output fields[3]
| Field | Type |
|---|---|
| ID | number |
| Employee | object |
| ID | number |
| Payment method | text |
| Resident | boolean |
| Taxable | boolean |
| Salary count | number |
| Personal exemption | boolean |
| Family exemption | boolean |
| Other exemption | object |
| Amount | number |
| Currency | text |
9other output fields
Update a UserAction
Input fields[3]
| Field | Type |
|---|---|
User IDRequired | choice |
| Username | |
| Provider | text |
| Name | object |
| English Name | object |
| Arabic Name | object |
| Is Support | boolean |
| User ID | text |
| Impersonation | boolean |
Update an EmployeeAction
Input fields[3]
| Field | Type |
|---|---|
Branch IDRequired | choice |
| National ID | text |
| Personal Email | |
| Labour Card | text |
| Labour Card Expiry | date |
| Mobile Number | text |
| Payment Method | text |
| Hiring Date | date |
| Gender | text |
32other input fields
Output fields[3]
| Field | Type |
|---|---|
| ID | number |
| Branch ID | number |
| Employment number | text |
| Username | text |
| User | object |
| ID | number |
| Short name | object |
| Name | object |
| Picture | object |
| Birthdate | date |
| Hiring date | date |
| Fixing date | date |
26other output fields
Update an Employee by GL IDAction
Input fields[3]
| Field | Type |
|---|---|
Branch IDRequired | choice |
National IDRequired | text |
Personal EmailRequired | |
Labour CardRequired | text |
Labour Card ExpiryRequired | date |
Mobile NumberRequired | text |
Payment MethodRequired | text |
| Hiring Date | date |
| Gender | text |
32other input fields
Output fields[3]
| Field | Type |
|---|---|
| ID | number |
| Branch ID | number |
| Employment number | text |
| Username | text |
| User | object |
| ID | number |
| Short name | object |
| Name | object |
| Picture | object |
| Birthdate | date |
| Hiring date | date |
| Fixing date | date |
26other output fields
Update an Employee FamilyAction
Input fields[3]
| Field | Type |
|---|---|
Branch IDRequired | choice |
| Relation | choice |
| Birthdate | date |
| Name (English) | object |
| First Name | text |
| Second Name | text |
| Third Name | text |
| Last Name | text |
| Name (Arabic) | object |
| First Name | text |
| Second Name | text |
| Third Name | text |
| Last Name | text |
| Marital Status | choice |
| Phone Number | text |
| Gender | choice |
| Name | text |
6other input fields
Output fields[3]
| Field | Type |
|---|---|
| ID | number |
| Employee | object |
| ID | number |
| Relation | text |
| Name | object |
| En | object |
| Ar | object |
| Birthdate | date |
| Relation date | date |
| Gender | text |
| Marital status | text |
| Phone number | text |
8other output fields
Update an Employee LoanAction
Input fields[3]
| Field | Type |
|---|---|
Branch IDRequired | choice |
| Status | number |
| Amount (Fils) | number |
| Amount Currency | text |
| Effective Date | date |
| Number of Payments | number |
| Name | object |
| Arabic Name | text |
| English Name | text |
| Instalment (Fils) | number |
| Instalment Currency | text |
5other input fields
Output fields[3]
| Field | Type |
|---|---|
| ID | number |
| Employee | object |
| Employee ID | number |
| Amount fils | number |
| Amount currency | text |
| Effective date | date |
| Number of payments | number |
| Name | object |
| Ar | text |
| En | text |
| Loan type | object |
| Loan type ID | number |
| Cancel requested on | date |
7other output fields
Update an OvertimeAction
Input fields[3]
| Field | Type |
|---|---|
Branch IDRequired | choice |
| Employee ID | number |
| Overtime Type ID | number |
| From Date | date |
| To Date | date |
| Amount Fils | number |
| Amount Currency | text |
| Status | number |
| Effective Date | date |
6other input fields
Output fields[3]
| Field | Type |
|---|---|
| ID | number |
| Employee | object |
| ID | number |
| Overtime type | object |
| ID | number |
| From | date |
| To | date |
| Amount fils | number |
| Amount currency | text |
| Status | number |
| Effective date | text |
9other output fields
Update an Overtime TypeAction
Input fields[3]
| Field | Type |
|---|---|
Branch IDRequired | choice |
Global IDRequired | text |
Minimum HoursRequired | number |
| Ability to Request | boolean |
| Mandatory Attachment | boolean |
| Mandatory Notes | boolean |
| Default | boolean |
| GL Identifier | object |
| Rate | number |
Output fields[3]
| Field | Type |
|---|---|
| ID | number |
| Name | object |
| Ar | text |
| En | text |
| Description | object |
| Ar | text |
| En | text |
| Branch ID | number |
| Allowed after | number |
| Allowed after type | text |
| Allowed times | number |
| Allowed every | number |
| Allowed every type | text |
21other output fields
Update Employee CompetencyAction
Update Employee Financial DataAction
Input fields[3]
| Field | Type |
|---|---|
Branch IDRequired | choice |
| SS Participation Date | date |
| Family Exemption | boolean |
| Personal Exemption | boolean |
| Taxable | boolean |
| Salary Count | number |
| Basic Salary Fils | number |
| Basic Salary Currency | text |
| SS Salary Fils | number |
11other input fields
Output fields[3]
| Field | Type |
|---|---|
| ID | number |
| Employee | object |
| ID | number |
| Payment method | text |
| Resident | boolean |
| Taxable | boolean |
| Salary count | number |
| Personal exemption | boolean |
| Family exemption | boolean |
| Other exemption | object |
| Amount | number |
| Currency | text |
9other output fields
Update Employee Financial TransactionsAction
Input fields[3]
| Field | Type |
|---|---|
Branch IDRequired | choice |
| Financial Transaction Type ID | number |
| Amount Fils | number |
| Amount Currency | text |
| Effective Date | date |
| Due Date | date |
| Notes | text |
| Cancel Requested | boolean |
| Paid Cash | boolean |
11other input fields
Update Employee OvertimeAction
Input fields[3]
| Field | Type |
|---|---|
Branch IDRequired | choice |
| From | date |
| To | date |
| Amount Fils | number |
| Amount Currency | text |
| Status | number |
| Effective Date | date |
| Duration | number |
| Cancel Requested On | text |
4other input fields
Output fields[3]
| Field | Type |
|---|---|
| ID | number |
| Employee | object |
| ID | number |
| Overtime type | object |
| ID | number |
| From | date |
| To | date |
| Amount fils | number |
| Amount currency | text |
| Status | number |
| Effective date | date |
9other output fields
Update Employee Professional DataAction
Update Employee ShiftsAction
Update Financial TransactionsAction
Input fields[3]
| Field | Type |
|---|---|
Branch IDRequired | choice |
Global IDRequired | text |
Amount in FilsRequired | number |
Amount CurrencyRequired | text |
Effective DateRequired | date |
| Notes | text |
| Cancel Requested On | text |
| Out of Payroll | boolean |
| Due Date | date |
12other input fields
Output fields[3]
| Field | Type |
|---|---|
| ID | number |
| Financial transaction type | object |
| ID | number |
| Employee | object |
| ID | number |
| Transaction status | text |
| Direction | text |
| Out of payroll | boolean |
| Amount | object |
| Amount | number |
| Currency | text |
| Notes | text |
| Effective date | date |
5other output fields
Update Loan TypesAction
Input fields[3]
| Field | Type |
|---|---|
Branch IDRequired | choice |
Global IDRequired | text |
| Name | object |
EnglishRequired | text |
| Arabic | text |
| Description | object |
| English | text |
| Arabic | text |
| Allowed After | date |
| Allowed After Type | text |
| Allowed Times | number |
| Allowed Every | number |
| Allowed Every Type | text |
20other input fields
Output fields[3]
| Field | Type |
|---|---|
| ID | number |
| Name | object |
| Ar | text |
| En | text |
| Description | object |
| Ar | text |
| En | text |
| Branch ID | number |
| Allowed after | number |
| Allowed after type | text |
| Allowed times | number |
| Allowed every | number |
| Allowed every type | text |
21other output fields
Update Overtime by Global IDAction
Input fields[3]
| Field | Type |
|---|---|
Branch IDRequired | choice |
Global IDRequired | text |
FromRequired | date |
ToRequired | date |
Amount FilsRequired | number |
Amount CurrencyRequired | text |
StatusRequired | number |
Effective DateRequired | date |
| Duration | number |
4other input fields
Output fields[3]
| Field | Type |
|---|---|
| ID | number |
| Employee | object |
| ID | number |
| Overtime type | object |
| ID | number |
| From | date |
| To | date |
| Amount fils | number |
| Amount currency | text |
| Status | number |
| Effective date | date |
9other output fields
Templates
Look for ZenHR templates in the WEXTL template library.
Browse templates →Explore alternative apps
- Achievers[2]Employee recognition and engagement platform for celebrations, rewards, and newsfeeds.
- Breezy HRApplicant tracking and recruiting platform for posting jobs, sourcing candidates, and hiring.
- BullhornRecruiting ATS and CRM for staffing agencies and talent teams.
- AladtecWorkforce scheduling and timekeeping for public safety and healthcare teams.
- BeameryTalent lifecycle CRM for recruiting, talent pooling, campaigns, and workforce planning.
References
- WEXTL® ZenHR Source Code connector implementation.
- Our users use cases and automations.
- Official API Documentation for ZenHR.
- WEXTL® visual workflow builder data.
Last updated: Jul 24, 2026 18:13