ricky/redmine_qbo
1
1
Fork 0
mirror of https://github.com/rickbarrette/redmine_qbo.git synced 2026-02-13 01:03:59 -05:00
Code Issues Actions Packages Projects Releases Wiki Activity

Udated README & Copyright Date

Browse Source
This commit is contained in:
Ricky Barrette
2026-01-20 13:49:38 -05:00
parent 7d644f0619
commit 0647b7708f
3 changed files with 94 additions and 63 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
LICENSE
View File

@@ -1,6 +1,6 @@
The MIT License (MIT) The MIT License (MIT)
Copyright (c) 2016 - 2024 Rick Barrette Copyright (c) 2016 - 2026 Rick Barrette
Permission is hereby granted, free of charge, to any person obtaining a copy Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal of this software and associated documentation files (the "Software"), to deal

151
README.md
View File

@@ -1,81 +1,112 @@
# Redmine Quickbooks Online # Redmine QuickBooks Online
A plugin for Redmine to connect to Quickbooks Online A 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 billable hours loged 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 billable hours logged when an Issue is closed.
#### Disclaimer ## Disclaimer
Note: Although the core functionality is complete, this project is still under development & the master branch may be unstable. Tags should be stable and are recommended **Note:** Although the core functionality is complete, this project is still under development and the master branch may be unstable. Tags should be stable and are recommended.
Use tags for the following Redmine Versions ## Compatibility
* Version 2.0.0+ for Redmine 5+
* Version 1.0.0+ for Redmine 4+
* Version 0.8.1 for Redine 3
#### Features | Plugin Version | Redmine Version |
* Issues can be assigned to a Customer via drop down in the edit Issue form | :--- | :--- |
- Once a customer is attached to an Issue, you can attach an Estimate to the issue via a drop down menu | Version 2026.1.0+ | Redmine 6.1 |
* Employee is assigned to a user via a drop down in the user admistration page. | Version 2.0.0+ | Redmine 5 |
* IF an Issue has been assined a Customer when an Issue is closed the following will happen: | Version 1.0.0+ | Redmine 4 |
- A new Time Activity will be billed agaist the Customer assinged to the issue for each Redmine Time Entery. | Version 0.8.1 | Redmine 3 |
+ Time Entries will be totalled up by Activity name. This will allow billing for diffrent activities without having to create seperate Issues.
+ The Time Activity names are used to dynamically lookup Items in Quickbooks. ## Features
+ IF there isn't any Items that match the Activity name it will be skipped, and will not be billed to the Customer
- Labor Rates are set by corresponding the Item in Quickbooks * **Customer Assignment:** Issues can be assigned to a Customer via a dropdown in the edit Issue form.
* Customers Can be created via the New Customer Page * Once a customer is attached to an Issue, you can attach an Estimate to the issue via a dropdown menu.
- Customers can be searched by name or phone number * **Employee Mapping:** An Employee is assigned to a Redmine User via a dropdown in the User Administration page.
- Basic information for the Customer can be viewed/edit via the Customer page * **Automatic Billing:** If an Issue has been assigned a Customer, the following happens when the Issue is closed:
* Webhook Support * A new Time Activity will be billed against the Customer assigned to the issue for each Redmine Time Entry.
- Invoices are automaticly attached to an Issue if a line item has a hashtag number in a Line Item * Time Entries will be totalled up by Activity name. This allows billing for different activities without having to create separate Issues.
+ Invoice Custom Fields are matched Issue Custom Fileds and are automaticly updated in Quickbooks. For example, this is usefull for extracting the Mileage In / Out from the Issue and updating the Invoice with the information. * The Time Activity names are used to dynamically lookup Items in QuickBooks.
- Customers are automaticly updated in local database * If there are no Items that match the Activity name, it will be skipped and will not be billed to the Customer.
* Labor Rates are set by the corresponding Item in QuickBooks.
* **Customer Management:** Customers can be created via the New Customer Page.
* Customers can be searched by name or phone number.
* Basic information for the Customer can be viewed/edited via the Customer page.
* **Webhook Support:**
* **Invoices:** Automatically attached to an Issue if a line item contains a hashtag number (e.g., `#123`).
* **Custom Fields:** Invoice Custom Fields are matched to Issue Custom Fields and are automatically updated in QuickBooks. (Useful for extracting Mileage In/Out from the Issue to update the Invoice).
* **Sync:** Customers are automatically updated in the local database.
## Prerequisites ## 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 * Create your own application to obtain your API keys.
* Set up webhook service to https://redmine.yourdomain.com/qbo/webhook * Set up the webhook service to `https://redmine.yourdomain.com/qbo/webhook`
## The Install ## Installation
1. To install, clone this repo into your plugin folder & checkout a tagged version 1. **Clone the plugin:**
Clone this repo into your plugin folder and checkout a tagged version.
```bash
cd path/to/redmine/plugins
git clone git@github.com:rickbarrette/redmine_qbo.git
cd redmine_qbo
git checkout <tag>
```
`git clone git@github.com:rickbarrette/redmine_qbo.git` 2. **Install dependencies:** *Crucial for Redmine 6 / Rails 7 compatibility.*
then Bash
`git checkout <tag>` ```
bundle install
2. Migrate your database ```
`rake redmine:plugins:migrate RAILS_ENV=production` 3. **Migrate your database:**
3. Navigate to the plugin configuration page and suppy your own OAuth key & secret. Bash
4. After saving your key & secret, you need to click on the Authenticate link on the plugin configuration page to authenticate with QBO. ```
bundle exec rake redmine:plugins:migrate RAILS_ENV=production
5. Assign an Employee to each of your users via the User Administration Page ```
4. **Restart Redmine:** You must restart your Redmine server instance for the plugin and hooks to load.
5. **Configuration:**
* Navigate to the plugin configuration page (`Administration > Plugins > Configure`).
* Supply your own OAuth Key & Secret.
* After saving the Key & Secret, click the **Authenticate** link on the configuration page to connect to QBO.
6. **User Mapping:**
* Assign an Employee to each of your users via the **User Administration Page**.
## Usage ## Usage
To enable automatic Time Activity entries for an Issue , you need only to assign a Customer to an Issue via drop downs in the issue creation/update form. To enable automatic Time Activity entries for an Issue, you simply need to assign a Customer to an Issue via the dropdowns in the issue creation/update form.
Note: After the inital synchronization, this plugin will recieve push notifications via Intuit's webhook service. **Note:** After the initial synchronization, this plugin will receive push notifications via Intuit's webhook service.
## TODO ## TODO
* Add Setting for Sandbox Mode
* Seperate Vehicles into a seperate plugin (I use redmine for my automotive shop management 😉) * Add Setting for Sandbox Mode
* MORE Stuff as I make it up...
* Separate Vehicles into a separate plugin (I use Redmine for my automotive shop management 😉)
* MORE Stuff as I make it up...
## License ## License
The MIT License (MIT) > The MIT License (MIT)
>
Copyright (c) 2016 - 2022 rick barrette > Copyright (c) 2016 - 2026 Rick Barrette
>
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: > Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
>
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. > The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
>
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. > THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

4
init.rb
View File

@@ -1,6 +1,6 @@
#The MIT License (MIT) #The MIT License (MIT)
# #
#Copyright (c) 2016-2025 rick barrette #Copyright (c) 2016-2026 rick barrette
# #
#Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: #Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
# #
@@ -14,7 +14,7 @@ Redmine::Plugin.register :redmine_qbo do
name 'Redmine Quickbooks Online plugin' name 'Redmine Quickbooks Online plugin'
author 'Rick Barrette' author 'Rick Barrette'
description 'This is a plugin for Redmine to intergrate with Quickbooks Online to allow for seamless intergration CRM and invoicing of completed issues' description 'This is a plugin for Redmine to intergrate with Quickbooks Online to allow for seamless intergration CRM and invoicing of completed issues'
version '2025.7.1' version '2026.1.0'
url 'https://github.com/rickbarrette/redmine_qbo' url 'https://github.com/rickbarrette/redmine_qbo'
author_url 'https://barrettefabrication.com' author_url 'https://barrettefabrication.com'
settings :default => {'empty' => true}, :partial => 'qbo/settings' settings :default => {'empty' => true}, :partial => 'qbo/settings'