How to Integrate ZK Biometric Attendance With ERPNext
By Aylmer Ametewee on December 13, 2024
BeginnerTo successfully integrate ZK Biometric Attendance device with ERPNext, follow the below steps:
- Install Python
- Open ERPNext and create a new user for ZK Integration.
- Generate API Key for this user you just created as shown below:

- In your ERPNext, navigate to 'Shift Type' and configure shift types as shown below:

- Open 'Employee List' in ERPNext and assign shift and attendance device IDs to employees as shown below.

- Download the below zip file from github: https://github.com/frappe/biometric-attendance-sync-tool.git
- Open the zip file to view its contents
- Rename local_config.py.template --To -- local_config.py as shown below

- Open the local_config.py file and fill the requirements according to your configuration details. An example is shown below:

- Save and close this file after filling it.
- Open the zipped folder you downloaded in terminal as shown below:

- Run the following commands one after the other:
--> pip install -r .\requirements.txt
--> python .\erpnext_sync.py
Note: If configuration already done, then just run the command python .\erpnext_sync.py

- You should see below feedback after running the second command to confirm that integration has been successful. This means all employee checkins will be captured by device.

written by: Michael
Was this article helpful?
More articles on Erpnext