Expenses plugin

• Features
• Purchase
  • Compatibility
• Installation
  • Copy files
  • Clear cache
  • Create database
• Usage
  • Setup categories
• Permissions
• Updating the plugin
• Screenshots

A Kimai 2 plugin, which allows to keep track of your expenses based on customer, project and activity. These spendings can be categorized and included in your Kimai generated invoices.

Features

• Record all your expenses and show them in a table view
  • The data can be searched- and filtered (see screenshots)
• All (refundable) expenses will be automatically included in your invoices
• Manage expenses via API
• Import expenses from Kimai 1
• Support for custom fields (see Custom-fields plugin)

Expenses are sorted into free configurable types (categories). Each type has a:

• name
• visibility flag
• default cost

Each expense has the following fields:

• a date-time
• category (see above)
• user
• project (and customer)
• activity (optional)
• description (free text field)
• the cost (can be hidden for default user, if you use default cost via category)
• an amount (see it as multiplier, use 1 if you want to charge the cost only)
• refundable flag (non-refundable expenses will not be added to your invoices)
• an export flag (to make sure, that each expense is invoiced only once)

Purchase

Compatibility

Please make sure to use the correct version of the plugin, which must be compatible with your Kimai version:

Installation

Copy files

Extract the ZIP file and upload the included directory and all files to your Kimai installation to the new directory: var/plugins/ExpensesBundle/

The file structure needs to like like this afterwards:

var/plugins/
├── ExpensesBundle
│   ├── ExpensesBundle.php
|   └ ... more files and directories follow here ...

Clear cache

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:

bin/console kimai:reload --env=prod

bin/console cache:clear --env=prod
bin/console cache:warmup --env=prod

You might have to set file permissions afterwards:

chown -R :www-data .
chmod -R g+r .
chmod -R g+rw var/
chmod -R g+rw public/avatars/

Create database

Run the following command:

bin/console kimai:bundle:expenses:install

This will install all required databases.

Usage

When logged in as SUPER_ADMIN, you will now see the expenses administration screen at /en/expenses/.

If this was successful, you can now think about giving permissions to other users as well.

Setup categories

Before you can start tracking expenses, you will have to create at least one visible category. You will be redirected to the category creation screen if Kimai doesn’t find one.

Permissions

This bundle ships a couple of new permissions, which limits the access to certain functions:

By default, these are assigned to each user with the role ROLE_SUPER_ADMIN.

Updating the plugin

Updating the bundle works the same way as the installation does.

• Delete the directory var/plugins/ExpensesBundle/ (to remove deleted files)
• Execute all installation steps again:
  • Copy files
  • Clear cache
  • Update database with bin/console kimai:bundle:expenses:install

Screenshots

The overview page of all expenses:

The category management:

You can search through all existing expense records:

When creating a new expense, you can record the following fields: