A Kimai plugin, which allows configuring additional fields for timesheets, customers, projects, activities and expenses.
Configure additional fields for the following entities:
Expenses- see Expenses plugin
The custom fields will be shown on the “create and edit entity” forms and can have the following types:
string(simple text field)
integer(number without decimal point)
number(number with decimal places)
language(dropdown of languages, shown in the users language)
currency(dropdown of currencies, shown in the users language)
country(dropdown of countries, shown in the users language)
color(browser specific input element to select a color)
textarea(multi-line text field)
You can create as many fields as you want for each data type, where each field:
The custom-field data is then available in:
You can change the “weight” of custom-fields, so they show up in the order you define.
Use the value
1 as default value for a pre-checked box or
0 for an unchecked box.
If a checkbox is marked as mandatory, the user has to check it in order to submit the form.
“Choice-list” is a different word for “Select-box” or “Drop-down”.
You have to add the entries as comma separated list into the default-value field.
For example a list consisting of fruits would look like this:
As the first entry is pre-selected, you can add an empty field to the dropdown by starting the list
with a leading
, like this:
Combined with the mandatory flag, this will force your users to select an entry from the list to be able to submit the form.
Choice list is also capable to configure title and values independently.
Let’s assume you have non-human friendly IDs for the value, but want to show a human friendly text, you can separate
each value from its title by using a pipe
A select box that is useful if you want to generate automatic invoices via command line / cronjobs.
The Kimai command
bin/console kimai:invoice:create supports invoice templates via custom-field (see docs).
The option parameter
--template-meta takes the internal name of the custom field that will identify the invoice template to be used.
When logged in as
SUPER_ADMIN, you should now see the custom-fields administration screen at
If this was successful, you can now think about giving permissions to other users as well.
This bundle introduces new permissions, which limit access to certain functions:
||allows to administrate the custom field definitions|
By default, these are assigned to each user with the role
Plugins should always be compatible with higher Kimai versions, the following list contains the plugin version and the required minimum Kimai version.
|Bundle version||Minimum Kimai version|
|1.15 - 1.16||1.11|
|1.10 - 1.13||1.9|
|1.8 - 1.9||1.7|
|1.6 - 1.7||1.6.2|
|1.3.2 - 1.4.1||1.4|
|1.1.1 - 1.2||1.1|
Extract the ZIP file and upload the included directory and all files to your Kimai installation to the new directory:
The file structure needs to like like this afterwards:
After uploading the files, Kimai needs to know about the new plugin. It will be found once the cache was re-built. Call these commands from the Kimai directory:
If you are running an older version (Kimai <= 1.7) you have to use:
You might have to set file permissions afterwards:
You have to allow PHP (your webserver process) to write to
var/ and it subdirectories.
Here is an example for Debian/Ubuntu (to be executed inside the Kimai directory):
Test Kimai before executing these commands (they are likely not required in a shared-hosting environment).
You probably need to prefix them with
the group might be called different than
Run the following command:
This will create the required database tables and update them to the latest version.
Updating the plugin works exactly like the installation:
Records detailed change/audit logs for timesheets, customers, projects and activities and displays them in a per-item timeline.
Create free configurable additional (optional and mandatory) fields for timesheets, customers, projects and activities in various formats.
Keep track of your expenses based on a customer, project and activity. These expenses can be categorized and included in your invoices.
Attendance time-tracking in an environment, where the user has no access to Kimai (eg. in a warehouse) by using a barcode or RFID scanner to start and stop timesheets.
Create tasks, start/stop/pause them, assign them to users and teams - a todo-list management plugin that is connected to your time-tracker and adds two new dashboard widgets
|Console client (PHAR)||
|Custom CSS plugin||
|Custom plugin development||
|Fixed invoice data format (by language)||
|Installation & Update support||
|Recalculate rates plugin||