ricky/redmine_qbo
1
1
Fork 0
mirror of https://github.com/rickbarrette/redmine_qbo.git synced 2025-11-08 08:54: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-10 09:47:55 -05:00
parent 8f86220fef
commit 1c67328363
1 changed files with 22 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

31
README.md
View File

@@ -1,4 +1,4 @@
#redmine_qbo
#Redmine Quickbooks Online
##About
@@ -7,24 +7,37 @@ This is 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.
####How it works
* A QBO customer and service item can now be assigned to an issue.
* When a issue is closed, a new QBO Time Activity is created
* A QBO customer and service item can be assigned to a redmine issue.
* A QBO employee can be assigned to a redmine user
* When a issue is closed, the following things happen:
- The plugin checks to see if the user assinged to the issue has a QBO employee assinged to them
- The plugin checks to see if the issue has a QBO customer & service item attached
- If the above statements are true, then a new QBO Time Activity is created
- The total time for the Time Activity will be total spent time.
- The rate will be the set be the service item
*Warning: * This is under heavy development
##Prerequisites
Sign up to become a developer for Intuit https://developer.intuit.com/
* Sign up to become a developer for Intuit https://developer.intuit.com/
* Create your own aplication to obtain your API keys
##The Install
To install, clone into your plugin folder and migrate your database. Then navigate to the plugin configuration page (https://your.redmine.com/settings/plugin/redmine_qbo) and suppy your own OAuth key & secret.
1. To install, clone this repo into your plugin folder
After saving your key & secret, you need to click on the Authenticate link on the plugin configuration page to authenticate with QBO.
' git clone git@github.com:rickbarrette/redmine_qbo.git '
Once you are authenticated with QBO, you need to synchronize your database with QBO by clicking the sync link in the Quickbooks top menu (https://your.redmine.com/redmine/qbo)
2. Migrate your database
' 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.
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
Note: Customers and Employees with automaticly update during normail usage of redmine i.e. a page refresh
Note:nService Items do not automaticly update at this time, if you add/remove service items you will need to synchronize your database with QBO by clicking the sync link in the Quickbooks top menu (https://your.redmine.com/redmine/qbo)
##License