ricky/redmine_qbo
1
1
Fork 0
mirror of https://github.com/rickbarrette/redmine_qbo.git synced 2025-11-09 09:24:23 -05:00
Code Issues Actions Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Ricky Barrette
2016-01-20 12:46:24 -05:00
parent 20be533a19
commit afb3af18d4
1 changed files with 13 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

25
README.md
View File

@@ -5,14 +5,15 @@ A simple plugin for Redmine to connect to Quickbooks Online
The goal of this project is to allow redmine to connect with Quickbooks Online to create time activity entries for completed work when an issue is closed. The goal of this project is to allow redmine to connect with Quickbooks Online to create time activity entries for completed work when an issue is closed.
####How it works ####How it works
* A QBO customer and service item can be assigned to a redmine issue. * Issues can be assigned to a QBO Customer and QBO Service Item via drop down in issues form
* A QBO employee can be assigned to a redmine user - The QBO Employee for the issue is assigned via the assigned redmine user
* When a issue is closed, the following things happen: - IF an issue has been assined a QBO Customer, QBO Service Item & QBO Employee when an issue is closed the following will happen:
- The plugin checks to see if the user assinged to the issue has a QBO employee assinged to them - A new QBO Time Activity agaist the QBO Customer will be created using the total spent hours logged agaist an issue.
- The plugin checks to see if the issue has a QBO customer & service item attached - The rate will be the set via the QBO Service Item Price
- If the above statements are true, then a new QBO Time Activity is created * Issues with the Tracker `Quote` will generate an estimate based on the estimated hours and Service Item cost.
- The total time for the Time Activity will be total spent time. - Needs to have a QBO Customer & QBO Service Item Assiged
- The rate will be the set be the service item - TODO Add rake file to create Quote tracker???
* Users will be assigned a QBO Employee via a drop down in the user admistration page.
##Prerequisites ##Prerequisites
@@ -23,19 +24,19 @@ The goal of this project is to allow redmine to connect with Quickbooks Online t
1. To install, clone this repo into your plugin folder 1. To install, clone this repo into your plugin folder
' git clone git@github.com:rickbarrette/redmine_qbo.git ' `git clone git@github.com:rickbarrette/redmine_qbo.git`
2. Migrate your database 2. Migrate your database
' rake redmine:plugins:migrate RAILS_ENV=production ' `rake redmine:plugins:migrate RAILS_ENV=production`
3. Navigate to the plugin configuration page (https://your.redmine.com/settings/plugin/redmine_qbo) and suppy your own OAuth key & secret. 3. Navigate to the plugin configuration page `https://your.redmine.com/settings/plugin/redmine_qbo` and suppy your own OAuth key & secret.
4. After saving your key & secret, you need to click on the Authenticate link on the plugin configuration page to authenticate with QBO. 4. After saving your key & secret, you need to click on the Authenticate link on the plugin configuration page to authenticate with QBO.
5. Enjoy 5. Enjoy
Note: Customers, Employees, and Service Items with automaticly update during normal usage of redmine i.e. a page refresh. You can also manualy force redmine to sync its database with QBO clicking the sync link in the Quickbooks top menu page (https://your.redmine.com/redmine/qbo) Note: Customers, Employees, and Service Items with automaticly update during normal usage of redmine i.e. a page refresh. You can also manualy force redmine to sync its database with QBO clicking the sync link in the Quickbooks top menu page `https://your.redmine.com/redmine/qbo`
##License ##License