Skip to content

Latest commit

 

History

History
187 lines (129 loc) · 4.48 KB

README.md

File metadata and controls

187 lines (129 loc) · 4.48 KB
Raw

ERPNext Expenses

v1.0.0-Alpha5

An expenses management module for ERPNext.

⚠️ This plugin is in ALPHA stage so it is not PRODUCTION ready. ⚠️

Contributors

The list of people who deserves more than a simple "Thank You".

  • Monolith Online
  • Andrew Rogers
  • Washaqq
  • Codi
  • Ian Kahare

Table of Contents

Requirements

Setup

⚠️ Important ⚠️

Do not forget to replace "[sitename]" with the name of your site in all commands.

Install

  1. Go to bench directory
cd ~/frappe-bench
  1. Get plugin from Github
bench get-app https://github.com/kid1194/erpnext_expenses
  1. Build plugin
bench build --app expenses
  1. Install plugin on your site
bench --site [sitename] install-app expenses
  1. Restart bench to clear cache
bench restart
  1. Read the Usage section below

Update

  1. Go to app directory
cd ~/frappe-bench/apps/expenses
  1. Get updates from Github
git pull
  1. Go to bench directory (Optional)
cd ~/frappe-bench
  1. Build plugin
bench build --app expenses
  1. Update your site
bench --site [sitename] migrate
  1. Restart bench to clear cache
bench restart

Uninstall

  1. Go to bench directory
cd ~/frappe-bench
  1. Uninstall plugin from your site
bench --site [sitename] uninstall-app expenses
  1. Remove plugin from bench cache
bench remove-app expenses
  1. Restart bench to clear cache
bench restart

Usage

  1. Expense Type
  • Create the hierarchy of expense types based on your needs
  • Add an expense account for each company so it gets inherited by all new expense items

ℹ️ Note: Expense accounts are inherited from parents.

  1. Expense Item
  • Create the expense items that reflect your expenses
  • Add each expense item to the expense type that it belongs to
  • Add an expense account for each company and/or set the expense defaults (cost, quantity, etc..)
  • Modify the expense defaults (cost, quantity, etc..) of the inherited expense accounts, if exist

ℹ️ Note: Expense accounts will be inherited from linked expense type and they are not modifiable except for cost and quantity related fields.

  1. Expense
  • Create a company expense and select the expense item
  • Fill the cost, quantity, etc.. if not fixed for the expense item
  • Attachments can be added or removed even after submit, but before adding the expense to an expenses request
  1. Expenses Request
  • Create a request for a company list of expenses so that it can be approved or rejected
  • When requests are rejected, the linked expenses will be automatically rejected & cancelled
  • Rejected requests can be appealed and after appealing, the status of linked expenses will be automatically restored and set as Requested
  1. Expenses Entry
  • Create entries based on a request or manually add company related expenses
  • After submit, all the expenses will be posted to the journal
  1. Expenses Settings
  • Enable the module (Enabled by default)
  • Modify the expense settings
  • Modify the update notification settings
  • Check for update manually

ℹ️ Note: Module update functionality will only be enabled in the PRODUCTION stage

Issues

If you find bug in the plugin, please create a bug report and let us know about it.

License

This repository has been released under the MIT License.