Compare commits

...
111 Commits
Author SHA1 Message Date
ricky d07d99109b 2026.11.0 2026-10-31 00:15:17 -04:00
Claude 9fd6e90c81 Drop QuickBooks estimate and payment links from customer actions
Estimates and payments are handled in Redmine; each action shows only to users with its permission.
The customer's name still links to their QuickBooks account page as a fallback.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01BiwYMjhoQvL7XsKKfRz4pM
2026-10-31 00:12:03 -04:00
Claude 14f0409395 Add a customer payments page
Payments on the customer page lists the customer's QuickBooks payments, newest first, with the
invoices each was applied to, memo, amount, unapplied credit and totals; each links to the payment
page and its PDF. A new View payments permission allows the list, payment page and PDF; Receive
payments includes it.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01BiwYMjhoQvL7XsKKfRz4pM
2026-10-31 00:00:36 -04:00
Claude 9121e079a0 Fold redmine_qbo_billing into redmine_qbo
Estimates, invoices and payments written in Redmine, issues from estimates,
and the QuickBooks product/service list and accounts are now part of this
plugin (the RedmineQboBilling code, its controllers, views, strings and
permissions), so there's one plugin and one version instead of two that had
to match.

- The customer page, estimate and invoice lists and the issue page render the
  Create Estimate / Create invoice / Receive payment and Edit links directly;
  the hooks that only existed to let billing add them are gone. Users without
  the billing permissions still get the links to QuickBooks.
- Migrations 043-046 create the items and accounts tables and the estimate
  line links, skipping whatever an existing database already has
  (redmine_qbo_lineitems' tables are used as they are), and copy calendar's
  existing estimate line links in.
- The billing settings are a section of this plugin's settings page.
- The hooks other plugins use stay: qbo_billing_issue_values,
  qbo_billing_validate, qbo_billing_issue_defaults, qbo_billing_issues_created
  and view_qbo_estimate_contextual.
- rake redmine_qbo:relate_estimate_issues

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01BiwYMjhoQvL7XsKKfRz4pM
2026-10-30 23:47:01 -04:00
Claude 48a4185c16 Replaceable Create Payment link on the customer page
view_customers_show_payment_link lets a plugin replace the link that opens
QuickBooks' receive payment screen (redmine_qbo_billing receives payments in
Redmine).

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01BiwYMjhoQvL7XsKKfRz4pM
2026-10-30 23:28:32 -04:00
Claude 71f31ccbed Invoice actions hook on the customer page's invoice list
view_invoice_actions adds links after each invoice (redmine_qbo_billing adds
an Edit link).

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01BiwYMjhoQvL7XsKKfRz4pM
2026-10-30 21:44:45 -04:00
Claude afca8eb6ea Estimate hooks: replaceable Create Estimate link and per-estimate actions
view_customers_show_estimate_link lets a plugin replace the customer page's
Create Estimate link (which opens QuickBooks). view_estimate_actions adds
links after an estimate on the customer page's list and the issue page.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01BiwYMjhoQvL7XsKKfRz4pM
2026-10-29 23:56:07 -04:00
Claude 6ec8853508 Customer page: actions in the contextual area, with a plugin hook
- New issue, Create estimate, Create payment and Edit now sit in
  Redmine's top-right contextual area (icons, like issue pages) instead
  of an "Actions" column next to the customer details
- New view hook :view_customers_show_contextual (context: customer) for
  plugins to add their own action links there; replaces
  customer_actions_top / customer_actions_bottom (README updated)
- The New issue link still picks up the estimate / vehicle ticked on the
  page (script moved to customers/_new_issue_link_script)

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01BiwYMjhoQvL7XsKKfRz4pM
2026-10-29 23:29:46 -04:00
Claude b99887362f Customer new/edit pages in Redmine's form style
- labelled_form_for with Redmine's "box tabular" layout: labels on the
  left, Display name marked required
- Breadcrumb headings ("Customers » customer"), Create/Save buttons and
  a Cancel link back to the customer (or the customer list)
- Keeps the form tag in the partial and the customer_name / customer_notes
  ids used by redmine_qbo_calendar's quick-create popup (hide_submit /
  hide_toolbar still supported)

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01BiwYMjhoQvL7XsKKfRz4pM
2026-10-29 23:23:18 -04:00
Claude 0dd3073841 Customer page: Edit link in the contextual area instead of a button
Moves "Edit customer" from a button under the actions list to Redmine's
standard top-right contextual area (pencil icon, "e" access key), shown
only to users with Edit customers.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01BiwYMjhoQvL7XsKKfRz4pM
2026-10-29 22:56:06 -04:00
ricky e61217b719 2026.10.1 2026-10-29 21:35:51 -04:00
Claude b8ddf1c38b Issue PDF: allow plugin rows with an HTML value
Rows from the :pdf_left / :pdf_right hooks can now be
[label, text, { html: "..." }]; the value is drawn with writeHTMLCell so
part of it can be bold (used by redmine_qbo_vehicles to bold the last 8
of a VIN). The text still sizes the row, plain rows are unchanged, and
PdfPatch::PDF_HTML_VALUES lets plugins check for support.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01BiwYMjhoQvL7XsKKfRz4pM
2026-10-29 20:21:07 -04:00
Claude f1d81890de Restore AuthHelper#require_user for plugins that still use it
redmine_qbo_vehicles calls before_action :require_user; removing it in
the security fixes would break every vehicles page. It now simply
requires a logged-in user.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01BiwYMjhoQvL7XsKKfRz4pM
2026-10-28 22:57:45 -04:00
ricky 609ddb098a 2026.10.0 2026-10-28 22:32:26 -04:00
Claude c4ab97b75e Customer search: bundled nickname data and sound-alike matching
- Nicknames now come from the carltonnorthern/nicknames data set
  (Apache 2.0, ~2,800 pairs, bundled in data/nicknames with its license),
  plus a few extra groups in EXTRA_NICKNAME_GROUPS. Names match if
  directly linked, or if both are short for the same longer name, so
  Bill/William and Bill/Will match but William/Robert don't (the data
  lists "bill" for both)
- Double Metaphone (text gem) matches names that sound alike but are
  spelled differently: Jon/John, Smyth/Smith, Cathy/Kathy,
  Steven/Stephen, Jeffrey/Geoffrey
- Faster ranking: per-search word-pair scores are cached, whole-name
  comparison only runs when it can succeed, and prepared search data is
  kept in process memory until a customer changes (~40 ms per search at
  5,000 customers)

Adds gem 'text', '~> 1.3' to the Gemfile.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01BiwYMjhoQvL7XsKKfRz4pM
2026-10-28 22:22:00 -04:00
Claude 0523e8dd24 Security, permission and search fixes
Security
- Connecting to QuickBooks (authenticate/oauth_callback) and all syncs
  are admin-only; the OAuth state is stored and verified on callback
- New "Bill issue time to QuickBooks" project permission; billing is now
  a POST and checks the permission and issue visibility
- Estimate/invoice PDFs require a logged-in user, or a customer share
  link limited to the estimate and invoices attached to that issue
  (the old require_user check never ran)
- Attachments patch keeps the share token per request instead of in
  Thread.current, so it can't leak into other requests

Permissions and share links
- customers#autocomplete and the filter_* actions are part of View
  customers, so non-admins can pick customers on forms
- customers#view no longer goes through authorize_global; share needs
  the new "Share issues with customers" permission and a visible issue
- Removed a check in customers#view that compared a value to itself

Bugs
- Subjects and customer names capitalize each word without lowercasing
  the rest (LED, JL, 4x4 stay as typed); subjects only when changed
- Settings page shows Invoice/Estimate sync times (Item/Account models
  no longer exist)
- customers#update shows validation errors instead of reporting success
- Billing marks each activity billed once sent to QBO, so retries and
  token refreshes don't create duplicate TimeActivities

Search
- New CustomerSearchService for autocomplete and the customer search
  page: nicknames (Bill/William), typos, word order, partial words,
  accents, and phone digits in any format; ranked, with the candidate
  list cached until a customer changes

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01BiwYMjhoQvL7XsKKfRz4pM
2026-10-28 22:08:36 -04:00
ricky aacc2d645d Refactor customer form layout for improved readability and structure 2026-10-23 09:34:50 -04:00
ricky cf3342bcc5 2026.9.0 2026-09-09 21:12:57 -04:00
ricky bab019a152 Implement global permissions for customer actions and update views to check permissions before rendering buttons 2026-09-08 22:35:52 -04:00
ricky fd91bd6fa2 Bump version to 2026.8.3 for Redmine QBO plugin 2026-08-26 21:22:12 -04:00
ricky 04a0eede5f Register customer and estimate fields with SubtaskFieldCopier if the plugin is installed, ensuring uniqueness to prevent duplicates. 2026-08-26 21:21:22 -04:00
ricky ba40496421 Enhance autocomplete functionality to support name and phone queries with fuzzy matching 2026-08-25 16:05:51 -04:00
ricky 57dc8127b0 2026.8.2 2026-08-24 20:39:38 -04:00
ricky 9dc4b79355 Refactor customer controller and form to enhance error handling and conditional rendering 2026-08-24 20:17:21 -04:00
ricky 8ae82f1423 Updated pdf patch to support markdown tables 2026-08-18 13:14:53 -04:00
ricky b72c82fb2b Dynamically update the link with estimate id 2026-08-17 21:03:37 -04:00
ricky b901e64149 added new issue link to actions 2026-08-17 20:40:42 -04:00
ricky 7abb1aa06c fixed customer view to show attachments 2026-08-17 20:22:23 -04:00
ricky dfd3a641db Version 2026.8.1 2026-08-12 08:41:31 -04:00
ricky 75e5aeb668 Refactor customer details and form views for improved readability and consistency 2026-08-11 18:39:23 -04:00
ricky ea29990cfa Version 2026.8.0 2026-08-10 19:36:25 -04:00
ricky c31ec82e61 Normalize customer name before saving and update QBO display name accordingly 2026-08-10 15:20:14 -04:00
ricky 938f9d9f3b Add customer action hooks to _actions.html.erb for enhanced integration 2026-08-09 21:09:56 -04:00
ricky f2b0186ee2 Add EstimateService class 2026-08-09 20:50:20 -04:00
ricky 9373963c94 Fix association type for issues in Estimate model 2026-08-09 20:47:55 -04:00
ricky 396a56ceec Refactor associations in IssuePatch for clarity and consistency 2026-08-09 20:47:42 -04:00
ricky b3c3006b56 Added transaltion for Estimate 2026-08-06 16:22:12 -04:00
ricky 576ca5a0a9 Added transation for customer 2026-08-06 16:03:31 -04:00
ricky d18a0c180a added name function to estimate 2026-08-06 07:55:51 -04:00
ricky baca0ed6c7 updated readme 2026-07-02 22:48:25 -04:00
ricky 6bf84dd61a Added payment link 2026-07-01 14:06:02 -04:00
ricky 61b02831e3 removed comment 2026-03-28 06:40:59 -04:00
ricky 7c79f2388a removed Custom Field Synchronization 2026-03-28 00:32:22 -04:00
ricky 36267893bd 2026.3.17 2026-03-28 00:25:55 -04:00
ricky e681203a45 Removed custom field sync, it was never really useful anyways. 2026-03-28 00:25:07 -04:00
ricky 681e7f8047 2026.3.16 2026-03-26 08:13:01 -04:00
ricky 4a6c414d9e Updated customer form to use auto complete to help prevent duplicate customer enteries 2026-03-26 07:56:59 -04:00
ricky 925cb1d2bc 2026.3.15
Note: breaking change, need to update settings
2026-03-22 14:24:22 -04:00
ricky 1dcccd7b98 Merge branch 'master' into rails-7 2026-03-21 10:28:46 -04:00
ricky f73973a4e1 2026.3.14 2026-03-21 10:27:33 -04:00
ricky 7cd388dbd4 Fixed webhook 2026-03-21 10:26:57 -04:00
ricky 7149e85d37 Updated how settings are handled.
Note: Breaking change. Will need to update settings after update
2026-03-21 10:25:46 -04:00
ricky eacdecd65b Updated patches and hooks 2026-03-21 00:09:42 -04:00
ricky ee2ab04206 added placeholder 2026-03-19 18:15:04 -04:00
ricky 8a8c6f5fa0 renamed issue_customer_id to customer_id 2026-03-19 18:07:21 -04:00
ricky cc36bc16b4 use the autocomplete 2026-03-19 10:36:46 -04:00
ricky 874ec7c2dc updated plugin_config screenshot 2026-03-19 09:16:32 -04:00
ricky f3fe38cd57 2026.3.12 2026-03-19 08:34:27 -04:00
ricky 977cbfe0e1 removed coffee-rails 2026-03-19 08:22:25 -04:00
ricky 82712f361c fixed estimate path 2026-03-19 08:07:34 -04:00
ricky 4ae7d75478 removed jquery-ui-rails 2026-03-19 07:57:00 -04:00
ricky 8fb9d74277 removced placeholder for customer field 2026-03-19 07:20:59 -04:00
ricky b0e6236cee removed old autocomplete js 2026-03-18 21:56:52 -04:00
ricky b367687113 Implmented custom autocomplete for customer field 2026-03-18 21:55:55 -04:00
ricky 460bcd466f Fixed routes 2026-03-18 19:11:33 -04:00
ricky 020ea01d36 renamed controllers and updated routes 2026-03-18 00:08:56 -04:00
ricky df079b767c 2026.3.11 2026-03-17 23:37:17 -04:00
ricky 7d3908ec41 fixed estimate#sync 2026-03-17 23:31:42 -04:00
ricky f60e507029 Updated settings page 2026-03-17 21:23:29 -04:00
ricky 3e6650ee65 Merge branch 'master' of https://github.com/rickbarrette/redmine_qbo 2026-03-16 08:20:07 -04:00
ricky c2d0e5c702 Improved qbo hooks to allow a single entity or an array of entities 2026-03-16 08:18:11 -04:00
ricky a4f461fd4d 2026.3.10 2026-03-15 18:01:54 -04:00
ricky 3e81d2840a fixed typo 2026-03-15 17:59:53 -04:00
ricky c9a5dc20f9 Added manual sync links 2026-03-15 08:01:04 -04:00
ricky db3c6021c5 2026.3.9 2026-03-14 21:54:12 -04:00
ricky b8327be5d6 Updated to handle no qbo exception 2026-03-14 21:45:15 -04:00
ricky c4e1ece82c Merge branch 'master' into dev 2026-03-14 17:30:53 -04:00
ricky 9fd7140e4a 2026.3.8 2026-03-14 17:30:22 -04:00
ricky a6c8923ea9 Fixed uncaught exception when there is no QBO connection 2026-03-14 17:27:01 -04:00
ricky eb1174cf7c Updated manual sync to to allow full or partial sync 2026-03-14 15:36:39 -04:00
ricky 7993f15441 updated comments 2026-03-14 15:30:50 -04:00
ricky bb57af71ae Simplified detail calls 2026-03-14 08:20:18 -04:00
ricky 1a10360884 refactored PdfService to use QboConnectionService 2026-03-14 00:16:11 -04:00
ricky cd109f16b5 Refactored QBO service calls 2026-03-14 00:10:10 -04:00
ricky 164252cb97 Refactored PDF services 2026-03-13 23:40:52 -04:00
ricky fd18205c10 Refactored all Sync Jobs into QboSyncJob 2026-03-13 23:26:02 -04:00
ricky 6fc8a18e93 Updated attribute mapping 2026-03-13 15:43:24 -04:00
ricky 8abc95c21e 2026.3.7 2026-03-13 08:35:25 -04:00
ricky 2bcb1840a4 Added qbo_sync flag 2026-03-13 08:33:18 -04:00
ricky c87e18810b Added Attribute Mapping DSL 2026-03-13 08:32:55 -04:00
ricky eb6954ddf1 refactor(sync): improve attribute mapping to support dynamic fields and custom transformations 2026-03-12 21:38:06 -04:00
ricky be1a69217f created a shared helper for authenticated requests. 2026-03-12 21:05:39 -04:00
ricky 99669f7baa created a shared helper for performing authenticated request. 2026-03-12 18:26:21 -04:00
ricky 29530e2c95 fixed order 2026-03-12 17:55:09 -04:00
ricky beb4a66a93 Updated comments 2026-03-12 17:53:06 -04:00
ricky 40f7a3335c Reworked push on save and refactored variable names 2026-03-12 15:58:28 -04:00
ricky da0f7ffc56 2026.3.6
Refactored models and services to use a base class
2026-03-12 11:21:42 -04:00
ricky 4fa8be856a Refactored models to use base model 2026-03-12 11:14:45 -04:00
ricky ffd8dc6332 Refactored Customer service to use a service base class 2026-03-12 09:48:36 -04:00
ricky cd219a0c00 fixed spelling entities 2026-03-11 20:01:14 -04:00
ricky cd88ce6217 2026.3.5 2026-03-09 08:22:26 -04:00
ricky b10665355d Allow Subclasses to override the page size 2026-03-08 23:34:37 -04:00
ricky 17ac19e435 2026.3.4 2026-03-08 21:59:47 -04:00
ricky ef5089438c Fixed query_in_batches 2026-03-08 21:51:31 -04:00
ricky 1f64e36892 2026.3.3 2026-03-08 15:22:20 -04:00
ricky 643b15391b Added support for adding other QBO entities from othe plugins 2026-03-08 15:04:57 -04:00
ricky d8a26f98c0 updaed readme 2026-03-07 13:28:31 -05:00
ricky 8fc01cd8fb Updated Readme 2026-03-06 23:05:43 -05:00
ricky fe3da8c452 removed redundant exception 2026-03-05 22:03:22 -05:00
ricky c4c02f8d27 2026.3.2 2026-03-05 21:34:20 -05:00
ricky 00b1baa1f3 Fixed create new customer 2026-03-05 21:33:49 -05:00
128 changed files with 10801 additions and 1365 deletions

No files matched your search

+2 -5
View File
@@ -4,11 +4,8 @@ gem 'quickbooks-ruby'
gem 'oauth2' gem 'oauth2'
gem 'roxml' gem 'roxml'
gem 'will_paginate' gem 'will_paginate'
gem 'rails-jquery-autocomplete'
gem 'jquery-ui-rails'
gem 'rexml' gem 'rexml'
gem 'combine_pdf' gem 'combine_pdf'
group :assets do # Double Metaphone sound-alike matching for customer search (CustomerSearchService)
gem 'coffee-rails' gem 'text', '~> 1.3'
end
+325 -75
View File
@@ -1,14 +1,21 @@
# Redmine QuickBooks Online # Redmine QuickBooks Online Plugin
A plugin for Redmine to connect to QuickBooks Online. A plugin for **Redmine** that integrates with **QuickBooks Online (QBO)** to automatically create **Time Activity entries** from billable hours logged on Issues.
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. When an Issue associated with a Customer is closed, the plugin generates corresponding Time Activities in QuickBooks based on the Redmine Time Entries recorded for that Issue.
## Disclaimer ---
**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. # Disclaimer
## Compatibility The core functionality is implemented, but the project is **under active development**.
The `master` branch may contain unstable changes.
For production deployments, **use a tagged release**.
---
# Compatibility
| Plugin Version | Redmine Version | | Plugin Version | Redmine Version |
| :--- | :--- | | :--- | :--- |
@@ -17,85 +24,328 @@ The goal of this project is to allow Redmine to connect with QuickBooks Online t
| Version 1.0.0+ | Redmine 4 | | Version 1.0.0+ | Redmine 4 |
| Version 0.8.1 | Redmine 3 | | Version 0.8.1 | Redmine 3 |
## Features ---
* **Customer Assignment:** Issues can be assigned to a Customer via a dropdown in the edit Issue form. # Features
* Once a customer is attached to an Issue, you can attach an Estimate to the issue via a dropdown menu.
* **Employee Mapping:** An Employee is assigned to a Redmine User via a dropdown in the User Administration page.
* **Automatic Billing:** If an Issue has been assigned a Customer, the following happens when the Issue is closed:
* A new Time Activity will be billed against the Customer assigned to the issue for each Redmine Time Entry.
* Time Entries will be totalled up by Activity name. This allows billing for different activities without having to create separate Issues.
* The Time Activity names are used to dynamically lookup Items in QuickBooks.
* 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.
* **Plugin View Hooks** Allows intergration of other features supported by companion plugins, for example [redmine_qbo_vehicles](https://github.com/rickbarrette/redmine_qbo_vehicles) adds customer vehicle interation
## Prerequisites ## Issue Billing Integration
* Sign up to become a developer for Intuit: https://developer.intuit.com/ * Assign a **QuickBooks Customer** to a Redmine Issue.
* Create your own application to obtain your API keys.
* Set up the webhook service to `https://redmine.yourdomain.com/qbo/webhook`
## Installation * Optionally associate a **QuickBooks Estimate** with the Issue.
1. **Clone the plugin:** * Automatically associates a **QuickBooks Invoice** with the Issue.
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>
```
2. **Install dependencies:** *Crucial for Redmine 6 / Rails 7 compatibility.*
Bash
```
bundle install
```
3. **Migrate your database:**
Bash
```
bundle exec rake redmine:plugins:migrate RAILS_ENV=production
```
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 ---
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. ## Automatic Time Activity Creation
**Note:** After the initial synchronization, this plugin will receive push notifications via Intuit's webhook service. When an Issue with an assigned Customer is closed:
## Companion Plugin Hooks * A **Time Activity** is created in QuickBooks for each relevant Redmine Time Entry.
* :pdf_left, { issue: issue }
* :pdf_right, { issue: issue } * Time Entries are **grouped by Activity name**.
* :process_invoice_custom_fields, { issue: issue, invoice: invoice }
* :show_customer_view_right, {customer: @customer} * Activity names are used to **dynamically match Items in QuickBooks**.
* If no matching Item exists, the activity is **skipped**.
* **Labor rates** are determined by the associated QuickBooks Item.
---
## Employee Mapping
Redmine Users can be mapped to **QuickBooks Employees** through the **User Administration** page.
This ensures Time Activities are recorded under the correct employee in QuickBooks.
---
## Customer Management
The plugin provides basic Customer management:
* Create Customers directly from Redmine
* Search Customers by **name or phone number**
* View and edit Customer information
Customers are synchronized with QuickBooks.
---
## Webhook Support
The plugin listens for **QuickBooks webhook events**.
Supported automation:
### Invoice Linking
Invoices containing an Issue reference (e.g. `#123`) automatically attach to the corresponding Issue.
### Customer Synchronization
Customer records are automatically updated in the local database when changes occur in QuickBooks.
---
## Billing: Estimates, Invoices and Payments
* **New estimate** from the customer page: Create Estimate opens the Redmine editor. The customer page no longer links to QuickBooks' estimate or payment screens; the customer's name still opens their QuickBooks account page as a fallback.
* **Edit** any estimate from the Edit link next to it on the customer page or the issue page.
* **Duplicate** an estimate to start a similar one: same customer, lines, subtotals, VIN and messages, dated today, with the current user as sales person.
* **Read-only once linked to an issue**: an estimate that an issue is linked to can be viewed, emailed and duplicated, but not changed, so the work doesn't drift from what was quoted. The list shows a View link for these instead of Edit.
* **Create issues** from an estimate's labor lines (moved here from redmine_qbo_calendar): each line whose item matches an **estimate item code** (e.g. Labor) becomes an issue with the line's description as subject and its quantity as estimated hours. Pick the project, trackers, templates and shared custom fields first. Lines already turned into issues can't be created twice, and issues from the same estimate are related to each other. Opened from an appointment, the issues get the appointment's dates, technician and vehicle.
* **Email** the estimate with QuickBooks' own estimate email, with **Save and send** or the Email link.
* The page follows QuickBooks' estimate screen: customer, customer email, billing address, estimate date, expiration date, estimate number, then the product/service lines (#, product/service, description, qty, rate, amount, tax), the message displayed on the estimate, the memo, and the totals.
* Lines work like QuickBooks: the product list opens when the box is clicked, picking a product fills in its description, rate and tax, typing an amount works out the rate, a spare empty line is always at the bottom, and lines are reordered by dragging them by the handle.
* A line with a description but no product or rate is saved as a description-only line, e.g. the estimate notes on the first line.
* **Add subtotal** puts a subtotal line after the last filled line. A subtotal totals the lines above it, back to the previous subtotal, and can be dragged like any line. It's saved the way QuickBooks saves subtotals from its own screen, as a line reading "Subtotal: $342.60" that prints where it was placed, so the PDF keeps its layout.
* Sales tax is worked out by QuickBooks when the estimate is saved.
### Invoices
* **Create invoice** on an estimate's page makes an invoice from it (customer, lines, subtotals, VIN), like QuickBooks' "Create invoice". **Create invoice** on the customer page starts a blank one, and the Edit link next to each invoice on the customer page opens it.
* **Import time & estimates** lists the customer's billable QuickBooks time (the time activities redmine_qbo makes from an issue's time entries) and their open estimates (e.g. the ones redmine_qbo_lineitems makes for parts that weren't quoted).
* Tick the time to bill and, under **Replace these lines**, the lines it replaces (e.g. the estimate's labor lines). When products/services are set as **Replaced by imported time** in the plugin settings, only lines with one of them are offered there; with none set, every line is. The time goes where the first ticked line was and the ticked lines are removed, so the invoice reads in the same order.
* Ticked estimates go right after the time for the same issue: a redmine_qbo_lineitems estimate starting "Added from: Install #116: …" lands after the time for #116, without that note line, since the time line already names the issue. Estimates with no matching time keep the note and go at the end.
* **Undo import** puts the lines back until the invoice is saved.
* **An estimate is billed once**: an estimate that's on an invoice (linked to one, or closed) or was rejected can't be made into an invoice or imported, and its page shows the invoice it's billed on. This is checked against QuickBooks again when the invoice is saved, so an estimate invoiced meanwhile (in another tab, by someone else, or in QuickBooks) stops the save.
* Time lines are linked to their time activities, so QuickBooks marks the time as billed. Estimates the invoice was made from, or imported into it, are linked and closed when it's saved.
* **VIN and mileage from the work orders**: the issues behind an invoice are the ones its time lines and lineitems estimates name. When they're imported, the VIN box takes their vehicle's VIN (with redmine_qbo_vehicles) and a **Mileage** box (shown when QuickBooks has a text custom field named like "Mileage") takes the highest value of the issues' Mileage custom field. With redmine_qbo_vehicles, an invoice whose work orders are for more than one vehicle isn't saved.
* **Sales person**: an invoice credits the sales person on the estimate it was made from (the first linked estimate that names one); if none does, the user who writes the invoice.
* Invoices with a payment applied open read-only. The due date is left to QuickBooks (from the customer's terms) unless one is picked. The "default message shown on invoices" fills in the message.
### Payments
* **Receive payment** on the customer page or on an unpaid invoice: the customer, payment date, payment method (QuickBooks' list: Cash, Check...), reference number (e.g. the check number), amount and a memo.
* Tick open invoices to fill in the amount (their open balances added up) and pay just those; the header box ticks them all.
* With none ticked, the payment is applied to the customer's open invoices **oldest first**, like QuickBooks does; the page shows how it will be split as the amount is typed, and it's worked out again from QuickBooks when saving. Anything more than the open balances stays as a credit.
* Tick **Deposit** to keep the whole payment as a credit on the customer's account without paying any invoice (also what happens when there are no open invoices).
* The saved payment's page shows where it was applied and has **Print**, QuickBooks' payment PDF.
* **Payments** on the customer page lists all of the customer's payments from QuickBooks, newest first: date, method, reference no., the invoices each was applied to (or Deposit), memo, amount and what's still unapplied, with totals. Each date opens the payment's page and **Print** opens its PDF.
### QuickBooks custom fields
Nothing is configured in Redmine. The plugin reads QuickBooks' sales form settings, and the custom fields on the 20 most recently changed estimates, and finds the fields by name:
* A text field whose name contains **VIN** gets the VIN box. The customer's vehicles (from redmine_qbo_vehicles) are offered as choices.
* A text field whose name contains **Sales** or **Rep** (e.g. "Sales Person", "Salesperson", "Sales Rep") gets the name of the Redmine user who creates the estimate. Editing an estimate keeps its sales person.
QuickBooks only shares its first three **text** custom fields with apps; dropdown custom fields can't be read or filled in. If your sales person field is a dropdown, change it to a text field in QuickBooks (Settings → Custom fields).
Newer QuickBooks custom fields (made under Settings → Custom fields) aren't listed in QuickBooks' settings, so the plugin asks QuickBooks for all custom fields on estimates and finds them on the most recently changed ones. If a new field isn't found, fill it in on one estimate in QuickBooks, then refresh.
The settings are read once an hour (every five minutes while the VIN or sales person field is missing). After adding or renaming a custom field in QuickBooks, an administrator can use **Refresh QuickBooks fields** on the estimate page, which also lists the fields QuickBooks shares. Newer QuickBooks custom fields (e.g. on Advanced and sandbox companies) may not be listed in its settings; they're found once they're filled in on at least one estimate.
Estimate numbers can't be typed. QuickBooks numbers new estimates; when its "Custom transaction numbers" setting is on, the next number is filled in when the estimate is created. The "default message shown on estimates" fills in the message on new estimates.
### Products/services and accounts
Administration → Items lists the QuickBooks product/service list (synced from QuickBooks, and pushed back when an item is added or edited here). Accounts are reached from there. The plugin settings show the counts, the default income account for new items, and Sync buttons. These moved here from redmine_qbo_lineitems with the same URLs.
### What is left to QuickBooks
* Estimates with bundles open read-only, so a bundle can't be broken apart by accident.
* The sales person box is read-only: it shows who created the estimate.
* Discounts on an estimate are kept as they are; they can't be edited here.
* If an estimate was changed in QuickBooks after it was opened in Redmine, saving stops and asks to reload it, so nobody's changes are overwritten.
### Billing Settings and Permissions
1. Permissions
1. Navigate to Administration -> Roles and permissions.
2. Assign these global permissions as needed:
* **Write estimates**: create and edit estimates
* **Email estimates**: email estimates to customers (Save and send, and the Email link)
* **Create issues from estimates**: the Create issues page (was redmine_qbo_calendar's "Create issues from appointment estimates")
* **View payments**: a customer's Payments list, the payment page and its PDF
* **Receive payments**: the Receive payment page, plus everything View payments allows
* **Write invoices**: create and edit invoices, and import time and estimates into them
* **Email invoices**: email invoices to customers
2. Settings (Administration -> Plugins -> Configure)
* **Estimates expire after (days)**: new estimates get an expiration date this many days after the estimate date (e.g. 30). Leave blank for none.
* **Issues from estimates**: the estimate item codes (also an estimate's labor hours, which an appointment's hours can't be less than), the default project and the default tracker. Until saved here, redmine_qbo_calendar's old values are used.
* **Replaced by imported time**: the products/services (e.g. Labor) whose invoice lines time can replace. Only those lines are offered under Replace these lines; leave empty to offer every line.
* Item and account counts, the default income account, and Sync Items / Sync Accounts.
3. Writing an estimate
1. Open the customer and click **Create Estimate**.
2. Fill in the lines. Type in the product/service box or click it to pick from the list.
3. Click **Save**, or **Save and send** to email it to the customer email.
## Plugin Hooks
The plugin exposes several hooks for extending functionality through companion plugins.
Example:
`redmine_qbo_vehicles`
Adds support for tracking **customer vehicles** associated with Issues.
Available hooks:
|Type|Hook|Note
|--|--|--|
View Hook|:view_customers_show_contextual, { customer: @customer } | Used to add action links to the customer page's top-right action area (return links styled like Redmine's, e.g. `link_to sprite_icon('add', 'Label'), path, class: 'icon icon-add'`). Replaces `customer_actions_top` / `customer_actions_bottom`
View Hook|:pdf_left, { issue: issue } | Used to add text to left side of PDF
View Hook|:pdf_right, { issue: issue } | Used to add text to right side of PDF
View Hook|:show_customer_view_right, { customer: customer } | Used to show partials on right side of customer view
Hook| :qbo_additional_entities | Used to add additional entites to be processed by the WebhookProcessJob
Hook| :qbo_full_sync | Used to add a Class to be called by the QboSyncDispatcher
Hook|:qbo_billing_issue_values, { issues: } | Return `{ field => { issue_id => value } }` for the work orders behind an invoice, e.g. `{ vin: { 116 => "1C4..." } }` (redmine_qbo_vehicles). Importing time or estimates fills the VIN box when the work orders share one VIN, and the mileage box with the highest mileage (read from the issue custom field named "Mileage")
Hook|:qbo_billing_validate, { document:, form:, issues: } | Return an error message (or several) to stop an estimate or invoice from saving, e.g. redmine_qbo_vehicles: one vehicle per invoice
Hook|:qbo_billing_issue_defaults, { estimate:, params: } | Return `start_date`, `due_date`, `assignee`, `vehicle_id`, `project`, `description`, `return_path`, `return_label` for issues created from an estimate (redmine_qbo_calendar, when opened from an appointment)
Hook|:qbo_billing_issues_created, { estimate:, issues:, params: } | Called after issues are created from an estimate
View Hook|:view_qbo_estimate_contextual, { estimate_id:, customer_id:, vin:, doc_number: } | Adds links to an estimate page's action area (e.g. redmine_qbo_calendar's Add appointment)
Other plugins create estimates with `RedmineQboBilling::EstimateWriter.create_estimate(customer:, lines:, private_note:, vin:, mileage:, user:)`; each line is a hash of `description`, `item_id`, `quantity`, `rate` and `taxable`.
---
# Prerequisites
Before installing the plugin:
1. Create a QuickBooks developer account:
[https://developer.intuit.com/](https://developer.intuit.com/)
2. Create an **Intuit application** to obtain:
* Client ID
* Client Secret
3. Configure the QuickBooks webhook endpoint:
https://redmine.yourdomain.com/qbo/webhook
---
# Installation
## 1. Clone the Plugin
Install the plugin into your Redmine plugins directory.
```bash
cd /path/to/redmine/plugins
git clone https://github.com/rickbarrette/redmine_qbo.git
cd redmine_qbo
git checkout <tag>
```
Use a **tagged release** for stability.
---
## 2. Install Dependencies
```bash
bundle install
```
Required for **Redmine 6 / Rails 7 compatibility**.
---
## 3. Run Database Migrations
```bash
bundle exec rake redmine:plugins:migrate RAILS_ENV=production
```
---
## 4. Restart Redmine
Restart your Redmine server so the plugin and hooks are loaded.
---
# Configuration
1. Navigate to:
Administration → Plugins → Configure
2. Enter your **QuickBooks Client ID and Client Secret**.
3. Save the configuration.
4. Click **Authenticate** to complete the OAuth connection with QuickBooks Online.
Once authentication succeeds, the plugin performs an **initial synchronization**.
---
# User Mapping
Each Redmine user must be mapped to a QuickBooks Employee.
Navigate to:
Administration → Users
Then assign the corresponding **QuickBooks Employee** to each user.
---
# Usage
To enable automatic billing:
1. Assign a **Customer** to an Issue.
2. Log billable time using **Redmine Time Entries**.
3. Close the Issue.
When the Issue is closed, the plugin automatically generates the corresponding **Time Activity entries in QuickBooks Online**.
After the initial synchronization, the plugin receives updates through **Intuit webhooks**.
---
# Troubleshooting
### Time Activities Not Created
Verify that:
* The Issue has a **Customer assigned**
* Time Entries exist for the Issue
* Activity names match **QuickBooks Item names**
---
### Webhooks Not Triggering
Ensure the QuickBooks webhook endpoint is reachable:
https://redmine.yourdomain.com/qbo/webhook
Also verify webhook configuration in the Intuit developer dashboard.
## License ## License
Binary file not shown.

Before

Width:  |  Height:  |  Size: 672 KiB

After

Width:  |  Height:  |  Size: 269 KiB

+37
View File
@@ -0,0 +1,37 @@
#The MIT License (MIT)
#
#Copyright (c) 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:
#
#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.
class AccountsController < ApplicationController
layout 'admin'
menu_item :redmine_qbo_items
# Accounts come from QuickBooks; choosing the default and syncing are admin-only
before_action :require_admin
def index
@accounts = Account.where(classification: 'Revenue').order(:name)
end
def set_default
account = Account.find_by(id: params[:default_account_id])
if account&.update(default: true)
flash[:notice] = l(:notice_default_account_updated)
else
flash[:error] = l(:error_default_account_not_selected)
end
redirect_to accounts_path
end
def sync
Account.sync
redirect_to :home, flash: { notice: I18n.t(:label_syncing) }
end
end
+136 -123
View File
@@ -8,7 +8,6 @@
# #
#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.
# This controller class will handle map management
class CustomersController < ApplicationController class CustomersController < ApplicationController
include AuthHelper include AuthHelper
@@ -26,57 +25,160 @@ class CustomersController < ApplicationController
include SortHelper include SortHelper
helper :timelog helper :timelog
before_action :add_customer, only: :new # This tells Redmine to check global permissions for the current controller/action
before_action :view_customer, except: [:new, :view] # customers#view is the public share-link page: it is authorized by its token, not by Redmine permissions
before_action :authorize_global, except: [:view]
before_action :add_customer, only: [:new, :create]
before_action :view_customer, except: [:new, :create, :view, :share, :sync]
before_action :require_admin, only: :sync
skip_before_action :verify_authenticity_token, :check_if_login_required, only: [:view] skip_before_action :verify_authenticity_token, :check_if_login_required, only: [:view]
autocomplete :customer, :name, full: true, extra_data: [:id] def address_to_s(address)
return if address.nil?
lines = [
address.line1,
address.line2,
address.line3,
address.line4,
address.line5
].compact_blank
city_line = [
address.city,
address.country_sub_division_code,
address.postal_code
].compact_blank.join(" ")
lines << city_line unless city_line.blank?
lines.join("\n")
end
def add_customer
global_check_permission(:add_customers)
end
def allowed_params def allowed_params
params.require(:customer).permit(:name, :email, :primary_phone, :mobile_phone, :phone_number, :notes) params.require(:customer).permit(:name, :email, :primary_phone, :mobile_phone, :phone_number, :notes)
end end
# getter method for a customer's invoices # Used for autocomplete forms. Fuzzy matching (nicknames, typos, word order, phone digits) helps
# used for customer autocomplete field / issue form # staff spot an existing customer before creating a duplicate. See CustomerSearchService.
def filter_invoices_by_customer def autocomplete
@filtered_invoices = Invoice.all.where(customer_id: params[:selected_customer]) name_query = (params[:name] || params[:q] || params[:term]).to_s.strip
items = CustomerSearchService.call(name: name_query, phone: params[:phone])
render json: items.map { |i|
{ id: i.id, name: i.name, phone_number: i.phone_number, mobile_phone_number: i.mobile_phone_number }
}
end
def create
@customer = Customer.new(allowed_params)
respond_to do |format|
if @customer.save
log "Customer ##{@customer.id} created successfully."
format.html { redirect_to @customer, notice: l(:notice_successful_create) }
format.json { render json: { id: @customer.id, name: @customer.name }, status: :created }
else
format.html { render :new }
format.json { render json: { errors: @customer.errors.full_messages }, status: :unprocessable_entity }
end
end
rescue => e
log "Failed to create customer: #{e.message}"
respond_to do |format|
format.html {
flash[:error] = e.message
redirect_to new_customer_path
}
format.json {
render json: { errors: [e.message] }, status: :internal_server_error
}
end
end
def edit
@customer = Customer.find_by_id(params[:id])
return render_404 unless @customer
rescue => e
log "Failed to edit customer"
flash[:error] = e.message
render_404
end end
# getter method for a customer's estimates
# used for customer autocomplete field / issue form
def filter_estimates_by_customer def filter_estimates_by_customer
@filtered_estimates = Estimate.all.where(customer_id: params[:selected_customer]) @filtered_estimates = Estimate.all.where(customer_id: params[:selected_customer])
end end
# display a list of all customers def filter_invoices_by_customer
@filtered_invoices = Invoice.all.where(customer_id: params[:selected_customer])
end
def index def index
if params[:search] if params[:search]
@customers = Customer.search(params[:search]).order(:name).paginate(page: params[:page]) @customers = CustomerSearchService.call(name: params[:search], limit: 200).paginate(page: params[:page])
if only_one_non_zero?(@customers) if only_one_non_zero?(@customers)
redirect_to @customers.first redirect_to @customers.first
end end
end end
end end
# initialize a new customer def load_issue_data
@journals = @issue.journals.preload(:details).preload(user: :email_address).reorder(:created_on, :id).to_a
@journals.each_with_index { |j, i| j.indice = i + 1 }
@journals.reject!(&:private_notes?) unless User.current.allowed_to?(:view_private_notes, @issue.project)
Journal.preload_journals_details_custom_fields(@journals)
@journals.select! { |journal| journal.notes? || journal.visible_details.any? }
@journals.reverse! if User.current.wants_comments_in_reverse_order?
@changesets = @issue.changesets.visible.preload(:repository, :user).to_a
@changesets.reverse! if User.current.wants_comments_in_reverse_order?
@relations = @issue.relations.select { |r| r.other_issue(@issue)&.visible? }
@allowed_statuses = @issue.new_statuses_allowed_to(User.current)
@priorities = IssuePriority.active
@time_entry = TimeEntry.new(issue: @issue, project: @issue.project)
@relation = IssueRelation.new
end
def log(msg)
Rails.logger.info "[CustomersController] #{msg}"
end
def new def new
@customer = Customer.new @customer = Customer.new
if request.xhr?
render partial: 'form', layout: false, locals: { hide_submit: true, hide_toolbar: true }
end
end end
# create a new customer def only_one_non_zero?(array)
def create found_non_zero = false
@customer = Customer.new(allowed_params) array.each do |val|
@customer.save if val != 0
log "Customer ##{@customer.id} created successfully." return false if found_non_zero
flash[:notice] = t :notice_customer_created found_non_zero = true
redirect_to @customer end
rescue => e end
log "Failed to create customer: #{e.message}" found_non_zero
flash[:error] = e.message end
redirect_to new_customer_path
def share
issue = Issue.visible.find(params[:id])
token = issue.share_token
return render_403 unless token
redirect_to view_path(token.token)
rescue ActiveRecord::RecordNotFound
flash[:error] = t(:notice_issue_not_found)
render_404
end end
# display a specific customer
def show def show
@customer = Customer.find_by_id(params[:id]) @customer = Customer.find_by_id(params[:id])
return render_404 unless @customer return render_404 unless @customer
@@ -109,130 +211,41 @@ class CustomersController < ApplicationController
render_404 render_404
end end
# return an HTML form for editing a customer def sync
def edit Customer.sync
@customer = Customer.find_by_id(params[:id]) redirect_to :home, flash: { notice: I18n.t(:label_syncing) }
return render_404 unless @customer
rescue => e
log "Failed to edit customer"
flash[:error] = e.message
render_404
end end
# update a specific customer
def update def update
@customer = Customer.find_by_id(params[:id]) @customer = Customer.find_by_id(params[:id])
@customer.update(allowed_params) return render_404 unless @customer
if @customer.update(allowed_params)
flash[:notice] = t :notice_customer_updated flash[:notice] = t :notice_customer_updated
redirect_to @customer redirect_to @customer
else
render :edit, status: :unprocessable_entity
end
rescue => e rescue => e
log "Failed to update customer: #{e.message}" log "Failed to update customer: #{e.message}"
flash[:error] = e.message flash[:error] = e.message
redirect_to edit_customer_path redirect_to edit_customer_path
end end
# creates new customer view tokens, removes expired tokens & redirects to newly created customer view with new token.
def share
issue = Issue.find(params[:id])
token = issue.share_token
redirect_to view_path(token.token)
rescue ActiveRecord::RecordNotFound
flash[:error] = t(:notice_issue_not_found)
render_404
end
# displays an issue for a customer with a provided security CustomerToken
def view def view
User.current = User.anonymous User.current = User.anonymous
# Load only active, non-expired token
@token = CustomerToken.active.find_by(token: params[:token]) @token = CustomerToken.active.find_by(token: params[:token])
return render_403 unless @token return render_403 unless @token
# Load associated issue
@issue = @token.issue @issue = @token.issue
return render_403 unless @issue return render_403 unless @issue
# Optional: enforce token belongs to the issue's customer
return render_403 unless @issue.customer_id == @token.issue.customer_id
# Store token in session for subsequent requests if needed
session[:token] = @token.token session[:token] = @token.token
load_issue_data load_issue_data
rescue ActiveRecord::RecordNotFound rescue ActiveRecord::RecordNotFound
render_403 render_403
end end
private
def load_issue_data
@journals = @issue.journals.preload(:details).preload(user: :email_address).reorder(:created_on, :id).to_a
@journals.each_with_index { |j, i| j.indice = i + 1 }
@journals.reject!(&:private_notes?) unless User.current.allowed_to?(:view_private_notes, @issue.project)
Journal.preload_journals_details_custom_fields(@journals)
@journals.select! { |journal| journal.notes? || journal.visible_details.any? }
@journals.reverse! if User.current.wants_comments_in_reverse_order?
@changesets = @issue.changesets.visible.preload(:repository, :user).to_a
@changesets.reverse! if User.current.wants_comments_in_reverse_order?
@relations = @issue.relations.select { |r| r.other_issue(@issue)&.visible? }
@allowed_statuses = @issue.new_statuses_allowed_to(User.current)
@priorities = IssuePriority.active
@time_entry = TimeEntry.new(issue: @issue, project: @issue.project)
@relation = IssueRelation.new
end
# redmine permission - add customers
def add_customer
global_check_permission(:add_customers)
end
# redmine permission - view customers
def view_customer def view_customer
global_check_permission(:view_customers) global_check_permission(:view_customers)
end end
# checks to see if there is only one item in an array
# @return true if array only has one item
def only_one_non_zero?( array )
found_non_zero = false
array.each do |val|
if val!=0
return false if found_non_zero
found_non_zero = true
end
end
found_non_zero
end
# format a quickbooks address to a human readable string
def address_to_s(address)
return if address.nil?
lines = [
address.line1,
address.line2,
address.line3,
address.line4,
address.line5
].compact_blank
city_line = [
address.city,
address.country_sub_division_code,
address.postal_code
].compact_blank.join(" ")
lines << city_line unless city_line.blank?
lines.join("\n")
end
def log(msg)
Rails.logger.info "[CustomersController] #{msg}"
end
end end
@@ -7,30 +7,21 @@
#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.
class EmployeesController < ApplicationController
include AuthHelper
class InvoiceSyncJob < ApplicationJob # Syncing is admin-only
queue_as :default before_action :require_admin
retry_on StandardError, wait: 5.minutes, attempts: 5
# Performs a sync of invoices from QuickBooks Online. def sync
def perform(full_sync: false, id: nil) Employee.sync
qbo = QboConnectionService.current! redirect_to :home, flash: { notice: I18n.t(:label_syncing) }
raise "No QBO configuration found" unless qbo
log "Starting #{full_sync ? 'full' : 'incremental'} sync for invoice ##{id || 'all'}..."
service = InvoiceSyncService.new(qbo: qbo)
if id.present?
service.sync_by_id(id)
else
service.sync(full_sync: full_sync)
end
end end
private private
# Logs messages with a consistent prefix for easier debugging.
def log(msg) def log(msg)
Rails.logger.info "[InvoiceSyncJob] #{msg}" Rails.logger.info "[EmployeeController] #{msg}"
end end
end end
@@ -7,13 +7,18 @@
#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.
class EstimateController < ApplicationController class EstimatesController < ApplicationController
include AuthHelper include AuthHelper
before_action :require_user, unless: -> { session[:token].nil? } # PDFs: logged-in users, or a customer with a share link (limited to their issue's estimate).
skip_before_action :verify_authenticity_token, :check_if_login_required, unless: -> { session[:token].nil? } # Redmine's own login check is replaced by require_login_or_customer_token for these actions.
skip_before_action :check_if_login_required, only: [:show, :doc]
before_action :require_login_or_customer_token, only: [:show, :doc]
before_action :load_estimate, only: [:show, :doc] before_action :load_estimate, only: [:show, :doc]
# Syncing is admin-only
before_action :require_admin, only: :sync
# Displays the estimate PDF in the browser or redirects with an error if not found. # Displays the estimate PDF in the browser or redirects with an error if not found.
def doc def doc
render_pdf(@estimate) render_pdf(@estimate)
@@ -24,11 +29,20 @@ class EstimateController < ApplicationController
render_pdf(@estimate) render_pdf(@estimate)
end end
def sync
Estimate.sync
redirect_to :home, flash: { notice: I18n.t(:label_syncing) }
end
private private
# Loads the estimate based on ID or doc number, with a fallback to sync if not found locally. # Loads the estimate based on ID or doc number, with a fallback to sync if not found locally.
def load_estimate def load_estimate
log "Attempting to load Estimate with params: #{params.inspect}" log "Attempting to load Estimate with params: #{params.inspect}"
# Share-link customers may only open the estimate attached to their issue (checked before any sync)
return load_customer_estimate if customer_token_only?
@estimate = find_estimate || sync_and_find_estimate @estimate = find_estimate || sync_and_find_estimate
unless @estimate unless @estimate
@@ -36,6 +50,21 @@ class EstimateController < ApplicationController
end end
end end
# For share-link customers: only the estimate attached to the token's issue, by ID or doc number.
def load_customer_estimate
estimate = customer_token.issue&.estimate
requested =
if params[:search].present?
estimate && estimate.doc_number.to_s == params[:search].to_s
else
estimate && estimate.id.to_s == params[:id].to_s
end
return render_403 unless requested
@estimate = estimate
end
# Attempts to find the estimate locally by ID or doc number. # Attempts to find the estimate locally by ID or doc number.
def find_estimate def find_estimate
return Estimate.find_by(doc_number: params[:search]) if params[:search].present? return Estimate.find_by(doc_number: params[:search]) if params[:search].present?
@@ -65,7 +94,7 @@ class EstimateController < ApplicationController
# Renders the estimate PDF or redirects with an error if rendering fails. # Renders the estimate PDF or redirects with an error if rendering fails.
def render_pdf(estimate) def render_pdf(estimate)
pdf, ref = EstimatePdfService.new(qbo: QboConnectionService.current!).fetch_pdf(doc_ids: [estimate.id]) pdf, ref = PdfService.new(entity: Estimate).fetch_pdf(doc_ids: [estimate.id])
send_data( pdf, filename: "estimate #{ref}.pdf", disposition: :inline, type: "application/pdf" ) send_data( pdf, filename: "estimate #{ref}.pdf", disposition: :inline, type: "application/pdf" )
rescue StandardError => e rescue StandardError => e
log "PDF render failed for Estimate #{estimate&.id}: #{e.message}" log "PDF render failed for Estimate #{estimate&.id}: #{e.message}"
@@ -7,18 +7,23 @@
#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.
class InvoiceController < ApplicationController class InvoicesController < ApplicationController
include AuthHelper include AuthHelper
before_action :require_user, unless: -> { session[:token].nil? } # PDFs: logged-in users, or a customer with a share link (limited to their issue's invoices).
skip_before_action :verify_authenticity_token, :check_if_login_required, unless: -> { session[:token].nil? } # Redmine's own login check is replaced by require_login_or_customer_token for this action.
skip_before_action :check_if_login_required, only: :show
before_action :require_login_or_customer_token, only: :show
before_action :authorize_customer_invoices, only: :show
# Syncing is admin-only
before_action :require_admin, only: :sync
# Displays the invoice PDF in the browser or redirects with an error if not found. # Displays the invoice PDF in the browser or redirects with an error if not found.
def show def show
log "Processing request for #{request.original_url}" log "Processing request for #{request.original_url}"
invoice_ids = Array(params[:invoice_ids] || params[:id]) pdf, ref = PdfService.new(entity: Invoice).fetch_pdf(doc_ids: invoice_ids)
pdf, ref = InvoicePdfService.new(qbo: QboConnectionService.current!).fetch_pdf(doc_ids: invoice_ids)
send_data pdf, filename: "invoice #{ref}.pdf", disposition: :inline, type: "application/pdf" send_data pdf, filename: "invoice #{ref}.pdf", disposition: :inline, type: "application/pdf"
@@ -27,8 +32,25 @@ class InvoiceController < ApplicationController
redirect_back fallback_location: root_path, flash: { error: I18n.t(:notice_invoice_not_found) } redirect_back fallback_location: root_path, flash: { error: I18n.t(:notice_invoice_not_found) }
end end
def sync
Invoice.sync
redirect_to :home, flash: { notice: I18n.t(:label_syncing) }
end
private private
def invoice_ids
@invoice_ids ||= Array(params[:invoice_ids] || params[:id]).map(&:to_s).reject(&:blank?)
end
# Share-link customers may only open invoices attached to their issue
def authorize_customer_invoices
return true unless customer_token_only?
allowed = customer_token.issue&.invoice_ids.to_a.map(&:to_s)
render_403 if invoice_ids.empty? || (invoice_ids - allowed).any?
end
# Logs messages with a consistent prefix for easier debugging. # Logs messages with a consistent prefix for easier debugging.
def log(msg) def log(msg)
Rails.logger.info "[InvoiceController] #{msg}" Rails.logger.info "[InvoiceController] #{msg}"
+106
View File
@@ -0,0 +1,106 @@
#The MIT License (MIT)
#
#Copyright (c) 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:
#
#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.
class ItemsController < ApplicationController
layout 'admin'
menu_item :redmine_qbo_items
# The item catalog is pushed to QuickBooks, so managing it is admin-only. The autocomplete feeds the
# line item form on issues and is allowed with the "Add line items" or "Edit line items" permission.
before_action :require_admin, except: :autocomplete
before_action :authorize_global, only: :autocomplete
before_action :find_item, only: [:show, :edit, :update, :destroy]
# Used for autocomplete form
def autocomplete
term = ActiveRecord::Base.sanitize_sql_like(params[:q].to_s)
items = Item.where("description LIKE :t OR name LIKE :t OR sku LIKE :t", t: "%#{term}%")
.where(active: true)
.order(:description)
.limit(20)
render json: items.map { |i|
{ id: i.id, name: i.name, sku: i.sku, description: i.description, price: i.unit_price }
}
end
def create
@item = Item.new(item_params)
if @item.save
redirect_to item_path(@item), notice: l(:notice_successful_create)
else
render :new, status: :unprocessable_entity
end
rescue => e
log "Unexpected error creating item: #{e.message}"
# Regex now matches across line breaks
existing_id = e.message[/Duplicate Name Exists Error:[\s\S]*Id=(\d+)/, 1]&.to_i
if existing_id
flash[:error] = "Name already exists. Redirecting to existing item."
redirect_to item_path(existing_id)
else
flash[:error] = e.message
redirect_to new_item_path
end
end
def destroy
@item.destroy
redirect_to items_path, notice: l(:notice_successful_delete)
end
def edit
end
def index
@items = Item.order(:name)
end
def new
@item = Item.new
end
def show
end
def sync
Item.sync
redirect_to :home, flash: { notice: I18n.t(:label_syncing) }
end
def update
if @item.update(item_params)
redirect_to item_path(@item), notice: l(:notice_successful_update)
else
render :edit, status: :unprocessable_entity
end
end
private
def find_item
@item = Item.find(params[:id])
rescue ActiveRecord::RecordNotFound
render_404
end
def item_params
params.require(:item).permit(:name, :description, :sku, :unit_price, :active, :account_id, :type, :taxable)
end
def log(msg)
Rails.logger.info "[ItemsController] #{msg}"
end
end
+27 -6
View File
@@ -11,16 +11,31 @@
class QboController < ApplicationController class QboController < ApplicationController
include AuthHelper include AuthHelper
before_action :require_user, except: :webhook # Connecting to QuickBooks and syncing are admin-only. Billing needs the "Bill issues" permission.
# The webhook is called by Intuit, not a user, and is verified by its signature instead.
before_action :require_admin, except: [:webhook, :bill]
before_action :require_login, only: :bill
skip_before_action :verify_authenticity_token, :check_if_login_required, only: :webhook skip_before_action :verify_authenticity_token, :check_if_login_required, only: :webhook
# Session key for the OAuth "state" value, which ties the callback to the admin who started connecting
OAUTH_STATE_SESSION_KEY = :qbo_oauth_state
# Initiates the OAuth authentication process by redirecting the user to the QuickBooks authorization URL. The callback URL is generated based on the application's settings and routes. # Initiates the OAuth authentication process by redirecting the user to the QuickBooks authorization URL. The callback URL is generated based on the application's settings and routes.
def authenticate def authenticate
redirect_to QboOauthService.authorization_url(callback_url: callback_url) state = SecureRandom.urlsafe_base64(32)
session[OAUTH_STATE_SESSION_KEY] = state
redirect_to QboOauthService.authorization_url(callback_url: callback_url, state: state), allow_other_host: true
end end
# Handles the OAuth callback from QuickBooks. Exchanges the authorization code for access and refresh tokens, saves the connection details, and redirects to the sync page with a success notice. If any error occurs during the process, logs the error and redirects back to the plugin settings page with an error message. # Handles the OAuth callback from QuickBooks. Exchanges the authorization code for access and refresh tokens, saves the connection details, and redirects to the sync page with a success notice. If any error occurs during the process, logs the error and redirects back to the plugin settings page with an error message.
def oauth_callback def oauth_callback
# Only accept a callback for a connection this admin started (prevents swapping in another QBO company)
expected_state = session.delete(OAUTH_STATE_SESSION_KEY).to_s
unless expected_state.present? && ActiveSupport::SecurityUtils.secure_compare(expected_state, params[:state].to_s)
log "OAuth callback rejected: state did not match"
return redirect_to plugin_settings_path(:redmine_qbo), flash: { error: I18n.t(:notice_qbo_oauth_state_mismatch) }
end
QboOauthService.exchange!(code: params[:code], callback_url: callback_url, realm_id: params[:realmId]) QboOauthService.exchange!(code: params[:code], callback_url: callback_url, realm_id: params[:realmId])
redirect_to qbo_sync_path, flash: { notice: I18n.t(:label_connected) } redirect_to qbo_sync_path, flash: { notice: I18n.t(:label_connected) }
@@ -32,8 +47,10 @@ class QboController < ApplicationController
# Manual billing endpoint to trigger the billing process for a specific issue. Validates the issue and its associations, enqueues a job to bill the issue's time entries, and redirects back to the issue with a notice. If validation fails, redirects back with an error message. # Manual billing endpoint to trigger the billing process for a specific issue. Validates the issue and its associations, enqueues a job to bill the issue's time entries, and redirects back to the issue with a notice. If validation fails, redirects back with an error message.
def bill def bill
issue = Issue.find_by(id: params[:id]) issue = Issue.visible.find_by(id: params[:id])
raise I18n.t(:notice_error_issue_not_found) unless issue return render_404 unless issue
return deny_access unless User.current.allowed_to?(:bill_issues, issue.project)
raise I18n.t(:notice_billing_error_no_customer) unless issue.customer raise I18n.t(:notice_billing_error_no_customer) unless issue.customer
raise I18n.t(:notice_billing_error_no_employee) unless issue.assigned_to&.employee_id.present? raise I18n.t(:notice_billing_error_no_employee) unless issue.assigned_to&.employee_id.present?
raise I18n.t(:notice_billing_error_no_qbo) unless Qbo.exists? raise I18n.t(:notice_billing_error_no_qbo) unless Qbo.exists?
@@ -46,9 +63,13 @@ class QboController < ApplicationController
redirect_to issue || root_path, flash: { error: e.message } redirect_to issue || root_path, flash: { error: e.message }
end end
# Manual sync endpoint to trigger a full synchronization of QuickBooks entities with the local database. Enqueues all relevant sync jobs and redirects to the home page with a notice that syncing has started. # Manual sync endpoint to trigger synchronization of QuickBooks entities
# with the local database. Supports full or partial sync depending on
# the `full_sync` boolean parameter.
def sync def sync
QboSyncDispatcher.full_sync! full_sync = ActiveModel::Type::Boolean.new.cast(params[:full_sync])
QboSyncDispatcher.sync!(full_sync: full_sync)
redirect_to :home, flash: { notice: I18n.t(:label_syncing) } redirect_to :home, flash: { notice: I18n.t(:label_syncing) }
end end
+245
View File
@@ -0,0 +1,245 @@
#The MIT License (MIT)
#
#Copyright (c) 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:
#
#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.
# Writes, edits and emails QuickBooks estimates from Redmine, on a page laid out like QuickBooks' estimate screen.
class QboEstimatesController < ApplicationController
before_action :require_admin, only: :refresh_company
before_action :authorize_global, except: :refresh_company
before_action :require_sender_for_save_and_send, only: [:create, :update]
before_action :load_issue_preview, only: [:issues_preview, :create_issues]
helper :projects
helper :custom_fields
# Saving an estimate can take a few QuickBooks calls; any of them can fail with a message worth showing
QBO_ERRORS = [RedmineQboBilling::EstimateWriter::Error, Quickbooks::IntuitRequestException,
Quickbooks::InvalidModelException, Quickbooks::AuthorizationFailure,
# redmine_qbo raises plain errors when QuickBooks isn't connected or the token can't be refreshed
RuntimeError].freeze
# A blank estimate, or a copy of another one (?duplicate=<estimate id>)
def new
if params[:duplicate].present?
@form = RedmineQboBilling::EstimateWriter.duplicate_form(params[:duplicate], user: User.current)
else
customer = Customer.find_by(id: params[:customer_id]) if params[:customer_id].present?
@form = RedmineQboBilling::EstimateWriter.new_form(customer: customer, user: User.current)
end
rescue *QBO_ERRORS => e
flash[:error] = qbo_message(e)
redirect_back_or_default home_path
end
def create
@form = RedmineQboBilling::EstimateForm.from_params(estimate_params)
# Shown again if the save fails; the sales person is always the user creating the estimate
@form.sales_person = User.current.name
return show_invalid(:new) unless @form.valid?
saved = RedmineQboBilling::EstimateWriter.save(@form, user: User.current)
finish_save(saved, l(:notice_estimate_saved_in_quickbooks, number: saved.doc_number))
rescue *QBO_ERRORS => e
show_error(e, :new)
end
def edit
@form = RedmineQboBilling::EstimateWriter.load(params[:id])
@linked_issues = RedmineQboBilling::EstimateWriter.linked_issues(@form.id).visible.to_a
rescue *QBO_ERRORS => e
flash[:error] = qbo_message(e)
redirect_back_or_default home_path
end
def update
@form = RedmineQboBilling::EstimateForm.from_params(estimate_params, id: params[:id])
@form.sales_person = params.dig(:estimate, :sales_person).to_s
return show_invalid(:edit) unless @form.valid?
saved = RedmineQboBilling::EstimateWriter.save(@form, user: User.current)
finish_save(saved, l(:notice_estimate_saved_in_quickbooks, number: saved.doc_number))
rescue RedmineQboBilling::EstimateWriter::Conflict => e
@conflict = true
show_error(e, :edit)
rescue *QBO_ERRORS => e
show_error(e, :edit)
end
# Emails an estimate that's already saved (e.g. resending it)
def send_email
sent = RedmineQboBilling::EstimateWriter.send_email(params[:id], params[:email])
flash[:notice] = l(:notice_estimate_sent, number: sent.doc_number, email: sent.bill_email&.address || params[:email])
redirect_to edit_qbo_estimate_path(params[:id])
rescue *QBO_ERRORS => e
flash[:error] = qbo_message(e)
redirect_to edit_qbo_estimate_path(params[:id])
end
# Preview of the issues that can be created from the estimate's labor lines. Each line gets a tracker and
# (optionally) a template before anything is created. Opened from an appointment, the appointment's dates,
# technician and vehicle are used (redmine_qbo_calendar's :qbo_billing_issue_defaults).
def issues_preview
end
# Creates the issues selected on the preview page, all or nothing
def create_issues
@rows = params[:lines].respond_to?(:to_unsafe_h) ? params[:lines].to_unsafe_h : {}
@custom_field_values = submitted_custom_field_values
created = @builder.create_issues(project: @target_project, rows: @rows, custom_field_values: @custom_field_values)
if created.any?
Redmine::Hook.call_hook(:qbo_billing_issues_created, { estimate: @estimate, issues: created, params: params })
flash[:notice] = l(:notice_estimate_issues_created, count: created.size)
redirect_to @return_path
else
# Rebuild the fields so the form keeps what was entered
@field_set = RedmineQboBilling::IssueFieldSet.new(project: @target_project, trackers: @trackers,
values: @custom_field_values)
render :issues_preview, status: :unprocessable_entity
end
end
# Customer details for the editor when a customer is picked: email, billing address and vehicles (VINs)
def customer_info
customer = Customer.find_by(id: params[:customer_id])
return render(json: {}, status: :not_found) unless customer
vehicles = customer.respond_to?(:vehicles) ? customer.vehicles.to_a : []
render json: {
id: customer.id,
name: customer.name,
email: RedmineQboBilling::EstimateWriter.customer_email(customer),
billing_address: RedmineQboBilling::EstimateWriter.customer_address(customer),
vehicles: vehicles.select { |v| v.vin.present? }.map { |v| { vin: v.vin, name: v.to_s } }
}
end
# Product/service search for the line table (the QuickBooks item list)
def items
term = "%#{ActiveRecord::Base.sanitize_sql_like(params[:q].to_s.strip)}%"
items = Item.where(active: true)
.where("name LIKE :t OR sku LIKE :t OR description LIKE :t", t: term)
.order(:name)
.limit(25)
render json: items.map { |item|
{ id: item.id, name: item.name, sku: item.sku, description: item.description,
price: item.unit_price&.to_s, taxable: item.taxable != false }
}
end
# Re-reads the QuickBooks custom fields and estimate settings (e.g. after renaming a custom field)
def refresh_company
RedmineQboBilling::Company.refresh!
flash[:notice] = l(:notice_estimate_settings_refreshed)
redirect_back_or_default home_path
end
private
# Everything the issues preview needs: the local estimate, defaults from other plugins, the target project,
# its trackers, templates and custom fields
def load_issue_preview
@estimate = Estimate.find_by(id: params[:id])
unless @estimate
EstimateSyncService.new.sync_by_id(params[:id])
@estimate = Estimate.find_by(id: params[:id])
end
return render_404 unless @estimate
@defaults = issue_defaults
@builder = RedmineQboBilling::EstimateIssueBuilder.new(@estimate, defaults: @defaults)
@return_path = @defaults[:return_path].presence || edit_qbo_estimate_path(@estimate.id)
@return_label = @defaults[:return_label].presence || "#{l(:label_estimate)} ##{@estimate.doc_number}"
@available_projects = Project.allowed_to(User.current, :add_issues).sorted.to_a
# A project chosen on the page wins, then the one from another plugin (e.g. the appointment's), then the
# default project from the settings, then the first project the user can add issues to
chosen = @available_projects.detect { |p| p.id == params[:project_id].to_i } if params[:project_id].present?
from_hook = @defaults[:project] if @available_projects.include?(@defaults[:project])
default_project = @available_projects.detect { |p| p.id == RedmineQboBilling::EstimateIssueBuilder.default_project_id }
@target_project = chosen || from_hook || default_project || @available_projects.first
return deny_access unless @target_project
@trackers = Issue.allowed_target_trackers(@target_project, User.current).to_a
@default_tracker = @trackers.detect { |t| t.id == RedmineQboBilling::EstimateIssueBuilder.default_tracker_id } || @trackers.first
@templates = RedmineQboBilling::IssueTemplateSupport.templates_for(@target_project)
@field_set = RedmineQboBilling::IssueFieldSet.new(project: @target_project, trackers: @trackers)
@rows ||= {}
rescue *QBO_ERRORS => e
flash[:error] = qbo_message(e)
redirect_back_or_default home_path
end
# The first non-empty hash a plugin returns for :qbo_billing_issue_defaults
def issue_defaults
results = Redmine::Hook.call_hook(:qbo_billing_issue_defaults, { estimate: @estimate, params: params })
(results.detect { |r| r.is_a?(Hash) && r.any? } || {}).symbolize_keys
end
# The shared custom field values from the preview form: { custom_field_id => value }
def submitted_custom_field_values
values = params.dig(:issue, :custom_field_values)
values.respond_to?(:to_unsafe_h) ? values.to_unsafe_h : {}
end
def estimate_params
params.require(:estimate).permit(
:sync_token, :total_tax, :discount, :email_status, :txn_status,
*RedmineQboBilling::EstimateForm::HEADER_ATTRIBUTES,
lines: RedmineQboBilling::EstimateForm::Line::PARAMS
)
end
def save_and_send?
params[:save_and_send].present?
end
def require_sender_for_save_and_send
deny_access if save_and_send? && !RedmineQboBilling.sender?
end
# After saving: email it if asked, then reopen the saved estimate
def finish_save(saved, notice)
if save_and_send?
begin
sent = RedmineQboBilling::EstimateWriter.send_email(saved.id, @form.email)
notice = l(:notice_estimate_saved_and_sent, number: sent.doc_number, email: sent.bill_email&.address || @form.email)
rescue *QBO_ERRORS => e
flash[:error] = l(:error_estimate_saved_not_sent, message: qbo_message(e))
end
end
flash[:notice] = notice
redirect_to edit_qbo_estimate_path(saved.id)
end
def show_error(error, view)
logger.warn "[RedmineQboBilling] #{error.class}: #{qbo_message(error)}"
@form.errors.add(:base, qbo_message(error))
show_invalid(view)
end
# Shows the form again with what was typed. Empty rows are dropped so the line numbers in the
# error messages match the table, and the billing address (display only) is looked up again.
def show_invalid(view)
@form.lines = @form.filled_lines
customer = Customer.find_by(id: @form.customer_id) if @form.customer_id.present?
@form.billing_address = RedmineQboBilling::EstimateWriter.customer_address(customer) if customer
render view, status: :unprocessable_entity
end
# QuickBooks errors carry their detail separately from the message
def qbo_message(error)
detail = error.respond_to?(:detail) ? error.detail.to_s : ''
message = error.message.to_s
detail.present? && !message.include?(detail) ? "#{message}: #{detail}" : message
end
end
+142
View File
@@ -0,0 +1,142 @@
#The MIT License (MIT)
#
#Copyright (c) 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:
#
#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.
# Writes, edits and emails QuickBooks invoices from Redmine, with the same editor as estimates, plus importing
# billable time and open estimates. The customer and product searches are QboEstimatesController's.
class QboInvoicesController < ApplicationController
before_action :authorize_global
before_action :require_sender_for_save_and_send, only: [:create, :update]
before_action :find_customer, only: :import_options
QBO_ERRORS = QboEstimatesController::QBO_ERRORS
# A blank invoice, or one made from an estimate (?estimate_id=<estimate id>)
def new
@form =
if params[:estimate_id].present?
RedmineQboBilling::InvoiceWriter.from_estimate(params[:estimate_id], user: User.current)
else
customer = Customer.find_by(id: params[:customer_id]) if params[:customer_id].present?
RedmineQboBilling::InvoiceWriter.new_form(customer: customer, user: User.current)
end
rescue *QBO_ERRORS => e
flash[:error] = qbo_message(e)
redirect_back_or_default home_path
end
def create
@form = RedmineQboBilling::EstimateForm.from_params(invoice_params, document: 'invoice')
# Display only (e.g. the estimate's sales person); InvoiceWriter.save works out what's saved
@form.sales_person = params.dig(:estimate, :sales_person).presence || User.current.name
return show_invalid(:new) unless @form.valid?
saved = RedmineQboBilling::InvoiceWriter.save(@form, user: User.current)
finish_save(saved, l(:notice_invoice_saved_in_quickbooks, number: saved.doc_number))
rescue *QBO_ERRORS => e
show_error(e, :new)
end
def edit
@form = RedmineQboBilling::InvoiceWriter.load(params[:id])
rescue *QBO_ERRORS => e
flash[:error] = qbo_message(e)
redirect_back_or_default home_path
end
def update
@form = RedmineQboBilling::EstimateForm.from_params(invoice_params, id: params[:id], document: 'invoice')
@form.sales_person = params.dig(:estimate, :sales_person).to_s
return show_invalid(:edit) unless @form.valid?
saved = RedmineQboBilling::InvoiceWriter.save(@form, user: User.current)
finish_save(saved, l(:notice_invoice_saved_in_quickbooks, number: saved.doc_number))
rescue RedmineQboBilling::InvoiceWriter::Conflict => e
@conflict = true
show_error(e, :edit)
rescue *QBO_ERRORS => e
show_error(e, :edit)
end
# Emails an invoice that's already saved (e.g. resending it)
def send_email
sent = RedmineQboBilling::InvoiceWriter.send_email(params[:id], params[:email])
flash[:notice] = l(:notice_invoice_sent, number: sent.doc_number, email: sent.bill_email&.address || params[:email])
redirect_to edit_qbo_invoice_path(params[:id])
rescue *QBO_ERRORS => e
flash[:error] = qbo_message(e)
redirect_to edit_qbo_invoice_path(params[:id])
end
# The customer's billable time and open estimates, for the Import panel
def import_options
render json: RedmineQboBilling::InvoiceWriter.import_options(@customer, issue_ids: Array(params[:issue_ids]))
rescue *QBO_ERRORS => e
render json: { error: qbo_message(e) }, status: :unprocessable_entity
end
private
def find_customer
@customer = Customer.find_by(id: params[:customer_id])
render(json: { error: l(:error_estimate_needs_customer) }, status: :not_found) unless @customer
end
def invoice_params
params.require(:estimate).permit(
:sync_token, :total_tax, :discount, :email_status, :txn_status, :balance,
*RedmineQboBilling::EstimateForm::HEADER_ATTRIBUTES,
linked_estimate_ids: [],
lines: RedmineQboBilling::EstimateForm::Line::PARAMS
)
end
def save_and_send?
params[:save_and_send].present?
end
def require_sender_for_save_and_send
deny_access if save_and_send? && !RedmineQboBilling.invoice_sender?
end
# After saving: email it if asked, then reopen the saved invoice
def finish_save(saved, notice)
if save_and_send?
begin
sent = RedmineQboBilling::InvoiceWriter.send_email(saved.id, @form.email)
notice = l(:notice_invoice_saved_and_sent, number: sent.doc_number, email: sent.bill_email&.address || @form.email)
rescue *QBO_ERRORS => e
flash[:error] = l(:error_estimate_saved_not_sent, message: qbo_message(e))
end
end
flash[:notice] = notice
redirect_to edit_qbo_invoice_path(saved.id)
end
def show_error(error, view)
logger.warn "[RedmineQboBilling] #{error.class}: #{qbo_message(error)}"
@form.errors.add(:base, qbo_message(error))
show_invalid(view)
end
# Shows the form again with what was typed (see QboEstimatesController#show_invalid)
def show_invalid(view)
@form.lines = @form.filled_lines
customer = Customer.find_by(id: @form.customer_id) if @form.customer_id.present?
@form.billing_address = RedmineQboBilling::EstimateWriter.customer_address(customer) if customer
render view, status: :unprocessable_entity
end
def qbo_message(error)
detail = error.respond_to?(:detail) ? error.detail.to_s : ''
message = error.message.to_s
detail.present? && !message.include?(detail) ? "#{message}: #{detail}" : message
end
end
+104
View File
@@ -0,0 +1,104 @@
#The MIT License (MIT)
#
#Copyright (c) 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:
#
#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.
# Receives customer payments in QuickBooks: payment type and amount, applied to open invoices oldest first, or
# saved as a deposit. A saved payment can be printed (QuickBooks' payment PDF). A customer's payments are
# listed on their payments page.
class QboPaymentsController < ApplicationController
before_action :authorize_global
QBO_ERRORS = QboEstimatesController::QBO_ERRORS
# The customer's payments, newest first, read from QuickBooks
def index
@customer = Customer.find_by(id: params[:customer_id])
return render_404 unless @customer
@payments = RedmineQboBilling::PaymentWriter.customer_payments(@customer)
@totals = RedmineQboBilling::PaymentWriter.payment_totals(@payments)
rescue *QBO_ERRORS => e
@payments = []
@totals = RedmineQboBilling::PaymentWriter.payment_totals([])
flash.now[:error] = qbo_message(e)
end
def new
customer = Customer.find_by(id: params[:customer_id]) if params[:customer_id].present?
@form = RedmineQboBilling::PaymentWriter.new_form(customer: customer, user: User.current)
load_choices
end
def create
@form = RedmineQboBilling::PaymentForm.from_params(payment_params)
return show_form unless @form.valid?
payment = RedmineQboBilling::PaymentWriter.save(@form)
flash[:notice] = l(:notice_payment_saved, amount: view_context.number_to_currency(payment.total))
redirect_to qbo_payment_path(payment.id)
rescue *QBO_ERRORS => e
logger.warn "[RedmineQboBilling] #{e.class}: #{qbo_message(e)}"
@form.errors.add(:base, qbo_message(e))
show_form
end
def show
@payment = RedmineQboBilling::PaymentWriter.load(params[:id])
@customer = Customer.find_by(id: @payment.customer_ref&.value)
rescue *QBO_ERRORS => e
flash[:error] = qbo_message(e)
redirect_back_or_default home_path
end
# QuickBooks' PDF of the payment, shown in the browser to print
def pdf
data = RedmineQboBilling::PaymentWriter.pdf(params[:id])
send_data data, type: 'application/pdf', disposition: 'inline', filename: "payment-#{params[:id].to_i}.pdf"
rescue *QBO_ERRORS => e
flash[:error] = qbo_message(e)
redirect_to qbo_payment_path(params[:id])
end
# The customer's open invoices, oldest first, so the page can show how the payment will be applied
def open_invoices
customer = Customer.find_by(id: params[:customer_id])
return render(json: [], status: :not_found) unless customer
render json: RedmineQboBilling::PaymentWriter.open_invoices(customer)
rescue *QBO_ERRORS => e
render json: { error: qbo_message(e) }, status: :unprocessable_entity
end
private
def payment_params
params.require(:payment).permit(*RedmineQboBilling::PaymentForm::ATTRIBUTES, invoice_ids: [])
end
def load_choices
@payment_methods = RedmineQboBilling::PaymentWriter.payment_methods
customer = Customer.find_by(id: @form.customer_id) if @form.customer_id.present?
@open_invoices = customer ? RedmineQboBilling::PaymentWriter.open_invoices(customer) : []
rescue *QBO_ERRORS => e
@open_invoices = []
flash.now[:error] = qbo_message(e)
end
def show_form
load_choices
render :new, status: :unprocessable_entity
end
def qbo_message(error)
detail = error.respond_to?(:detail) ? error.detail.to_s : ''
message = error.message.to_s
detail.present? && !message.include?(detail) ? "#{message}: #{detail}" : message
end
end
+31 -17
View File
@@ -10,20 +10,40 @@
module AuthHelper module AuthHelper
def require_user # The active customer share token stored in the session by customers#view, if any.
return unless session[:token].nil? def customer_token
if !User.current.logged? return @customer_token if defined?(@customer_token)
flash[:error] = t :notice_forbidden
render_403 @customer_token = session[:token].present? ? CustomerToken.active.find_by(token: session[:token]) : nil
end end
# True when the visitor is a customer using a share link rather than a logged-in user.
def customer_token_only?
!User.current.logged? && customer_token.present?
end
# Logged-in users pass. Customers with an active share link pass too (each controller then limits them
# to their own issue's documents). Everyone else is sent to the login page.
def require_login_or_customer_token
return true if User.current.logged?
return true if customer_token
require_login
end
# Kept for plugins that still call it (e.g. redmine_qbo_vehicles): requires a logged-in user.
# The old version effectively never ran; share-link customers use require_login_or_customer_token.
def require_user
return true if User.current.logged?
require_login
end end
def allowed_to?(action) def allowed_to?(action)
return false if User.current.nil? return false if User.current.nil?
project = Project.find(params[:project_id]) project = Project.find_by(id: params[:project_id])
return false if project.nil? return false if project.nil?
return true if User.current.allowed_to?(action, project) User.current.allowed_to?(action, project)
false
end end
def check_permission(permission) def check_permission(permission)
@@ -33,7 +53,6 @@ module AuthHelper
end end
end end
def global_check_permission(permission) def global_check_permission(permission)
if !globaly_allowed_to?(permission) if !globaly_allowed_to?(permission)
flash[:error] = t :notice_forbidden flash[:error] = t :notice_forbidden
@@ -41,16 +60,11 @@ module AuthHelper
end end
end end
def globaly_allowed_to?( action) # True if the user has the permission through any of their roles (or is an admin)
def globaly_allowed_to?(action)
return false if User.current.nil? return false if User.current.nil?
projects = Project.all User.current.allowed_to?(action, nil, global: true)
projects.each { |p|
if User.current.allowed_to?(action, p)
return true
end
}
false
end end
end end
+32 -13
View File
@@ -17,27 +17,36 @@ class BillIssueTimeJob < ActiveJob::Base
issue = Issue.find(issue_id) issue = Issue.find(issue_id)
log "Starting billing for issue ##{issue.id}" log "Starting billing for issue ##{issue.id}"
failure = nil
issue.with_lock do issue.with_lock do
unbilled_entries = issue.time_entries.where(billed: [false, nil]).lock unbilled_entries = issue.time_entries.where(billed: [false, nil]).lock.includes(:activity).to_a
return if unbilled_entries.blank? return if unbilled_entries.blank?
totals = aggregate_hours(unbilled_entries) totals = aggregate_hours(unbilled_entries)
return if totals.blank? return if totals.blank?
log "Aggregated hours for billing: #{totals.inspect}" log "Aggregated hours for billing: #{totals.inspect}"
# Activities already sent to QBO (or deliberately skipped) in this run. If QBO fails part way, or the
# token refresh re-runs the block, finished activities are not sent again.
done = []
begin
qbo = QboConnectionService.current! qbo = QboConnectionService.current!
raise "No QBO configuration found" unless qbo
qbo.perform_authenticated_request do |access_token| qbo.perform_authenticated_request do |access_token|
create_time_activities(issue, totals, access_token, qbo) create_time_activities(issue, totals, access_token, qbo, done)
end
rescue => e
failure = e
end end
# Only mark billed AFTER successful QBO creation # Mark billed only the entries whose activity was finished, and commit that even if a later
unbilled_entries.update_all(billed: true) # activity failed, so a retry only sends what's left
finished = unbilled_entries.select { |entry| done.include?(entry.activity&.name) }
TimeEntry.where(id: finished.map(&:id)).update_all(billed: true) if finished.any?
end end
raise failure if failure
log "Completed billing for issue ##{issue.id}" log "Completed billing for issue ##{issue.id}"
Qbo.update_time_stamp Qbo.update_time_stamp
rescue => e rescue => e
@@ -49,25 +58,34 @@ class BillIssueTimeJob < ActiveJob::Base
# Aggregate time entries by activity name and sum their hours # Aggregate time entries by activity name and sum their hours
def aggregate_hours(entries) def aggregate_hours(entries)
entries.includes(:activity) entries.group_by { |e| e.activity&.name }
.group_by { |e| e.activity&.name }
.transform_values { |rows| rows.sum(&:hours) } .transform_values { |rows| rows.sum(&:hours) }
.compact .compact
end end
# Create TimeActivity records in QBO for each activity type with the appropriate hours and link them to the issue's assigned employee and customer # Create TimeActivity records in QBO for each activity type with the appropriate hours and link them to the issue's assigned employee and customer
def create_time_activities(issue, totals, access_token, qbo) # Adds each activity name to done once it has been created in QBO (or skipped because it can't be billed).
def create_time_activities(issue, totals, access_token, qbo, done)
log "Creating TimeActivity records in QBO for issue ##{issue.id}" log "Creating TimeActivity records in QBO for issue ##{issue.id}"
time_service = Quickbooks::Service::TimeActivity.new( company_id: qbo.realm_id, access_token: access_token) time_service = Quickbooks::Service::TimeActivity.new( company_id: qbo.realm_id, access_token: access_token)
item_service = Quickbooks::Service::Item.new( company_id: qbo.realm_id, access_token: access_token ) item_service = Quickbooks::Service::Item.new( company_id: qbo.realm_id, access_token: access_token )
totals.each do |activity_name, hours_float| totals.each do |activity_name, hours_float|
next if activity_name.blank? next if done.include?(activity_name)
next if hours_float.to_f <= 0
# Not billable: skipped, and marked billed as before
if activity_name.blank? || hours_float.to_f <= 0
done << activity_name
next
end
item = find_item(item_service, activity_name) item = find_item(item_service, activity_name)
next unless item unless item
log "No QBO item named #{activity_name.inspect}; skipping"
done << activity_name
next
end
hours, minutes = convert_hours(hours_float) hours, minutes = convert_hours(hours_float)
@@ -86,6 +104,7 @@ class BillIssueTimeJob < ActiveJob::Base
log "Creating TimeActivity for #{activity_name} (#{hours}h #{minutes}m)" log "Creating TimeActivity for #{activity_name} (#{hours}h #{minutes}m)"
time_service.create(time_entry) time_service.create(time_entry)
done << activity_name
end end
end end
+32 -7
View File
@@ -11,14 +11,39 @@
class QboSyncDispatcher class QboSyncDispatcher
SYNC_JOBS = [ SYNC_JOBS = [
CustomerSyncJob, Customer,
EstimateSyncJob, Estimate,
InvoiceSyncJob, Invoice,
EmployeeSyncJob Employee
].freeze ].freeze
# Dispatches all synchronization jobs to perform a full sync of QuickBooks entities with the local database. Each job is enqueued with the `full_sync` flag set to true. # Dispatches all synchronization jobs to perform a full sync of QuickBooks entities with the local database.
def self.full_sync! # Each job is enqueued with the `full_sync` flag set to true.
SYNC_JOBS.each { |job| job.perform_later(full_sync: true) } def self.sync!(full_sync: false)
log "Manual Sync initated for #{full_sync ? "full sync" : "incremental sync"}"
enque_jobs full_sync: full_sync
end end
private
# Dynamically enques all sync jobs
def self.enque_jobs(full_sync: full_sync)
jobs = SYNC_JOBS.dup
# Allow other plugins to add addtional sync jobs via Hooks
Redmine::Hook.call_hook( :qbo_full_sync ).each do |context|
next unless context
Array(context).each do |entity|
jobs.push(entity)
log "Added additional QBO Sync Job for #{entity.to_s}"
end
end
jobs.each { |job| QboSyncJob.perform_later(entity: job, full_sync: full_sync) }
end
def self.log(msg)
Rails.logger.info "[QboSyncDispatcher] #{msg}"
end
end end
@@ -8,23 +8,22 @@
# #
#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.
class EstimateSyncJob < ApplicationJob class QboSyncJob < ApplicationJob
queue_as :default queue_as :default
retry_on StandardError, wait: 5.minutes, attempts: 5 retry_on StandardError, wait: 5.minutes, attempts: 5
# Performs a sync of estimates from QuickBooks Online. # Perform a full sync of all records for the entity, or an incremental sync of only those updated since the last sync
def perform(full_sync: false, id: nil, doc_number: nil) def perform(full_sync: false, id: nil, entity: nil, doc_number: nil)
qbo = QboConnectionService.current! raise "An entity to sync is required" unless entity
raise "No QBO configuration found" unless qbo @entity = entity
log "Starting #{full_sync ? 'full' : 'incremental'} sync for estimate ##{id || doc_number || 'all'}..." log "Starting #{full_sync ? 'full' : 'incremental'} sync for #{entity} ##{id || doc_number || 'all'}..."
service = "#{entity}SyncService".constantize.new
service = EstimateSyncService.new(qbo: qbo)
if id.present? if id.present?
service.sync_by_id(id) service.sync_by_id(id)
elsif doc_number.present? elsif doc_number.present?
service.sync_by_doc(doc_number) service.sync_by_doc_number(doc_number)
else else
service.sync(full_sync: full_sync) service.sync(full_sync: full_sync)
end end
@@ -32,7 +31,8 @@ class EstimateSyncJob < ApplicationJob
private private
# Log messages with the entity type for better traceability
def log(msg) def log(msg)
Rails.logger.info "[EstimateSyncJob] #{msg}" Rails.logger.info "[#{@entity}SyncJob] #{msg}"
end end
end end
+1 -1
View File
@@ -14,7 +14,7 @@ class QboWebhookProcessor
def self.process!(request:) def self.process!(request:)
body = request.raw_post body = request.raw_post
signature = request.headers['intuit-signature'] signature = request.headers['intuit-signature']
secret = Setting.plugin_redmine_qbo['settingsWebhookToken'] secret = RedmineQbo.webhook_token_secret
raise "Invalid signature" unless valid_signature?(body, signature, secret) raise "Invalid signature" unless valid_signature?(body, signature, secret)
+10 -1
View File
@@ -43,7 +43,16 @@ class WebhookProcessJob < ActiveJob::Base
name = entity['name'] name = entity['name']
id = entity['id']&.to_i id = entity['id']&.to_i
return unless ALLOWED_ENTITIES.include?(name) entities = ALLOWED_ENTITIES.dup
# Allow other plugins to add addtional qbo entities via Hooks
Redmine::Hook.call_hook( :qbo_additional_entities ).each do |context|
next unless context
Array(context).each do |entity|
entities.push(entity)
log "Added additional QBO entity #{entity}"
end
end
return unless entities.include?(name)
model = name.safe_constantize model = name.safe_constantize
return unless model return unless model
@@ -1,6 +1,6 @@
#The MIT License (MIT) #The MIT License (MIT)
# #
#Copyright (c) 2016 - 2026 rick barrette #Copyright (c) 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:
# #
@@ -8,29 +8,34 @@
# #
#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.
class EmployeeSyncJob < ApplicationJob class Account < QboBaseModel
queue_as :default has_many :items
retry_on StandardError, wait: 5.minutes, attempts: 5 validates_presence_of :id, :name
self.primary_key = :id
qbo_sync push: false
before_save :clear_other_defaults, if: :default?
# Performs a sync of employees from QuickBooks Online. # Returns the account marked as default
def perform(full_sync: false, id: nil) def self.get_default
qbo = QboConnectionService.current! find_by(default: true)
raise "No QBO configuration found" unless qbo
log "Starting #{full_sync ? 'full' : 'incremental'} sync for employee ##{id || 'all'}..."
service = EmployeeSyncService.new(qbo: qbo)
if id.present?
service.sync_by_id(id)
else
service.sync(full_sync: full_sync)
end end
# Returns QBO Refrence object for the account
def ref
r = Quickbooks::Model::BaseReference.new
r.value = id
r.name = name
return r
end
def to_s
name
end end
private private
def log(msg) def clear_other_defaults
Rails.logger.info "[EmployeeSyncJob] #{msg}" Account.where.not(id: id).update_all(default: false)
end end
end end
+2 -5
View File
@@ -75,11 +75,8 @@ module QuickbooksOauth
# This method will construct and return an instance of the OAuth2::Client class that is configured with the consumer key, consumer secret and the appropriate URLs for the Intuit OAuth2 service. It will also set the sandbox mode based on the plugin settings. This method is used by the instance method oauth_client to create a new OAuth2 client for each instance of the model that includes this concern. # This method will construct and return an instance of the OAuth2::Client class that is configured with the consumer key, consumer secret and the appropriate URLs for the Intuit OAuth2 service. It will also set the sandbox mode based on the plugin settings. This method is used by the instance method oauth_client to create a new OAuth2 client for each instance of the model that includes this concern.
def construct_oauth2_client def construct_oauth2_client
oauth_consumer_key = Setting.plugin_redmine_qbo['settingsOAuthConsumerKey']
oauth_consumer_secret = Setting.plugin_redmine_qbo['settingsOAuthConsumerSecret']
# Are we are playing in the sandbox? # Are we are playing in the sandbox?
Quickbooks.sandbox_mode = Setting.plugin_redmine_qbo[:sandbox] ? true : false Quickbooks.sandbox_mode = RedmineQbo.sandbox_mode?
log "Sandbox mode: #{Quickbooks.sandbox_mode}" log "Sandbox mode: #{Quickbooks.sandbox_mode}"
options = { options = {
@@ -87,7 +84,7 @@ module QuickbooksOauth
authorize_url: "https://appcenter.intuit.com/connect/oauth2", authorize_url: "https://appcenter.intuit.com/connect/oauth2",
token_url: "https://oauth.platform.intuit.com/oauth2/v1/tokens/bearer" token_url: "https://oauth.platform.intuit.com/oauth2/v1/tokens/bearer"
} }
OAuth2::Client.new(oauth_consumer_key, oauth_consumer_secret, options) OAuth2::Client.new(RedmineQbo.oauth_consumer_key, RedmineQbo.oauth_consumer_secret, options)
end end
end end
+16 -100
View File
@@ -8,20 +8,21 @@
# #
#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.
class Customer < ActiveRecord::Base class Customer < QboBaseModel
include Redmine::Acts::Searchable include Redmine::Acts::Searchable
include Redmine::Acts::Event include Redmine::Acts::Event
include Redmine::I18n
has_many :issues has_many :issues
has_many :invoices has_many :invoices
has_many :estimates has_many :estimates
validates_presence_of :name
validates_presence_of :id, :name
before_validation :normalize_phone_numbers before_validation :normalize_phone_numbers
self.primary_key = :id self.primary_key = :id
qbo_sync push: true
# Normalize the local database column :name (capitalize each word, keep acronyms like LLC as typed)
normalizes :name, with: ->(name) { RedmineQbo::TitleCase.call(name.to_s.strip) }
acts_as_searchable columns: %w[name phone_number mobile_phone_number ], acts_as_searchable columns: %w[name phone_number mobile_phone_number ],
scope: ->(_context) { left_joins(:project) }, scope: ->(_context) { left_joins(:project) },
@@ -33,41 +34,14 @@ class Customer < ActiveRecord::Base
:description => Proc.new {|o| "#{I18n.t :label_primary_phone}: #{o.phone_number} #{I18n.t:label_mobile_phone}: #{o.mobile_phone_number}"}, :description => Proc.new {|o| "#{I18n.t :label_primary_phone}: #{o.phone_number} #{I18n.t:label_mobile_phone}: #{o.mobile_phone_number}"},
:datetime => Proc.new {|o| o.updated_at || o.created_at} :datetime => Proc.new {|o| o.updated_at || o.created_at}
# Returns the details of the customer. If the details have already been fetched, it returns the cached version. Otherwise, it fetches the details from QuickBooks Online and caches them for future use. This method is used to access the customer's information in a way that minimizes unnecessary API calls to QBO, improving performance and reducing latency.
def details
return Quickbooks::Model::Customer.new unless id.present?
@details ||= begin
xml = Rails.cache.fetch(details_cache_key, expires_in: 10.minutes) do
fetch_details.to_xml_ns
end
Quickbooks::Model::Customer.from_xml(xml)
end
end
# Generates a unique cache key for storing this customer's QBO details.
def details_cache_key
"customer:#{id}:qbo_details:#{updated_at.to_i}"
end
# Returns the customer's email address # Returns the customer's email address
def email def email
details return details&.email_address&.address
return @details&.email_address&.address
end end
# Updates the customer's email address # Updates the customer's email address
def email=(s) def email=(s)
details details.email_address = s
@details.email_address = s
end
# Returns the last sync time formatted for display. If no sync has occurred, returns a default message.
def self.last_sync
return I18n.t(:label_qbo_never_synced) unless maximum(:updated_at)
format_time(maximum(:updated_at))
end end
# Customers are not bound by a project # Customers are not bound by a project
@@ -76,36 +50,23 @@ class Customer < ActiveRecord::Base
nil nil
end end
# Magic Method
# Maps Get/Set methods to QBO customer object
def method_missing(method_name, *args, &block)
if Quickbooks::Model::Customer.method_defined?(method_name)
details
@details.public_send(method_name, *args, &block)
else
super
end
end
# returns the customer's mobile phone # returns the customer's mobile phone
def mobile_phone def mobile_phone
details return details&.mobile_phone&.free_form_number
return @details&.mobile_phone&.free_form_number
end end
# Updates the custome's mobile phone number # Updates the custome's mobile phone number
def mobile_phone=(n) def mobile_phone=(n)
details
pn = Quickbooks::Model::TelephoneNumber.new pn = Quickbooks::Model::TelephoneNumber.new
pn.free_form_number = n pn.free_form_number = n
@details.mobile_phone = pn details.mobile_phone = pn
end end
# Updates Both local DB name & QBO display_name # Updates Both local DB name & QBO display_name
def name=(s) def name=(s)
details super(s)
@details.display_name = s # Write the normalized value from Active Record to QBO details
super details.display_name = self.name
end end
# Normalizes phone numbers by removing non-digit characters. This method is called before validation to ensure that phone numbers are stored in a consistent format, which can help with searching and integration with external systems like QuickBooks Online. # Normalizes phone numbers by removing non-digit characters. This method is called before validation to ensure that phone numbers are stored in a consistent format, which can help with searching and integration with external systems like QuickBooks Online.
@@ -116,27 +77,19 @@ class Customer < ActiveRecord::Base
# Sets the notes for the customer # Sets the notes for the customer
def notes=(s) def notes=(s)
details details.notes = s
@details.notes = s
end end
# returns the customer's primary phone # returns the customer's primary phone
def primary_phone def primary_phone
details return details&.primary_phone&.free_form_number
return @details&.primary_phone&.free_form_number
end end
# Updates the customer's primary phone number # Updates the customer's primary phone number
def primary_phone=(n) def primary_phone=(n)
details
pn = Quickbooks::Model::TelephoneNumber.new pn = Quickbooks::Model::TelephoneNumber.new
pn.free_form_number = n pn.free_form_number = n
@details.primary_phone = pn details.primary_phone = pn
end
# Repsonds to missing methods by delegating to the QBO customer details object if the method is defined there. This allows for dynamic access to any attributes or methods of the QBO customer without having to explicitly define them in the Customer model, providing flexibility and reducing boilerplate code.
def respond_to_missing?(method_name, include_private = false)
Quickbooks::Model::Customer.method_defined?(method_name) || super
end end
# Seach for customers by name or phone number # Seach for customers by name or phone number
@@ -160,47 +113,10 @@ class Customer < ActiveRecord::Base
ids.index_with { |id| id } ids.index_with { |id| id }
end end
# performs a sync operation for all customers
def self.sync
CustomerSyncJob.perform_later(full_sync: false)
end
# performs a sync operation for a specific customer
def self.sync_by_id(id)
CustomerSyncJob.perform_later(id: id)
end
# returns a human readable string # returns a human readable string
def to_s def to_s
last4 = phone_number&.last(4) last4 = phone_number&.last(4)
last4.present? ? "#{name} - #{last4}" : name.to_s last4.present? ? "#{name} - #{last4}" : name.to_s
end end
# Push the updates
def save_with_push
log "Starting push for customer ##{self.id}..."
qbo = QboConnectionService.current!
CustomerService.new(qbo: qbo, customer: self).push()
Rails.cache.delete(details_cache_key)
save_without_push
end
alias_method :save_without_push, :save
alias_method :save, :save_with_push
private
# Fetches the customer's details from QuickBooks Online. If the customer has an ID, it makes an authenticated request to QBO to retrieve the customer's information. If the customer does not have an ID or if there is an error during the fetch, it returns a new instance of Quickbooks::Model::Customer with default values. This method is used to ensure that the customer object has the most up-to-date information from QBO when needed.
def fetch_details
return Quickbooks::Model::Customer.new unless id.present?
log "Fetching details for customer ##{id} from QBO..."
qbo = QboConnectionService.current!
CustomerService.new(qbo: qbo, customer: self).pull()
end
# Log messages with the entity type for better traceability
def log(msg)
Rails.logger.info "[Customer] #{msg}"
end
end end
+2 -20
View File
@@ -8,29 +8,11 @@
# #
#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.
class Employee < ActiveRecord::Base class Employee < QboBaseModel
include Redmine::I18n
has_many :users has_many :users
validates_presence_of :id, :name validates_presence_of :id, :name
self.primary_key = :id self.primary_key = :id
qbo_sync push: false
# Returns the last sync time formatted for display. If no sync has occurred, returns a default message.
def self.last_sync
return I18n.t(:label_qbo_never_synced) unless maximum(:updated_at)
format_time(maximum(:updated_at))
end
# Sync all employees, typically triggered by a scheduled task or manual sync request
def self.sync
EmployeeSyncJob.perform_later(full_sync: true)
end
# Sync a single employee by ID, typically triggered by a webhook notification or manual sync request
def self.sync_by_id(id)
EmployeeSyncJob.perform_later(id: id)
end
end end
+7 -26
View File
@@ -8,19 +8,16 @@
# #
#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.
class Estimate < ActiveRecord::Base class Estimate < QboBaseModel
include Redmine::I18n has_many :issues
has_and_belongs_to_many :issues
belongs_to :customer belongs_to :customer
validates_presence_of :doc_number, :id validates_presence_of :doc_number, :id
self.primary_key = :id self.primary_key = :id
qbo_sync push: false
# Returns the last sync time formatted for display. If no sync has occurred, returns a default message. def name
def self.last_sync to_s
return I18n.t(:label_qbo_never_synced) unless maximum(:updated_at)
format_time(maximum(:updated_at))
end end
# returns a human readable string # returns a human readable string
@@ -28,25 +25,9 @@ class Estimate < ActiveRecord::Base
return self[:doc_number] return self[:doc_number]
end end
# sync all estimates # sync only one estimate by document number
def self.sync
EstimateSyncJob.perform_later(full_sync: false)
end
# sync only one estimate
def self.sync_by_id(id)
EstimateSyncJob.perform_later(id: id)
end
# sync only one estimate
def self.sync_by_doc_number(number) def self.sync_by_doc_number(number)
EstimateSyncJob.perform_later(doc_number: number) QboSyncJob.perform_later(entity: model_name.name, doc_number: number)
end
private
def log(msg)
Rails.logger.info "[Estimate] #{msg}"
end end
end end
+2 -21
View File
@@ -8,37 +8,18 @@
# #
#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.
class Invoice < ActiveRecord::Base class Invoice < QboBaseModel
include Redmine::I18n
has_and_belongs_to_many :issues has_and_belongs_to_many :issues
belongs_to :customer belongs_to :customer
validates :id, presence: true, uniqueness: true validates :id, presence: true, uniqueness: true
validates :doc_number, :txn_date, presence: true validates :doc_number, :txn_date, presence: true
self.primary_key = :id self.primary_key = :id
qbo_sync push: false
# Returns the last sync time formatted for display. If no sync has occurred, returns a default message.
def self.last_sync
return I18n.t(:label_qbo_never_synced) unless maximum(:updated_at)
format_time(maximum(:updated_at))
end
# Return the invoice's document number as its string representation # Return the invoice's document number as its string representation
def to_s def to_s
doc_number doc_number
end end
# Sync all invoices from QuickBooks, typically triggered by a scheduled task or manual sync request
def self.sync
InvoiceSyncJob.perform_later(full_sync: true)
end
# Sync a single invoice by ID, typically triggered by a webhook notification or manual sync request
def self.sync_by_id(id)
InvoiceSyncJob.perform_later(id: id)
end
end end
+68
View File
@@ -0,0 +1,68 @@
#The MIT License (MIT)
#
#Copyright (c) 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:
#
#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.
class Item < QboBaseModel
belongs_to :account, optional: true
validates_presence_of :id, :description
validates :unit_price, numericality: { greater_than_or_equal_to: 0 }
self.primary_key = :id
self.inheritance_column = :_type_disabled
qbo_sync push: true
after_initialize :set_defaults, if: :new_record?
before_destroy :make_inactive
# Updates Both local & remote DB account ref (a blank or unknown account leaves QBO's ref unchanged)
def account_id=(id)
account = Account.find_by(id: id) if id.present?
details.income_account_ref = account.ref if account
super
end
# Updates Both local & remote DB description
def description=(s)
details.description = s
super
end
# Updates Both local & remote DB name
def name=(s)
details.name = s
super
end
def make_inactive
details.active = false
push_to_qbo
end
def set_defaults
self.taxable = true if taxable.nil?
end
# Updates Both local & remote DB sku
def sku=(s)
details.sku = s
super
end
# Updates Both local & remote DB type
def type=(s)
details.type = s.to_s
super
end
# Updates Both local & remote DB price
def unit_price=(s)
details.unit_price = s
super
end
end
+20 -7
View File
@@ -15,6 +15,26 @@ class Qbo < ActiveRecord::Base
validate :single_record_only, on: :create validate :single_record_only, on: :create
# Returns the last sync time formatted for display. If no sync has occurred, returns a default message.
def self.last_sync
qbo = QboConnectionService.current!
format_time(qbo.last_sync)
rescue
return I18n.t(:label_qbo_never_synced)
end
def self.oauth2_access_token_expires_at
QboConnectionService.current!.oauth2_access_token_expires_at
rescue
return I18n.t(:label_qbo_never_synced)
end
def self.oauth2_refresh_token_expires_at
QboConnectionService.current!.oauth2_refresh_token_expires_at
rescue
return I18n.t(:label_qbo_never_synced)
end
# Updates last sync time stamp # Updates last sync time stamp
def self.update_time_stamp def self.update_time_stamp
date = DateTime.now date = DateTime.now
@@ -24,13 +44,6 @@ class Qbo < ActiveRecord::Base
qbo.save qbo.save
end end
# Returns the last sync time formatted for display. If no sync has occurred, returns a default message.
def self.last_sync
qbo = QboConnectionService.current!
return I18n.t(:label_qbo_never_synced) unless qbo&.last_sync
format_time(qbo.last_sync)
end
private private
# Logs a message with a QBO-specific prefix for easier identification in the logs. # Logs a message with a QBO-specific prefix for easier identification in the logs.
+122
View File
@@ -0,0 +1,122 @@
#The MIT License (MIT)
#
#Copyright (c) 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:
#
#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.
class QboBaseModel < ActiveRecord::Base
include Redmine::I18n
self.abstract_class = true
validates_presence_of :id
class_attribute :qbo_push_enabled, default: true
attr_accessor :skip_qbo_push
before_validation :push_to_qbo, on: :create, if: :push_to_qbo?
after_commit :push_to_qbo, on: :update, if: :push_to_qbo?
# Returns the details of the entity.
# If the details have already been fetched, it returns the cached version.
# Otherwise, it fetches the details from QuickBooks Online and caches them for future use.
# This method is used to access the entity's information in a way that minimizes unnecessary API calls to QBO, improving performance and reducing latency.
def details
@details ||= begin
xml = Rails.cache.fetch(details_cache_key, expires_in: 10.minutes) do
fetch_details.to_xml_ns
end
qbo_model_class.from_xml(xml)
end
end
# Generates a unique cache key for storing this customer's QBO details.
def details_cache_key
"#{model_name.name}:#{id}:qbo_details:#{updated_at.to_i}"
end
# Returns the last sync time formatted for display.
# If no sync has occurred, returns a default message.
def self.last_sync
return I18n.t(:label_qbo_never_synced) unless maximum(:updated_at)
format_time(maximum(:updated_at))
end
# Magic Method
# Maps Get/Set methods to QBO entity object
def method_missing(method_name, *args, &block)
if qbo_model_class.method_defined?(method_name)
details
@details.public_send(method_name, *args, &block)
else
super
end
end
def push_to_qbo?
log "qbo_push_enabled #{self.class.qbo_push_enabled}"
log "skip_qbo_push #{skip_qbo_push}"
self.class.qbo_push_enabled && skip_qbo_push != true
end
# Repsonds to missing methods by delegating to the QBO entity calss if the method is defined there.
# This allows for dynamic access to any attributes or methods of the QBO customer without having to explicitly define them in the Subclass model, providing flexibility and reducing boilerplate code.
def respond_to_missing?(method_name, include_private = false)
qbo_model_class.method_defined?(method_name) || super
end
# Sync all entities, typically triggered by a scheduled task or manual sync request
def self.sync
QboSyncJob.perform_later(entity: model_name.name, full_sync: true)
end
# Sync a single entity by ID, typically triggered by a webhook notification or manual sync request
def self.sync_by_id(id)
QboSyncJob.perform_later(entity: model_name.name, id: id)
end
# Flag used to update local without pushing to QBO.
# This is used to prevent loops with the webhook
def skip_qbo_push?
!!skip_qbo_push
end
def self.qbo_sync(push: true)
self.qbo_push_enabled = push
end
private
# Log messages with a standarized prefix
def log(msg)
Rails.logger.info "[#{model_name.name}] #{msg}"
end
# Fetches the entity's details from QuickBooks Online.
def fetch_details
log "Fetching details for #{model_name.name} ##{id} from QBO..."
service_class.new(local: self).pull()
end
# Pushs the entity's details from QuickBooks Online.
def push_to_qbo
log "Starting push for #{model_name.name} ##{id}..."
reslut = service_class.new(local: self).push
Rails.cache.delete(details_cache_key)
return reslut
end
# Dynamically get the Quickbooks Model Class
def qbo_model_class
@qbo_model_class ||= "Quickbooks::Model::#{model_name.name}".constantize
end
# Dynamically get the Service Class
def service_class
@service_class ||= "#{model_name.name}Service".constantize
end
end
+19
View File
@@ -0,0 +1,19 @@
#The MIT License (MIT)
#
#Copyright (c) 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:
#
#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.
# Link between a QuickBooks estimate line and the issue created from it (see EstimateIssueBuilder)
class QboEstimateLineIssue < ActiveRecord::Base
belongs_to :issue
validates :estimate_id, :line_id, presence: true
validates :line_id, uniqueness: { scope: :estimate_id }
before_create { self.created_on ||= Time.current }
end
@@ -1,16 +1,23 @@
#The MIT License (MIT) #The MIT License (MIT)
# #
#Copyright (c) 2016 - 2026 rick barrette #Copyright (c) 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.
class EstimatePdfService < PdfServiceBase
class AccountSyncService < SyncServiceBase
private
# Specify the local model this service syncs
def self.model_class def self.model_class
Estimate Account
end end
map_attribute :active, :active?
map_attributes :classification, :description, :id, :name
end end
+233
View File
@@ -0,0 +1,233 @@
#The MIT License (MIT)
#
#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:
#
#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.
require 'csv'
require 'did_you_mean'
require 'text'
# Finds customers by name and/or phone, tolerant of the ways duplicates sneak in:
# - nicknames: "Bill Smith" finds "William Smith", "Bob" finds "Robert" (about 2,800 pairs, see data/nicknames)
# - sound-alikes: "Jon" finds "John", "Smyth" finds "Smith", "Cathy" finds "Kathy" (Double Metaphone)
# - typos: "Willaim Smtih" finds "William Smith"
# - word order: "Smith, William" finds "William Smith"
# - partial: "will smi" finds "William Smith" while typing
# - phone: any 4+ digits, in any format, matched against both phone numbers
#
# Results are ranked best match first. Only id, name and phone numbers are loaded, and the prepared
# search data is cached until a customer changes, so searching stays fast as the customer list grows.
class CustomerSearchService
DEFAULT_LIMIT = 20
# Lowest score (0..1) a customer needs to be returned
MIN_SCORE = 0.72
# Bundled nickname data (Apache 2.0, see data/nicknames/README.md)
NICKNAMES_CSV = File.expand_path('../../data/nicknames/names.csv', __dir__)
# Groups missing from the bundled data. Add more here: every name in a group matches every other.
EXTRA_NICKNAME_GROUPS = [
%w[william liam],
%w[alexander xander],
%w[alexandra lexi],
%w[theodore theo],
%w[christopher kit]
].freeze
# Words that don't help tell customers apart
STOP_WORDS = %w[and the llc inc co corp company].freeze
# Returns matching Customer records, best match first.
def self.call(name: nil, phone: nil, limit: DEFAULT_LIMIT)
ids = rank(candidates, name: name, phone: phone, limit: limit).map(&:first)
return Customer.none if ids.empty?
Customer.where(id: ids).in_order_of(:id, ids)
end
# Prepared search rows for every customer, cached until any customer changes. Kept in this process's
# memory as well, so each keystroke doesn't reload it from the Rails cache.
def self.candidates
key = ['customer_search_candidates', 2, Customer.count, Customer.maximum(:updated_at).to_i]
cached_key, cached_rows = @candidates
return cached_rows if cached_key == key
rows = Rails.cache.fetch(key, expires_in: 12.hours) do
prepare(Customer.pluck(:id, :name, :phone_number, :mobile_phone_number))
end
@candidates = [key, rows]
rows
end
# [[id, name, phone, mobile], ...] -> [[id, name, phone_digits, tokens, sound_codes], ...]
def self.prepare(rows)
rows.map do |id, name, phone_number, mobile_number|
words = tokens(name)
phones = [phone_number, mobile_number].compact.map { |n| n.to_s.gsub(/\D/, '') }.reject(&:empty?)
[id, name.to_s, phones, words, words.map { |w| sound_codes(w) }]
end
end
# Pure ranking over prepared rows (no database), so it can be tested on its own.
# Returns [[id, score], ...] best first. A query of mostly digits is also treated as a phone number.
def self.rank(prepared, name: nil, phone: nil, limit: DEFAULT_LIMIT)
name = name.to_s.strip
phone_digits = phone.to_s.gsub(/\D/, '')
# "401-555-1234" typed into the name box is a phone search
name_digits = name.gsub(/\D/, '')
if phone_digits.empty? && name_digits.length >= 4 && name_digits.length >= name.gsub(/\s/, '').length * 0.7
phone_digits = name_digits
name = ''
end
query_words = tokens(name)
return [] if query_words.empty? && phone_digits.length < 4
query = query_words.map { |w| [w, sound_codes(w)] }
memo = {} # word-pair scores for this search; customer names repeat words a lot ("smith", "john")
scored = prepared.filter_map do |id, customer_name, phones, words, codes|
score = [
phone_digits.length >= 4 ? phone_score(phone_digits, phones) : 0.0,
query.any? ? name_score(query, words, codes, memo) : 0.0
].max
[id, score, customer_name] if score >= MIN_SCORE
end
scored.sort_by { |id, score, customer_name| [-score, customer_name.downcase, id] }
.first(limit)
.map { |id, score, _| [id, score.round(3)] }
end
# Lowercase words with accents and punctuation removed: "O'Brien-Smith, José" -> ["obrien", "smith", "jose"]
def self.tokens(text)
normalized = text.to_s.unicode_normalize(:nfkd).gsub(/\p{Mn}/, '').downcase
normalized = normalized.gsub(/['’]/, '').gsub(/[^a-z0-9]+/, ' ')
words = normalized.split
meaningful = words - STOP_WORDS
meaningful.empty? ? words : meaningful
end
# Double Metaphone codes (primary and alternate) for a word; empty for very short or numeric words
def self.sound_codes(word)
return [] if word.length < 3 || word.match?(/\d/)
Text::Metaphone.double_metaphone(word).compact.reject(&:empty?).uniq
end
def self.phone_score(digits, phones)
phones.map do |number|
if number == digits || number.end_with?(digits) && digits.length >= 7 then 1.0
elsif number.include?(digits) then 0.9
else 0.0
end
end.max || 0.0
end
# Each query word is matched to its best word in the customer's name; the score is the average.
# A query word with no match at all halves the score, so "bill jones" won't match "william smith".
def self.name_score(query, words, codes, memo = {})
return 0.0 if words.empty?
best = query.map do |q_word, q_codes|
scores = (memo[q_word] ||= {})
words.each_with_index.map do |c_word, i|
scores.fetch(c_word) { scores[c_word] = word_score(q_word, q_codes, c_word, codes[i]) }
end.max
end
score = best.sum / best.size
score *= 0.5 if best.any?(&:zero?)
return score if score >= 0.9 # already a strong match; skip the whole-name comparison
# Also compare the names with spaces removed, for "Mc Donald" vs "McDonald". Only worth it when the
# strings could reach the 0.92 bar at all: same first letter and nearly the same length.
query_joined = query.map(&:first).join
name_joined = words.join
return score unless query_joined[0] == name_joined[0] && (query_joined.length - name_joined.length).abs <= 2
joined = DidYouMean::JaroWinkler.distance(query_joined, name_joined)
[score, joined >= 0.92 ? joined * 0.9 : 0.0].max
end
def self.word_score(query, query_codes, candidate, candidate_codes)
return 1.0 if query == candidate
return 0.95 if nicknames?(query, candidate)
return 0.9 if query.length >= 2 && candidate.start_with?(query) # still typing: "wil" -> "william"
return 0.85 if query.length >= 2 && nickname_prefix?(query, candidate) # "bil" -> "william" via "bill"
similarity = DidYouMean::JaroWinkler.distance(query, candidate)
# Sounds the same ("jon"/"john", "smyth"/"smith"). The similarity check keeps unrelated words that
# happen to share a code (e.g. "john" and "ann" via the Spanish-J alternate) from matching.
return 0.88 if similarity >= 0.7 && (query_codes & candidate_codes).any?
return 0.8 if query.length >= 4 && candidate.include?(query) # "donald" in "mcdonald"
return 0.7 if query.length == 1 && candidate.start_with?(query) # an initial
# Typos. Short words need to be closer to count.
threshold = [query.length, candidate.length].min <= 4 ? 0.9 : 0.85
similarity >= threshold ? similarity * 0.9 : 0.0
end
# Nickname matching treats the data as connections between names (the file lists both directions,
# e.g. "william -> bill" and "bill -> william"). Two names match if they are connected directly, or both
# connect to a LONGER name they're short for: "bill" and "will" via "william". Requiring the shared
# name to be longer stops unrelated full names linking through a short one: "bill" is listed for both
# William and Robert, but that doesn't make William match Robert.
def self.nicknames?(a, b)
related_names(a).include?(b)
end
# A partly typed nickname of the candidate's name, e.g. "bil" for "william" (via "bill")
def self.nickname_prefix?(query, candidate)
related_names(candidate).any? { |name| name.start_with?(query) }
end
# All names interchangeable with name, cached per process
def self.related_names(name)
cache = (@related_names_cache ||= {})
cache[name] ||= begin
graph = nickname_graph
direct = graph.fetch(name, EMPTY)
through_full_names = direct.select { |full| full.length > name.length }.flat_map do |full|
graph.fetch(full, EMPTY).select { |other| other.length < full.length }
end
((direct + through_full_names).uniq - [name]).freeze
end
end
EMPTY = [].freeze
# name => [connected names], built once per process from the bundled data plus EXTRA_NICKNAME_GROUPS
def self.nickname_graph
@nickname_graph ||= begin
graph = Hash.new { |h, k| h[k] = [] }
connect = lambda do |a, b|
next if a.empty? || b.empty? || a == b
graph[a] << b
graph[b] << a
end
if File.exist?(NICKNAMES_CSV)
CSV.foreach(NICKNAMES_CSV, headers: true) do |row|
connect.call(row['name1'].to_s.strip.downcase, row['name2'].to_s.strip.downcase)
end
end
EXTRA_NICKNAME_GROUPS.each do |group|
group.combination(2) { |a, b| connect.call(a, b) }
end
graph.transform_values { |names| names.uniq.freeze }.to_h.freeze
end
end
end
+4 -46
View File
@@ -8,55 +8,13 @@
# #
#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.
class CustomerService class CustomerService < ServiceBase
# Initializes the service with a QBO client and an optional customer record. The QBO client is used to communicate with QuickBooks Online, while the customer record contains the data that needs to be pushed to QBO. If no customer is provided, the service will not perform any operations.
def initialize(qbo:, customer: nil)
raise "No QBO configuration found" unless qbo
raise "Customer record is required for push operation" unless customer
@qbo = qbo
@customer = customer
end
# Pulls the customer data from QuickBooks Online.
def pull
return Quickbooks::Model::Customer.new unless @customer.present?
log "Fetching details for customer ##{@customer.id} from QBO..."
qbo = QboConnectionService.current!
qbo.perform_authenticated_request do |access_token|
service = Quickbooks::Service::Customer.new(
company_id: qbo.realm_id,
access_token: access_token
)
service.fetch_by_id(@customer.id)
end
rescue => e
log "Fetch failed for #{@customer.id}: #{e.message}"
Quickbooks::Model::Customer.new
end
# Pushes the customer data to QuickBooks Online. This method handles the communication with QBO, including authentication and error handling. It uses the QBO client to send the customer data and logs the process for monitoring and debugging purposes. If the push is successful, it returns the customer record; otherwise, it logs the error and returns false.
def push
log "Pushing customer ##{@customer.id} to QBO..."
customer = @qbo.perform_authenticated_request do |access_token|
service = Quickbooks::Service::Customer.new(
company_id: @qbo.realm_id,
access_token: access_token
)
service.update(@customer.details)
end
@customer.id = customer.id unless @customer.persisted?
log "Push for customer ##{@customer.id} completed."
return @customer
end
private private
# Log messages with the entity type for better traceability def build_qbo_remote
def log(msg) log "Building new QBO Customer"
Rails.logger.info "[CustomerService] #{msg}" Quickbooks::Model::Customer.new
end end
end end
+5 -8
View File
@@ -17,16 +17,13 @@ class CustomerSyncService < SyncServiceBase
Customer Customer
end end
# Determine if the remote entity should be deleted locally (e.g. if it's marked inactive in QBO) # Determine if the local entity should be deleted (e.g. if it's marked inactive in QBO)
def destroy_remote?(remote) def destroy_local?(remote)
!remote.active? !remote.active?
end end
# Map relevant attributes from the QBO Customer to the local Customer model map_attribute :name, :display_name
def process_attributes(local, remote) map_phone :phone_number, :primary_phone
local.name = remote.display_name map_phone :mobile_phone_number, :mobile_phone
local.phone_number = remote.primary_phone&.free_form_number&.gsub(/\D/, '')
local.mobile_phone_number = remote.mobile_phone&.free_form_number&.gsub(/\D/, '')
end
end end
+3 -6
View File
@@ -17,14 +17,11 @@ class EmployeeSyncService < SyncServiceBase
Employee Employee
end end
# Determine if the remote entity should be deleted locally (e.g. if it's marked inactive in QBO) # Determine if the local entity should be deleted (e.g. if it's marked inactive in QBO)
def destroy_remote?(remote) def destroy_local?(remote)
!remote.active? !remote.active?
end end
# Map relevant attributes from the QBO Employee to the local Employee model map_attribute :name, :display_name
def process_attributes(local, remote)
local.name = remote.display_name
end
end end
@@ -7,10 +7,7 @@
#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.
class InvoicePdfService < PdfServiceBase
def self.model_class class EstimateService < ServiceBase
Invoice
end
end end
+10 -6
View File
@@ -10,6 +10,14 @@
class EstimateSyncService < SyncServiceBase class EstimateSyncService < SyncServiceBase
# sync only one estimate
def sync_by_doc_number(number)
log "Syncing estimate by doc number #{number}"
QboConnectionService.with_qbo_service(entity: @entity) do |service|
persist(service.find_by( :doc_number, number).first)
end
end
private private
# Specify the local model this service syncs # Specify the local model this service syncs
@@ -17,11 +25,7 @@ class EstimateSyncService < SyncServiceBase
Estimate Estimate
end end
# Map relevant attributes from the QBO Estimate to the local Estimate model map_attributes :doc_number, :txn_date
def process_attributes(local, remote) map_belongs_to :customer
local.doc_number = remote.doc_number
local.txn_date = remote.txn_date
local.customer = Customer.find_by(id: remote.customer_ref&.value)
end
end end
@@ -29,8 +29,6 @@ class InvoiceAttachmentService
issue.save! if issue.changed? issue.save! if issue.changed?
log "Attached invoice ##{@invoice.id} to issue ##{issue.id}" log "Attached invoice ##{@invoice.id} to issue ##{issue.id}"
end end
InvoiceCustomFieldSyncService.new(issue, @invoice, @remote).sync
end end
end end
@@ -1,69 +0,0 @@
#The MIT License (MIT)
#
#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:
#
#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.
class InvoiceCustomFieldSyncService
def initialize(issue, invoice, remote)
@issue = issue
@invoice = invoice
@remote = remote
end
# Sync custom fields on the issue based on the invoice data, then push changes to QBO if any fields were updated
def sync
return if @invoice.qbo_sync_locked?
log "Syncing custom fields for issue ##{@issue.id} based on invoice ##{@invoice.doc_number}"
changed = false
# Process Invoice Custom Fields via Hooks
Redmine::Hook.call_hook(
:process_invoice_custom_fields,
issue: @issue,
invoice: @remote
).each do |context|
next unless context
changed ||= context[:is_changed]
log "Custom fields updated by hook, marking invoice for push to QBO" if context[:is_changed]
end
# Process Issue Custom Values from any issue custom fields that match the invoice custom fields
begin
value = @issue.custom_values.find_by(custom_field_id: CustomField.find_by_name(cf.name).id)
# Check to see if the value is blank...
if not value.value.to_s.blank?
# Check to see if the value is diffrent
if not cf.string_value.to_s.eql? value.value.to_s
# update the custom field on the invoice
cf.string_value = value.value.to_s
is_changed = true
end
end
rescue
# Nothing to do here, there is no match
end
push_if_changed if changed
end
private
# If any custom fields were changed during the sync process, this method will trigger a push of the invoice data to QuickBooks Online to ensure that the remote data stays in sync with the local changes. It uses the InvoicePushService to handle the actual communication with QBO.
def push_if_changed
InvoicePushService.new(@invoice).push
end
def log(msg)
Rails.logger.info "[InvoiceCustomFieldSyncService] #{msg}"
end
end
-47
View File
@@ -1,47 +0,0 @@
#The MIT License (MIT)
#
#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:
#
#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.
class InvoicePushService
def initialize(invoice)
@invoice = invoice
end
# Push invoice changes to QBO if the invoice is linked to any issues with custom field changes that need to be synced
def push
return if @invoice.qbo_sync_locked?
log "Pushing invoice ##{@invoice.id} to QBO due to linked issue custom field changes"
@invoice.update_column(:qbo_sync_locked, true)
qbo = QboConnectionService.current!
qbo.perform_authenticated_request do |access_token|
service = Quickbooks::Service::Invoice.new( company_id: qbo.realm_id, access_token: access_token)
remote = service.fetch_by_id(@invoice.id)
# modify remote object here if needed
service.update(remote)
end
rescue => e
Rails.logger.error "[InvoicePushService] #{e.message}"
ensure
@invoice.update_column(:qbo_sync_locked, false)
end
private
def log(msg)
Rails.logger.info "[InvoicePushService] #{msg}"
end
end
+6 -11
View File
@@ -17,19 +17,14 @@ class InvoiceSyncService < SyncServiceBase
Invoice Invoice
end end
# Map relevant attributes from the QBO Invoice to the local Invoice model
def process_attributes(local, remote)
local.doc_number = remote.doc_number
local.txn_date = remote.txn_date
local.due_date = remote.due_date
local.total_amount = remote.total
local.balance = remote.balance
local.qbo_updated_at = remote.meta_data&.last_updated_time
local.customer = Customer.find_by(id: remote.customer_ref&.value)
end
# Attach QBO Invoices to the local Issues # Attach QBO Invoices to the local Issues
def attach_documents(local, remote) def attach_documents(local, remote)
InvoiceAttachmentService.new(local, remote).attach InvoiceAttachmentService.new(local, remote).attach
end end
map_attributes :balance, :doc_number, :due_date, :txn_date
map_attribute :total_amount, :total
map_attribute :qbo_updated_at, "meta_data.last_updated_time"
map_belongs_to :customer
end end
+26
View File
@@ -0,0 +1,26 @@
#The MIT License (MIT)
#
#Copyright (c) 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:
#
#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.
class ItemService < ServiceBase
private
def build_qbo_remote
log "Building new QBO Item"
# New items default to a non-inventory item in the default income account; the item form then
# sets the type and account the user chose.
item = Quickbooks::Model::Item.new
item.type = Quickbooks::Model::Item::NON_INVENTORY_TYPE
default_account = Account.get_default
item.income_account_ref = default_account.ref if default_account
item
end
end
+35
View File
@@ -0,0 +1,35 @@
#The MIT License (MIT)
#
#Copyright (c) 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:
#
#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.
class ItemSyncService < SyncServiceBase
private
# Specify the local model this service syncs
def self.model_class
Item
end
# Specify a page size of 20, as the API only returns 20 items at a time.
def self.page_size
20
end
map_attribute :active, :active?
map_attribute :taxable, :taxable?
# Items without an income account (e.g. categories), or whose account hasn't synced yet, get none
# instead of failing the whole sync; the next sync fills it in.
map_attribute :account do |remote|
account_id = remote.income_account_ref&.value
account_id.present? ? Account.find_by(id: account_id.to_i) : nil
end
map_attributes :description, :id, :name, :sku, :type, :unit_price
end
@@ -7,30 +7,21 @@
#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.
class PdfServiceBase class PdfService
require 'combine_pdf' require 'combine_pdf'
# Subclasses should initialize with a QBO client instance # Subclasses should initialize with a QBO client instance
def initialize(qbo:) def initialize(entity: entity)
@qbo = qbo raise "An entity to sync is required" unless entity
@entity = self.class.model_class @entity = entity
end
# Subclasses must implement this to specify which document model to download pdf (e.g. Estimate, Invoice)
def self.model_class
raise NotImplementedError
end end
# Fetches the PDF for the given entity IDs. If multiple IDs are provided, their PDFs are combined into a single document. # Fetches the PDF for the given entity IDs. If multiple IDs are provided, their PDFs are combined into a single document.
def fetch_pdf(doc_ids:) def fetch_pdf(doc_ids:)
log "Fetching PDFs for #{@entity} IDs: #{doc_ids.join(', ')}" log "Fetching PDFs for #{@entity} IDs: #{doc_ids.join(', ')}"
@qbo.perform_authenticated_request do |access_token| QboConnectionService.with_qbo_service(entity: @entity) do |service|
service_class = "Quickbooks::Service::#{@entity.name}".constantize
service = service_class.new(company_id: @qbo.realm_id, access_token: access_token)
return single_pdf(service, doc_ids.first) if doc_ids.size == 1 return single_pdf(service, doc_ids.first) if doc_ids.size == 1
combined_pdf(service, doc_ids) combined_pdf(service, doc_ids)
end end
end end
+14 -4
View File
@@ -10,6 +10,11 @@
class QboConnectionService class QboConnectionService
# Returns the current QBO connection record. Raises an error if no connection exists.
def self.current!
Qbo.first || raise("QBO not connected")
end
# Replaces the existing QBO connection with new credentials. Deletes all existing records and creates a new one with the provided token, refresh token, and realm ID. Refreshes the token immediately after creation. # Replaces the existing QBO connection with new credentials. Deletes all existing records and creates a new one with the provided token, refresh token, and realm ID. Refreshes the token immediately after creation.
def self.replace!(token:, refresh_token:, realm_id:) def self.replace!(token:, refresh_token:, realm_id:)
Qbo.transaction do Qbo.transaction do
@@ -24,9 +29,14 @@ class QboConnectionService
end end
end end
# Returns the current QBO connection record. Raises an error if no connection exists. # Performs authenticaed requests with QBO service
def self.current! def self.with_qbo_service(entity: nil)
Qbo.first || raise("QBO not connected") qbo = current!
raise "An entity to sync is required" unless entity
service_class ||= "Quickbooks::Service::#{entity}".constantize
qbo.perform_authenticated_request do |access_token|
service = service_class.new( company_id: qbo.realm_id, access_token: access_token )
yield service
end
end end
end end
+7 -4
View File
@@ -10,17 +10,20 @@
class QboOauthService class QboOauthService
# Generates the QuickBooks OAuth authorization URL with the specified callback URL. The URL includes necessary parameters such as response type, state, and scope. # Generates the QuickBooks OAuth authorization URL with the specified callback URL.
def self.authorization_url(callback_url:) # The URL includes necessary parameters such as response type, state, and scope.
# The state value must be stored by the caller and checked when the callback arrives.
def self.authorization_url(callback_url:, state:)
client.auth_code.authorize_url( client.auth_code.authorize_url(
redirect_uri: callback_url, redirect_uri: callback_url,
response_type: "code", response_type: "code",
state: SecureRandom.hex(12), state: state,
scope: "com.intuit.quickbooks.accounting" scope: "com.intuit.quickbooks.accounting"
) )
end end
# Exchanges the authorization code for access and refresh tokens. Creates or replaces the QBO connection record with the new credentials and refreshes the token immediately after creation. # Exchanges the authorization code for access and refresh tokens.
# Creates or replaces the QBO connection record with the new credentials and refreshes the token immediately after creation.
def self.exchange!(code:, callback_url:, realm_id:) def self.exchange!(code:, callback_url:, realm_id:)
resp = client.auth_code.get_token(code, redirect_uri: callback_url) resp = client.auth_code.get_token(code, redirect_uri: callback_url)
QboConnectionService.replace!( token: resp.token, refresh_token: resp.refresh_token, realm_id: realm_id ) QboConnectionService.replace!( token: resp.token, refresh_token: resp.refresh_token, realm_id: realm_id )
+67
View File
@@ -0,0 +1,67 @@
#The MIT License (MIT)
#
#Copyright (c) 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:
#
#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.
class ServiceBase
# Subclasses should Initializes the service with a QBO client and a local record.
# The QBO client is used to communicate with QuickBooks Online, while the local record contains the data that needs to be pushed to QBO.
# If no local is provided, the service will not perform any operations.
def initialize(local: nil)
@entity = local.class.name
raise "#{@entity} record is required for push operation" unless local
@local = local
end
# Subclasses must implement this to build a new QBO entity if a remote is not found
def build_qbo_remote
raise NotImplementedError
end
# Pulls the Item data from QuickBooks Online.
def pull
return build_qbo_remote unless @local.present?
return build_qbo_remote unless @local.id
log "Fetching details for #{@entity} ##{@local.id} from QBO..."
QboConnectionService.with_qbo_service(entity: @entity) do |service|
service.fetch_by_id(@local.id)
end
rescue => e
log "Fetch failed for #{@local.id}: #{e.message}"
build_qbo_remote
end
# Pushes the Item data to QuickBooks Online.
# This method handles the communication with QBO, including authentication and error handling.
# It uses the QBO client to send the remote data and logs the process for monitoring and debugging purposes.
# If the push is successful, it returns the remote record; otherwise, it logs the error and returns false.
def push
log "Pushing #{@entity} ##{@local.id} to QBO..."
remote = QboConnectionService.with_qbo_service(entity: @entity) do |service|
if @local.id.present?
log "Updating #{@entity}"
service.update(@local.details)
else
log "Creating #{@entity}"
service.create(@local.details)
end
end
@local.id = remote.id unless @local.persisted?
log "Push for remote ##{@local.id} completed."
@local
end
private
# Log messages with the entity type for better traceability
def log(msg)
Rails.logger.info "[#{@entity}Service] #{msg}"
end
end
+165 -51
View File
@@ -12,10 +12,14 @@ class SyncServiceBase
PAGE_SIZE = 1000 PAGE_SIZE = 1000
# Subclasses should initialize with a QBO client instance # Subclasses should initialize with a QBO client instance
def initialize(qbo:) def initialize()
raise "No QBO configuration found" unless qbo
@qbo = qbo
@entity = self.class.model_class @entity = self.class.model_class
@page_size = self.class.page_size
end
# Subclasses can implement this to overide the default page size
def self.page_size
@page_size = PAGE_SIZE
end end
# Subclasses must implement this to specify which local model they sync (e.g. Customer, Invoice) # Subclasses must implement this to specify which local model they sync (e.g. Customer, Invoice)
@@ -25,34 +29,25 @@ class SyncServiceBase
# Sync all entities, or only those updated since the last sync # Sync all entities, or only those updated since the last sync
def sync(full_sync: false) def sync(full_sync: false)
log "Starting #{full_sync ? 'full' : 'incremental'} #{@entity.name} sync" log "Starting #{full_sync ? 'full' : 'incremental'} #{@entity.name} sync with page size of: #{@page_size}"
QboConnectionService.with_qbo_service(entity: @entity) do |service|
@qbo.perform_authenticated_request do |access_token| query = build_query(full_sync)
service_class = "Quickbooks::Service::#{@entity.name}".constantize service.query_in_batches(query, per_page: @page_size) do |batch|
service = service_class.new(company_id: @qbo.realm_id, access_token: access_token) entries = Array(batch)
log "Processing batch of #{entries.size} #{@entity.name}"
page = 1 entries.each do |remote|
loop do persist(remote)
collection = fetch_page(service, page, full_sync) end
entries = Array(collection&.entries)
break if entries.empty?
entries.each { |remote| persist(remote) }
break if entries.size < PAGE_SIZE
page += 1
end end
end end
log "#{@entity.name} sync complete" log "#{@entity.name} sync complete"
end end
# Sync a single entity by its QBO ID, used for webhook updates # Sync a single entity by its QBO ID (webhook usage)
def sync_by_id(id) def sync_by_id(id)
log "Syncing #{@entity.name} with ID #{id}" log "Syncing #{@entity.name} with ID #{id}"
@qbo.perform_authenticated_request do |access_token| QboConnectionService.with_qbo_service(entity: @entity) do |service|
service_class = "Quickbooks::Service::#{@entity.name}".constantize
service = service_class.new(company_id: @qbo.realm_id, access_token: access_token)
remote = service.fetch_by_id(id) remote = service.fetch_by_id(id)
persist(remote) persist(remote)
end end
@@ -64,39 +59,152 @@ class SyncServiceBase
# Override in subclasses if the entity has attachments (e.g. Invoice) # Override in subclasses if the entity has attachments (e.g. Invoice)
end end
# Builds a QBO query for retrieving entities
def build_query(full_sync)
if full_sync
"SELECT * FROM #{@entity.name} ORDER BY Id"
else
last_update = @entity.maximum(:updated_at) || 1.year.ago
<<~SQL.squish
SELECT * FROM #{@entity.name}
WHERE MetaData.LastUpdatedTime > '#{last_update.utc.iso8601}'
ORDER BY MetaData.LastUpdatedTime
SQL
end
end
# Determine if a remote entity should be deleted locally (e.g. if it's marked inactive in QBO) # Determine if a remote entity should be deleted locally (e.g. if it's marked inactive in QBO)
def destroy_remote?(remote) def destroy_local?(remote)
false false
end end
def extract_value(remote, remote_attr)
case remote_attr
when Proc
remote_attr.call(remote)
else
remote.public_send(remote_attr)
end
end
# Attribute Mapping DSL
#
# This DSL defines how attributes from a QuickBooks Online (QBO) entity
# are mapped onto a local ActiveRecord model during synchronization.
#
# Each mapping registers a lambda in `attribute_map`. When a remote QBO
# object is processed, the lambda is executed to extract and transform
# the value that will be assigned to the local model attribute.
#
# The DSL supports several mapping patterns:
#
# 1. Direct attribute mapping (same name)
#
# map_attribute :doc_number
#
# Equivalent to:
#
# local.doc_number = remote.doc_number
#
# 2. Renamed attribute mapping
#
# map_attribute :total_amount, :total
#
# Equivalent to:
#
# local.total_amount = remote.total
#
# 3. Custom transformation logic
#
# map_attribute :qbo_updated_at do |remote|
# remote.meta_data&.last_updated_time
# end
#
# Useful for nested fields or computed values.
#
# 4. Bulk attribute mapping
#
# map_attributes :doc_number, :txn_date, :due_date
#
# Convenience helper that maps multiple attributes with identical names.
#
# 5. Foreign key / reference mapping
#
# map_belongs_to :customer
#
# Resolves a QBO reference object (e.g. `customer_ref.value`) and finds
# the associated local ActiveRecord model.
#
# 6. Specialized helpers
#
# map_phone :phone_number, :primary_phone
#
# Extracts and normalizes phone numbers by stripping non-digit characters.
#
# Internally, the mappings are stored in `attribute_map` and executed by the
# SyncService during `process_attributes`, which iterates through each mapping
# and assigns the computed value to the local record.
#
# This design keeps synchronization services declarative, readable, and easy
# to extend while centralizing transformation logic in a single DSL.
class << self
def map_attributes(*attrs)
attrs.each do |attr|
map_attribute(attr)
end
end
def map_attribute(local_attr, remote_attr = nil, &block)
attribute_map[local_attr] =
if block_given?
block
elsif remote_attr
->(remote) do
remote_attr.to_s.split('.').reduce(remote) do |obj, method|
obj&.public_send(method)
end
end
else
->(remote) { remote.public_send(local_attr) }
end
end
def attribute_map
@attribute_map ||= {}
end
def map_belongs_to(local_attr, ref: nil, model: nil)
ref ||= "#{local_attr}_ref"
model ||= local_attr.to_s.classify.constantize
attribute_map[local_attr] = lambda do |remote|
ref_obj = remote.public_send(ref)
id = ref_obj&.value
id ? model.find_by(id: id) : nil
end
end
def map_phone(local_attr, remote_attr)
attribute_map[local_attr] = lambda do |remote|
phone = remote.public_send(remote_attr)
phone&.free_form_number&.gsub(/\D/, '')
end
end
end
# Log messages with the entity type for better traceability # Log messages with the entity type for better traceability
def log(msg) def log(msg)
Rails.logger.info "[#{@entity.name}SyncService] #{msg}" Rails.logger.info "[#{@entity.name}SyncService] #{msg}"
end end
# Fetch a page of entities, either all or only those updated since the last sync
def fetch_page(service, page, full_sync)
log "Fetching page #{page} of #{@entity.name} from QBO (#{full_sync ? 'full' : 'incremental'} sync)"
start_position = (page - 1) * PAGE_SIZE + 1
if full_sync
service.query("SELECT * FROM #{@entity.name} STARTPOSITION #{start_position} MAXRESULTS #{PAGE_SIZE}")
else
last_update = @entity.maximum(:updated_at) || 1.year.ago
service.query(<<~SQL.squish)
SELECT * FROM #{@entity.name}
WHERE MetaData.LastUpdatedTime > '#{last_update.utc.iso8601}'
STARTPOSITION #{start_position}
MAXRESULTS #{PAGE_SIZE}
SQL
end
end
# Create or update a local entity record based on the QBO remote data # Create or update a local entity record based on the QBO remote data
def persist(remote) def persist(remote)
local = @entity.find_or_initialize_by(id: remote.id) local = @entity.find_or_initialize_by(id: remote.id)
if destroy_remote?(remote) if destroy_local?(remote)
if local.persisted? if local.persisted?
local.destroy local.destroy
log "Deleted #{@entity.name} #{remote.id}" log "Deleted #{@entity.name} #{remote.id}"
@@ -104,14 +212,13 @@ class SyncServiceBase
return return
end end
# Map remote attributes to local model fields, this should be implemented in subclasses
process_attributes(local, remote) process_attributes(local, remote)
if local.changed? if local.new_record? || local.changed?
was_new = local.new_record?
local.skip_qbo_push = true
local.save! local.save!
log "Updated #{@entity.name} #{remote.id}" log "#{was_new ? 'Created' : 'Updated'} #{@entity.name} #{remote.id}"
# Handle attaching documents if applicable to invoices
attach_documents(local, remote) attach_documents(local, remote)
end end
@@ -119,9 +226,16 @@ class SyncServiceBase
log "Failed to sync #{@entity.name} #{remote.id}: #{e.message}" log "Failed to sync #{@entity.name} #{remote.id}: #{e.message}"
end end
# This method should be implemented in subclasses to map remote attributes to local model # Maps remote attributes to local model
def process_attributes(local, remote) def process_attributes(local, remote)
raise NotImplementedError, "Subclasses must implement process_attributes" log "Processing #{@entity} ##{remote.id}"
end
self.class.attribute_map.each do |local_attr, mapper|
value = mapper.call(remote)
if local.public_send(local_attr) != value
local.public_send("#{local_attr}=", value)
end
end
end
end end
+37
View File
@@ -0,0 +1,37 @@
<h2><%= l(:label_accounts) %></h2>
<%= form_tag set_default_accounts_path, method: :patch do %>
<div class="autoscroll">
<table class="list accounts">
<thead>
<tr>
<th style="width:50px;"><%= l(:label_default) %></th>
<th><%= l(:field_name) %></th>
<th><%= l(:field_description) %></th>
<th><%= l(:field_classification) %></th>
<th class="center"><%= l(:field_active) %></th>
</tr>
</thead>
<tbody>
<% @accounts.each do |account| %>
<tr class="<%= cycle("odd", "even") %>">
<td class="center">
<%= radio_button_tag "default_account_id", account.id, account.default %>
</td>
<td class="name"><strong><%= account.name %></strong></td>
<td class="description"><%= truncate(account.description, length: 80) %></td>
<td class="classification"><%= account.classification %></td>
<td class="active center">
<%= checked_image account.active %>
</td>
</tr>
<% end %>
</tbody>
</table>
</div>
<p class="buttons">
<%= submit_tag l(:button_save), class: 'button-small' %>
</p>
<% end %>
-11
View File
@@ -1,11 +0,0 @@
<%= link_to t(:label_appointment), "https://calendar.google.com/calendar/render?action=TEMPLATE&text=#{@customer.name}+-&details=#{ link_to t(:customer_details), "https://#{Setting.host_name}#{customer_path @customer.id}"}%0A#{@customer.primary_phone}%3Cbr/%3E+&dates=#{Time.now.strftime("%Y%m%d")}T090000/#{Time.now.strftime("%Y%m%d")}T170000", target: :_blank, id: :appointment_link %>
<br/>
<br/>
<%= link_to t(:label_create_estimate), "https://qbo.intuit.com/app/estimate?nameId=#{@customer.id}", target: :_blank %>
<br/>
<br/>
<%= button_to t(:label_edit_customer), edit_customer_path(@customer), method: :get%>
+13 -17
View File
@@ -2,57 +2,53 @@
<tbody> <tbody>
<tr> <tr>
<th><%=t(:label_name)%></th> <th><%= t(:label_name) %></th>
<td><%= customer.name %></td> <td><%= customer.name %></td>
</tr> </tr>
<tr> <tr>
<th><%=t(:label_email)%></th> <th><%= t(:label_email) %></th>
<td><%= customer.email %></td> <td><%= customer.email %></td>
</tr> </tr>
<tr> <tr>
<th><%=t(:label_primary_phone)%></th> <th><%= t(:label_primary_phone) %></th>
<td><%= number_to_phone(customer&.primary_phone&.gsub(/[^\d]/, '').to_i, area_code: true) %></td> <td><%= number_to_phone(customer&.primary_phone&.gsub(/[^\d]/, '').to_i, area_code: true) %></td>
</tr> </tr>
<tr> <tr>
<th><%=t(:label_mobile_phone)%></th> <th><%= t(:label_mobile_phone) %></th>
<td><%= number_to_phone(customer&.mobile_phone&.gsub(/[^\d]/, '').to_i, area_code: true) %></td> <td><%= number_to_phone(customer&.mobile_phone&.gsub(/[^\d]/, '').to_i, area_code: true) %></td>
</tr> </tr>
<tr> <tr>
<th><%=t(:label_billing_address)%></th> <th><%= t(:label_billing_address) %></th>
<td><pre><%= @billing_address %></pre></td> <td><pre><%= @billing_address %></pre></td>
</tr> </tr>
<tr> <tr>
<th><%=t(:label_shipping_address)%></th> <th><%= t(:label_shipping_address) %></th>
<td><pre><%= @shipping_address %></pre></td> <td><pre><%= @shipping_address %></pre></td>
</tr> </tr>
<tr> <tr>
<th><%=t(:label_account_balance)%></th> <th><%= t(:label_account_balance) %></th>
<td>$<%= customer.balance %></td> <td>$<%= customer.balance %></td>
</tr> </tr>
<% if customer.notes.present? %>
<tr> <tr>
<th colspan="2"><h4><%=t(:field_notes)%></hr></th> <th colspan="2"><h4><%= t(:field_notes) %></h4></th>
</tr> </tr>
<tr> <tr>
<td colspan="2"> <td colspan="2">
<pre id="note-display" style="text-align: left; white-space: pre-wrap; font-family: inherit;"> <div class="wiki">
<%= customer.notes %> <%= textilizable(customer, :notes) %>
</pre> </div>
</td> </td>
</tr> </tr>
<% end %>
<script>
const preElement = document.getElementById('note-display');
// This takes the text, trims the edges, and puts it back
preElement.textContent = preElement.textContent.trim();
</script>
</tbody> </tbody>
</table> </table>
+23 -52
View File
@@ -1,59 +1,30 @@
<div class="row"> <%#
<div class="span6 columns"> Customer form, in Redmine's form style. Also loaded by redmine_qbo_calendar's quick-create popup
<fieldset> (hide_submit / hide_toolbar), which relies on the form tag being here and the name field's
customer_name id.
%>
<%= labelled_form_for @customer do |f| %>
<%= error_messages_for 'customer' %>
<%= form_for @customer do |f| %> <div class="box tabular">
<div class="clearfix">
<%=t(:label_display_name)%>
<div class="input">
<%= f.text_field :name, required: true, autocomplete: "off" %>
</div>
</div>
<div class="clearfix">
<%=t(:label_primary_phone)%>
<div class="input">
<%= f.telephone_field :primary_phone, autocomplete: "off" %>
</div>
</div>
<div class="clearfix">
<%=t(:label_mobile_phone)%>:
<div class="input">
<%= f.telephone_field :mobile_phone, autocomplete: "off" %>
</div>
</div>
<div class="clearfix">
<%=t(:label_email)%>:
<div class="input">
<%= f.email_field :email, autocomplete: "off" %>
</div>
</div>
<div class="clearfix">
<%=t(:field_notes)%>:
<div class="input">
<p> <p>
<%= content_tag :span, id: "issue_description_and_toolbar" do %> <%= f.text_field :name, label: :label_display_name, required: true, size: 60,
<%= f.text_area :notes, class: 'customer-name', autocomplete: 'off',
cols: 60, data: { autocomplete_url: '/customers/autocomplete' } %>
rows: 10, </p>
accesskey: accesskey(:edit), <p><%= f.telephone_field :primary_phone, label: :label_primary_phone, size: 20, autocomplete: 'off' %></p>
class: 'wiki-edit', <p><%= f.telephone_field :mobile_phone, label: :label_mobile_phone, size: 20, autocomplete: 'off' %></p>
no_label: true %> <p><%= f.email_field :email, label: :label_email, size: 60, autocomplete: 'off' %></p>
<p>
<%= f.text_area :notes, label: :field_notes, rows: 8, class: 'wiki-edit', id: 'customer_notes' %>
<% unless local_assigns[:hide_toolbar] %>
<%= wikitoolbar_for 'customer_notes' %>
<% end %> <% end %>
</p> </p>
<%= wikitoolbar_for :issue_description %>
</div>
</div> </div>
<div class="actions"> <% unless local_assigns[:hide_submit] %>
<%= f.submit %> <%= submit_tag @customer.new_record? ? l(:button_create) : l(:button_save) %>
</div> <%= link_to l(:button_cancel), @customer.new_record? ? customers_path : customer_path(@customer) %>
<% end %> <% end %>
<% end %>
</fieldset>
</div>
</div>
@@ -0,0 +1,59 @@
<%#
Adds the estimate and vehicle ticked on the customer page to the "New issue" link
(#dynamic-new-issue-link in the contextual area). One of each can be ticked.
%>
<script>
function handleSingleSelect(event, className) {
if (event.target.checked) {
// Uncheck all other checkboxes of the same type
document.querySelectorAll('.' + className).forEach(cb => {
if (cb !== event.target) {
cb.checked = false;
}
});
}
updateLink();
}
// Bind single-select behavior to checkboxes once the DOM is loaded
document.addEventListener('DOMContentLoaded', function() {
document.querySelectorAll('.estimate-checkbox').forEach(cb => {
cb.addEventListener('change', (e) => handleSingleSelect(e, 'estimate-checkbox'));
});
document.querySelectorAll('.vehicle-checkbox').forEach(cb => {
cb.addEventListener('change', (e) => handleSingleSelect(e, 'vehicle-checkbox'));
});
});
function updateLink() {
const link = document.getElementById('dynamic-new-issue-link');
if (!link) return;
// Cache the pristine base URL on first run
if (!link.dataset.baseUrl) {
link.dataset.baseUrl = link.getAttribute('href');
}
// Build base URL object
let url = new URL(link.dataset.baseUrl, window.location.origin);
// 1. Handle Single Estimate
const checkedEstimate = document.querySelector('.estimate-checkbox:checked');
if (checkedEstimate) {
url.searchParams.set('issue[estimate_id]', checkedEstimate.value);
} else {
url.searchParams.delete('issue[estimate_id]');
}
// 2. Handle Single Vehicle
const checkedVehicle = document.querySelector('.vehicle-checkbox:checked');
if (checkedVehicle) {
url.searchParams.set('issue[vehicle_id]', checkedVehicle.value);
} else {
url.searchParams.delete('issue[vehicle_id]');
}
// Update the link's href attribute
link.setAttribute('href', url.toString());
}
</script>
+5 -2
View File
@@ -1,5 +1,8 @@
<%= form_tag(customers_path, method: "get", id: "customer-search-form") do %> <%= form_tag(customers_path, method: "get", id: "customer-search-form") do %>
<%= text_field_tag :search, params[:search], placeholder: t(:label_search_customers), autocomplete: "off" %> <%= text_field_tag :search, params[:search], class: "customer-name", placeholder: t(:label_search_customers), autocomplete: "off", data: { autocomplete_url: "/customers/autocomplete" } %>
<%= submit_tag t(:label_search) %> <%= submit_tag t(:label_search) %>
<% end %> <% end %>
<%= button_to t(:label_new_customer), new_customer_path, method: :get%> <% if User.current.allowed_to?(:add_customers, nil, global: true) %>
<%= button_to t(:label_new_customer), new_customer_path, method: :get%>
<% end %>
<%= button_to(t(:label_sync), qbo_sync_path, method: :get) if User.current.admin?%>
+4 -2
View File
@@ -1,3 +1,5 @@
<h1><%=t(:label_edit_customer)%></h1> <h2><%= link_to l(:label_customers), customers_path %> &#187; <%= link_to @customer.to_s, customer_path(@customer) %></h2>
<br/>
<%= render partial: 'customers/form' %> <%= render partial: 'customers/form' %>
<% html_title(l(:label_edit_customer)) -%>
+4 -2
View File
@@ -1,3 +1,5 @@
<h2><%=t(:label_new_customer)%></h2> <h2><%= link_to l(:label_customers), customers_path %> &#187; <%= l(:label_new_customer) %></h2>
<br/>
<%= render partial: 'customers/form' %> <%= render partial: 'customers/form' %>
<% html_title(l(:label_new_customer)) -%>
+29 -11
View File
@@ -1,4 +1,30 @@
<h2><%=t(:field_customer)%> #<%= @customer.id %> - <%= link_to @customer.to_s, "https://#{Setting.plugin_redmine_qbo[:sandbox] ? "sandbox" : "app"}.qbo.intuit.com/app/customerdetail?nameId=#{@customer.id}", target: :_blank %> </h2> <div class="contextual">
<%# New issue for this customer; picks up the estimate / vehicle ticked on this page %>
<%= link_to sprite_icon('add', l(:label_new_issue)), new_issue_path(issue: { customer_id: @customer.id }),
id: 'dynamic-new-issue-link', class: 'icon icon-add', target: :_blank %>
<%# Plugins add their customer actions here (e.g. redmine_qbo_calendar's Add appointment) %>
<%= call_hook :view_customers_show_contextual, { customer: @customer } %>
<%# Estimates, invoices and payments are handled here, each shown to users with its permission. The customer's
name below links to their QuickBooks account page as a fallback. %>
<% if RedmineQboBilling.writer? %>
<%= render partial: 'qbo_estimates/customer_link', locals: { customer: @customer } %>
<% end %>
<% if RedmineQboBilling.invoice_writer? %>
<%= render partial: 'qbo_invoices/customer_link', locals: { customer: @customer } %>
<% end %>
<% if RedmineQboBilling.payment_viewer? %>
<%= link_to sprite_icon('list', l(:label_payments)), qbo_payments_path(customer_id: @customer.id), class: 'icon icon-list' %>
<% end %>
<% if RedmineQboBilling.payment_receiver? %>
<%= link_to sprite_icon('add', l(:button_receive_payment)), new_qbo_payment_path(customer_id: @customer.id), class: 'icon icon-add' %>
<% end %>
<% if User.current.allowed_to?(:edit_customers, nil, global: true) %>
<%= link_to sprite_icon('edit', l(:button_edit)), edit_customer_path(@customer),
class: 'icon icon-edit', accesskey: accesskey(:edit) %>
<% end %>
</div>
<h2><%=t(:field_customer)%> #<%= @customer.id %> - <%= link_to @customer.to_s, "https://#{RedmineQbo.sandbox_mode? ? "sandbox" : "app"}.qbo.intuit.com/app/customerdetail?nameId=#{@customer.id}", target: :_blank %> </h2>
<div class="issue"> <div class="issue">
<div class="splitcontent"> <div class="splitcontent">
@@ -9,17 +35,7 @@
<!-- Customer Info --> <!-- Customer Info -->
<div class="splitcontent">
<div class="splitcontentleft">
<h4><%=t(:field_customer)%>:</h4>
<%= render partial: 'customers/details', locals: {customer: @customer} %> <%= render partial: 'customers/details', locals: {customer: @customer} %>
</div>
<div class="splitcontentleft">
<h4><%=t(:label_actions)%>:</h4>
<%= render partial: 'customers/actions', locals: {customer: @customer} %>
</div>
</div>
<!-- QBO Info --> <!-- QBO Info -->
@@ -51,3 +67,5 @@
<h3><%=@closed_issues.count%> <%=t(:label_closed_issues)%> - <%= @closed_hours.round(1)%> <%=t(:label_hours)%></h3> <h3><%=@closed_issues.count%> <%=t(:label_closed_issues)%> - <%= @closed_hours.round(1)%> <%=t(:label_hours)%></h3>
<%= render partial: 'issues/list_simple', locals: {issues: @closed_issues} %> <%= render partial: 'issues/list_simple', locals: {issues: @closed_issues} %>
<%= render partial: 'customers/new_issue_link_script' %>
+2 -1
View File
@@ -2,8 +2,9 @@
<% estimates.sort.reverse.each do |estimate| %> <% estimates.sort.reverse.each do |estimate| %>
<div class="row"> <div class="row">
<%= check_box_tag "estimate_ids[]", estimate.id, false, onchange: "updateLink()", data: { url: estimate_path(estimate), text: "Estimate ##{estimate.to_s}" }, class: "estimate-checkbox appointment" %> <%= check_box_tag "estimate_ids[]", estimate.id, false, onchange: "updateLink()", data: { text: "Estimate ##{estimate.doc_number}" }, class: "estimate-checkbox appointment" %>
<b><%= link_to "##{estimate.doc_number}", estimate_path(estimate), target: :_blank %></b> <%= estimate.txn_date %> <b><%= link_to "##{estimate.doc_number}", estimate_path(estimate), target: :_blank %></b> <%= estimate.txn_date %>
<%= render partial: 'qbo_estimates/estimate_actions', locals: { estimate: estimate } if RedmineQboBilling.writer? %>
</div> </div>
<% end %> <% end %>
+1
View File
@@ -14,6 +14,7 @@
<div class="row"> <div class="row">
<%= check_box_tag "invoice_ids[]", invoice.id, false, onchange: "updateLink()", data: { url: invoice_path(invoice), text: "Invoice ##{invoice.to_s}" }, class: "invoice-checkbox appointment" if invoices.count > 1 %> <%= check_box_tag "invoice_ids[]", invoice.id, false, onchange: "updateLink()", data: { url: invoice_path(invoice), text: "Invoice ##{invoice.to_s}" }, class: "invoice-checkbox appointment" if invoices.count > 1 %>
<b><%= link_to "##{invoice.doc_number}", invoice_path(invoice), target: :_blank %></b> <%= invoice.txn_date %> <b><%= link_to "##{invoice.doc_number}", invoice_path(invoice), target: :_blank %></b> <%= invoice.txn_date %>
<%= render partial: 'qbo_invoices/invoice_actions', locals: { invoice: invoice } if RedmineQboBilling.invoice_writer? %>
</div> </div>
<% end %> <% end %>
+4 -1
View File
@@ -7,7 +7,10 @@
<div class="estimate_id attribute"> <div class="estimate_id attribute">
<div class="label"><span><%=t(:field_estimate)%></span>:</div> <div class="label"><span><%=t(:field_estimate)%></span>:</div>
<div class="value"><%= estimate_link %></div> <div class="value">
<%= estimate_link %>
<%= render partial: 'qbo_estimates/estimate_actions', locals: { estimate: issue.estimate } if issue.estimate && RedmineQboBilling.writer? %>
</div>
</div> </div>
<div class="invoice_id attribute"> <div class="invoice_id attribute">
+50
View File
@@ -0,0 +1,50 @@
<%= labelled_form_for @item do |f| %>
<%= error_messages_for 'item' %>
<div class="box tabular">
<p>
<%= f.text_field :name, required: true, size: 60 %>
</p>
<p>
<%= f.text_field :sku, size: 30 %>
</p>
<p>
<%= f.text_area :description, rows: 4, class: 'wiki-edit' %>
</p>
<p>
<%= f.text_field :unit_price,
class: "price-field",
inputmode: "decimal",
autocomplete: "off"%>
</p>
<p>
<%= f.check_box :taxable %>
</p>
<p>
<%= f.label :account_id, l(:label_account) %>
<%= f.collection_select :account_id,
Account.where(classification: 'Revenue').order(:name),
:id,
:name,
{ selected: @item.account_id || Account.get_default&.id, include_blank: true } %>
</p>
<p>
<%= f.select :type,
Quickbooks::Model::Item::ITEM_TYPES.map { |t| [t, t] },
{ selected: @item.type || Quickbooks::Model::Item::NON_INVENTORY_TYPE } %>
</p>
<p>
<%= f.check_box :active %>
</p>
</div>
<%= submit_tag l(:button_save) %>
<%= link_to l(:button_cancel), items_path if controller.action_name == 'edit' %>
<% end %>
+3
View File
@@ -0,0 +1,3 @@
<h2><%=t(:label_edit_item)%></h2>
<%= render "form" %>
+56
View File
@@ -0,0 +1,56 @@
<div class="contextual">
<%= link_to l(:label_item_new), new_item_path, class: 'icon icon-add' %>
</div>
<h2><%= l(:label_items) %></h2>
<% if @items.any? %>
<div class="autoscroll">
<table class="list items">
<thead>
<tr>
<th><%= l(:field_name) %></th>
<th><%= l(:field_sku) %></th>
<th><%= l(:field_description) %></th>
<th><%= l(:field_unit_price) %></th>
<th class="center"><%= l(:field_taxable) %></th>
<th class="center"><%= l(:field_active) %></th>
<th></th>
</tr>
</thead>
<tbody>
<% @items.each do |item| %>
<tr class="<%= cycle("odd", "even") %>">
<td class="name"><%= link_to item.name, item_path(item) %></td>
<td class="sku"><%= item.sku %></td>
<td class="description"><%= truncate(item.description, length: 60) %></td>
<td class="unit_price"><%= number_to_currency(item.unit_price) %></td>
<td class="taxable center">
<% if item.taxable %>
<span class="icon icon-ok" style="color: green;"><%= l(:general_text_Yes) %></span>
<% else %>
<span class="icon icon-not-ok" style="color: #999;"><%= l(:general_text_No) %></span>
<% end %>
</td>
<td class="active center">
<% if item.active %>
<span class="icon icon-ok" style="color: green;"><%= l(:general_text_Yes) %></span>
<% else %>
<span class="icon icon-not-ok" style="color: #999;"><%= l(:general_text_No) %></span>
<% end %>
</td>
<td class="buttons">
<%= link_to l(:button_edit), edit_item_path(item), class: 'icon icon-edit' %>
<%= link_to l(:button_delete), item_path(item),
method: :delete,
data: { confirm: l(:text_are_you_sure) },
class: 'icon icon-del' %>
</td>
</tr>
<% end %>
</tbody>
</table>
</div>
<% else %>
<p class="nodata"><%= l(:label_no_data) %></p>
<% end %>
+5
View File
@@ -0,0 +1,5 @@
<h2><%=t(:label_item_new)%></h2>
<%= render "form" %>
<%= link_to t(:label_back), items_path %>
+44
View File
@@ -0,0 +1,44 @@
<div class="contextual">
<%= link_to l(:button_edit), edit_item_path(@item), class: 'icon icon-edit' %>
<%= link_to l(:button_back), items_path, class: 'icon icon-list' %>
</div>
<h2><%= t(:item) %># <%= @item.id %> <%= @item.name %></h2>
<div class="issue details"> <div class="attributes">
<div class="splitcontent">
<div class="splitcontentleft">
<p><strong><%=t(:field_sku)%>:</strong> <%= @item.sku.presence || "-" %></p>
<p><strong><%=t(:label_type)%>:</strong> <%= @item.type.presence || "-" %></p>
<p><strong><%=t(:field_unit_price)%>:</strong> <%= number_to_currency(@item.unit_price) %></p>
</div>
<div class="splitcontentleft">
<p><strong><%=t(:label_account)%>:</strong> <%= @item.account&.name || "-" %></p>
<p>
<strong><%=t(:field_taxable)%>:</strong>
<% if @item.taxable %>
<span class="icon icon-ok" style="color: green;"><%=t(:yes)%></span>
<% else %>
<span class="icon icon-not-ok" style="color: #999;"><%=t(:no)%></span>
<% end %>
</p>
<p>
<strong><%=t(:label_active)%>:</strong>
<% if @item.active %>
<span class="icon icon-ok" style="color: green;"><%=t(:yes)%></span>
<% else %>
<span class="icon icon-not-ok" style="color: #999;"><%=t(:no)%></span>
<% end %>
</p>
</div>
</div>
<hr />
<p><strong><%=t(:label_description)%>:</strong></p>
<div class="wiki" style="padding-left: 20px;">
<%= @item.description.presence || "<em>No description provided</em>".html_safe %>
</div>
</div>
</div>
+83
View File
@@ -0,0 +1,83 @@
<div class="box tabular settings">
<p>
<label for="settings_expiration_days"><%= l(:label_estimate_expiration_days) %></label>
<%= number_field_tag 'settings[expiration_days]', @settings['expiration_days'], id: 'settings_expiration_days',
min: 0, step: 1, size: 6 %>
<em class="info"><%= l(:text_estimate_expiration_days) %></em>
</p>
<p>
<label for="settings_replaceable_item_ids"><%= l(:label_replaceable_items) %></label>
<%= hidden_field_tag 'settings[replaceable_item_ids][]', '', id: nil %>
<%= select_tag 'settings[replaceable_item_ids][]',
options_from_collection_for_select(Item.where(active: true).order(:name), :id, :name,
Array(@settings['replaceable_item_ids']).map(&:to_s)),
multiple: true, size: 8, id: 'settings_replaceable_item_ids' %>
<em class="info"><%= l(:text_replaceable_items) %></em>
</p>
</div>
<%# Issues from estimates (moved from redmine_qbo_calendar; its old values are shown until these are saved) %>
<% issue_builder = RedmineQboBilling::EstimateIssueBuilder %>
<fieldset class="box tabular">
<legend><%= l(:label_estimate_issue_settings) %></legend>
<p>
<label for="settings_issue_item_codes"><%= l(:label_estimate_item_codes) %></label>
<%= text_area_tag 'settings[issue_item_codes]', issue_builder.item_codes.join("\n"), rows: 5, cols: 30, id: 'settings_issue_item_codes' %>
<em class="info"><%= l(:text_estimate_item_codes_info) %></em>
</p>
<p>
<label for="settings_issue_default_project_id"><%= l(:label_default_project) %></label>
<%= select_tag 'settings[issue_default_project_id]',
project_tree_options_for_select(Project.active.sorted, selected: Project.find_by(id: issue_builder.default_project_id)),
include_blank: true, id: 'settings_issue_default_project_id' %>
<em class="info"><%= l(:text_default_project_info) %></em>
</p>
<p>
<label for="settings_issue_default_tracker_id"><%= l(:label_default_tracker) %></label>
<%= select_tag 'settings[issue_default_tracker_id]',
options_from_collection_for_select(Tracker.sorted, :id, :name, issue_builder.default_tracker_id),
include_blank: true, id: 'settings_issue_default_tracker_id' %>
<em class="info"><%= l(:text_default_tracker_info) %></em>
</p>
</fieldset>
<%# QuickBooks product/service list and income accounts (moved from redmine_qbo_lineitems) %>
<div class="box tabular">
<p>
<label><strong><%= t(:label_item_count) %></strong></label>
<%= Item.count %>
<em style="color: #777; font-size: 0.9em; margin-left: 8px;">
(@ <%= Item.last_sync %>)
</em>
</p>
<p>
<label><strong><%= t(:label_account_count) %></strong></label>
<%= Account.count %>
<em style="color: #777; font-size: 0.9em; margin-left: 8px;">
(@ <%= Account.last_sync %>)
</em>
</p>
<p>
<label><strong><%= t(:label_last_sync) %> (QBO)</strong></label>
<%= Qbo.exists? ? Qbo.last_sync : l(:label_never_synced) %>
</p>
<p>
<label><strong><%= t(:label_default_account) %></strong></label>
<%= Account.get_default %>
</p>
</div>
<fieldset class="box">
<legend><%= l(:label_management_and_sync) %></legend>
<div style="margin-bottom: 15px;">
<%= link_to t(:label_sync_now_items), sync_items_path, class: 'button icon icon-reload' %>
<%= link_to t(:label_sync_now_accounts), sync_accounts_path, class: 'button icon icon-reload' %>
</div>
<div>
<%= link_to t(:label_items), items_path, class: 'icon icon-list' %>
<span style="margin: 0 10px; color: #ccc;">|</span>
<%= link_to t(:label_accounts), accounts_path, class: 'icon icon-list' %>
</div>
</fieldset>
+67 -95
View File
@@ -1,111 +1,83 @@
<!--
The MIT License (MIT)
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:
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.
-->
<!-- somewhere in your document include the Javascript -->
<script type="text/javascript" src="https://appcenter.intuit.com/Content/IA/intuit.ipp.anywhere.js"></script> <script type="text/javascript" src="https://appcenter.intuit.com/Content/IA/intuit.ipp.anywhere.js"></script>
<!-- configure the Intuit object: 'grantUrl' is a URL in your application which kicks off the flow, see below -->
<script> <script>
intuit.ipp.anywhere.setup({menuProxy: '/path/to/blue-dot', grantUrl: '<%= qbo_authenticate_path %>'}); intuit.ipp.anywhere.setup({menuProxy: '/path/to/blue-dot', grantUrl: '<%= qbo_authenticate_path %>'});
</script> </script>
<table > <div class="box tabular">
<tbody> <p>
<label><%= t(:label_client_id) %></label>
<%= text_field_tag 'settings[oauth_consumer_key]', settings[:oauth_consumer_key], size: 50 %>
</p>
<tr> <p>
<th><%=t(:label_client_id)%></th> <label><%= t(:label_client_secret) %></label>
<td> <%= password_field_tag 'settings[oauth_consumer_secret]', settings[:oauth_consumer_secret], size: 50 %>
<input </p>
type="text"
style="width:350px"
id="settingsOAuthConsumerKey"
value="<%= settings['settingsOAuthConsumerKey'] %>"
name="settings[settingsOAuthConsumerKey]" >
</td>
</tr>
<tr> <p>
<th><%=t(:label_client_secret)%></th> <label><%= t(:label_webhook_token) %></label>
<td> <%= text_field_tag 'settings[webhook_token]', settings[:webhook_token], size: 50 %>
<input </p>
type="text"
style="width:350px"
id="settingsOAuthConsumerSecret"
value="<%= settings['settingsOAuthConsumerSecret'] %>"
name="settings[settingsOAuthConsumerSecret]" >
</td>
</tr>
<tr> <p>
<th><%=t(:label_webhook_token)%></th> <label><%= t(:label_sandbox) %></label>
<td> <%= check_box_tag 'settings[sandbox]', 1, settings[:sandbox] %>
<input </p>
type="text"
style="width:350px"
id="settingsWebhookToken"
value="<%= settings['settingsWebhookToken'] %>"
name="settings[settingsWebhookToken]" >
</td>
</tr>
<tr> <hr />
<th><%=t(:label_sandbox)%></th>
<td>
<%= check_box_tag 'settings[sandbox]', @settings[:sandbox], @settings[:sandbox] %>
</td>
</tr>
<tr> <p>
<th><%=t(:label_oauth_expires)%></th> <label><%= t(:label_oauth_expires) %></label>
<td><%= QboConnectionService.current!&.oauth2_access_token_expires_at %> <span class="icon <%= Qbo.oauth2_access_token_expires_at&.future? ? 'icon-ok' : 'icon-warning' %>">
</tr> <%= Qbo.oauth2_access_token_expires_at || 'N/A' %>
</span>
</p>
<tr> <p>
<th><%=t(:label_oauth2_refresh_token_expires_at)%></th> <label><%= t(:label_customer_count) %></label>
<td><%= QboConnectionService.current!&.oauth2_refresh_token_expires_at %> <%= Customer.count %>
</tr> <em style="color: #777; font-size: 0.9em; margin-left: 8px;">(@ <%= Customer.last_sync %>)</em>
</p>
</tbody> <p>
</table> <label><%= t(:label_employee_count) %></label>
<%= Employee.count %>
<em style="color: #777; font-size: 0.9em; margin-left: 8px;">(@ <%= Employee.last_sync %>)</em>
</p>
<br/> <p>
<%=t(:label_oauth_note)%> <label><%= t(:label_invoice_count) %></label>
<br/> <%= Invoice.count %>
<br/> <em style="color: #777; font-size: 0.9em; margin-left: 8px;">(@ <%= Invoice.last_sync %>)</em>
</p>
<!-- this will display a button that the user clicks to start the flow --> <p>
<ipp:connectToIntuit></ipp:connectToIntuit> <label><%= t(:label_estimate_count) %></label>
<%= Estimate.count %>
<em style="color: #777; font-size: 0.9em; margin-left: 8px;">(@ <%= Estimate.last_sync %>)</em>
</p>
<br/> <p>
<br/> <label><%= t(:label_last_sync) %> (QBO)</label>
<%= Qbo.exists? ? Qbo.last_sync : 'Never synced' %>
<div> </p>
<b><%=t(:label_customer_count)%>:</b> <%= Customer.count%> @ <%= Customer.last_sync %>
</div>
<div>
<b><%=t(:label_employee_count)%>:</b> <%= Employee.count %> @ <%= Employee.last_sync %>
</div>
<div>
<b><%=t(:label_invoice_count)%>:</b> <%= Invoice.count %> @ <%= Invoice.last_sync%>
</div>
<div>
<b><%=t(:label_estimate_count)%>:</b> <%= Estimate.count %> @ <%= Estimate.last_sync %>
</div>
<br/>
<div>
<b><%=t(:label_last_sync)%> </b> <%= Qbo.last_sync if Qbo.exists? %> <%= link_to t(:label_sync_now), qbo_sync_path %>
</div> </div>
<fieldset class="box">
<legend>Management & Synchronization</legend>
<div style="margin-bottom: 20px;">
<ipp:connectToIntuit></ipp:connectToIntuit>
</div>
<div style="margin-bottom: 15px;">
<%= link_to t(:label_sync_now_customers), sync_customers_path, class: 'button icon icon-reload' %>
<%= link_to t(:label_sync_now_employees), employees_sync_path, class: 'button icon icon-reload' %>
<%= link_to t(:label_sync_now_invoices), invoices_sync_path, class: 'button icon icon-reload' %>
<%= link_to t(:label_sync_now_estimate), estimates_sync_path, class: 'button icon icon-reload' %>
</div>
</fieldset>
<%# Billing: estimates, issues from estimates, invoices, the product/service list and accounts %>
<h3><%= l(:label_billing_settings) %></h3>
<%= render partial: 'qbo/billing_settings', locals: { settings: settings } %>
+3
View File
@@ -1,6 +1,9 @@
<% if User.current.logged? %> <% if User.current.logged? %>
<% if User.current.allowed_to?(:view_customers, nil, global: true) %>
<%= render partial: 'customers/sidebar' %> <%= render partial: 'customers/sidebar' %>
<% end %>
<%= render partial: 'estimates/sidebar' %> <%= render partial: 'estimates/sidebar' %>
<% end %> <% end %>
@@ -0,0 +1,2 @@
<%= link_to sprite_icon('document', l(:label_create_estimate)), new_qbo_estimate_path(customer_id: customer.id),
class: 'icon icon-document' %>
@@ -0,0 +1,8 @@
<%# Estimates linked to an issue are read-only here, so they get a View link instead of Edit %>
<% if estimate.issues.exists? %>
<%= link_to sprite_icon('zoom-in', l(:button_view_estimate)), edit_qbo_estimate_path(estimate.id),
class: 'icon-only icon-zoom-in qbo-estimate-edit-link', title: l(:button_view_estimate) %>
<% else %>
<%= link_to sprite_icon('edit', l(:button_edit)), edit_qbo_estimate_path(estimate.id),
class: 'icon-only icon-edit qbo-estimate-edit-link', title: l(:button_edit_estimate) %>
<% end %>
+304
View File
@@ -0,0 +1,304 @@
<%
company = RedmineQboBilling::Company
sales_field = company.sales_person_field
vin_field = company.vin_field
mileage_field = company.mileage_field
customer = Customer.find_by(id: form.customer_id) if form.customer_id.present?
vehicles = customer.respond_to?(:vehicles) ? customer.vehicles.select { |v| v.vin.present? } : []
# When QuickBooks' settings couldn't be read at all, the page header says so instead of each field
settings_read = company.settings.present?
# The same editor writes estimates and invoices
invoice = form.invoice?
sender = invoice ? RedmineQboBilling.invoice_sender? : RedmineQboBilling.sender?
cancel_path = customer ? customer_path(customer) : home_path
form_url =
if invoice
form.persisted? ? qbo_invoice_path(form.id) : qbo_invoices_path
else
form.persisted? ? qbo_estimate_path(form.id) : qbo_estimates_path
end
%>
<%= form_tag(form_url,
method: form.persisted? ? :patch : :post,
id: 'qbo-estimate-form',
class: "qbo-estimate qbo-document-#{form.document}",
data: {
document: form.document,
import_url: (import_options_qbo_invoices_path if invoice),
replaceable_item_ids: (RedmineQboBilling::InvoiceWriter.replaceable_item_ids if invoice),
items_url: items_qbo_estimates_path,
customer_info_url: customer_info_qbo_estimates_path,
saved_subtotal: (form.persisted? ? form.subtotal.to_s('F') : ''),
saved_tax: form.total_tax.to_s,
discount: form.discount.to_s,
# New estimates: moving the estimate date moves the default expiration date with it
expiration_days: (form.persisted? || invoice ? 0 : RedmineQboBilling::EstimateWriter.expiration_days),
warn_unsaved: User.current.pref.warn_on_leaving_unsaved != '0'
}) do %>
<%= hidden_field_tag 'estimate[sync_token]', form.sync_token, id: nil %>
<%= hidden_field_tag 'estimate[total_tax]', form.total_tax, id: nil %>
<%= hidden_field_tag 'estimate[discount]', form.discount, id: nil %>
<%= hidden_field_tag 'estimate[email_status]', form.email_status, id: nil %>
<%= hidden_field_tag 'estimate[txn_status]', form.txn_status, id: nil %>
<%# Shown again if the page is redisplayed; the saved value is worked out when saving %>
<%= hidden_field_tag 'estimate[sales_person]', form.sales_person, id: nil if form.persisted? || form.invoice? %>
<% if invoice %>
<%= hidden_field_tag 'estimate[balance]', form.balance, id: nil %>
<%# Estimates whose lines are on this invoice; the Import panel adds more %>
<span id="qbo-linked-estimates">
<% form.linked_estimate_ids.each do |estimate_id| %>
<%= hidden_field_tag 'estimate[linked_estimate_ids][]', estimate_id, id: nil %>
<% end %>
</span>
<% end %>
<fieldset class="qbo-estimate-sheet"<%= ' disabled'.html_safe if form.locked %>>
<%# Customer, email and the big amount, like the top of QuickBooks' estimate screen %>
<div class="qbo-estimate-top">
<div class="qbo-estimate-row">
<div class="qbo-field qbo-field-customer">
<label for="qbo_estimate_customer_name"><%= l(:label_customer) %></label>
<%= text_field_tag 'estimate[customer_name]', form.customer_name,
id: 'qbo_estimate_customer_name', class: 'customer-name', autocomplete: 'off',
placeholder: l(:label_choose_a_customer), data: { autocomplete_url: '/customers/autocomplete' } %>
<%= hidden_field_tag 'estimate[customer_id]', form.customer_id, id: 'customer_id' %>
</div>
<div class="qbo-field qbo-field-email">
<label for="qbo_estimate_email"><%= l(:label_customer_email) %></label>
<%= text_field_tag 'estimate[email]', form.email, id: 'qbo_estimate_email', autocomplete: 'off',
placeholder: l(:text_separate_emails_with_comma) %>
</div>
</div>
<div class="qbo-estimate-amount">
<span class="qbo-estimate-amount-label"><%= l(:label_amount) %></span>
<span class="qbo-estimate-amount-value" id="qbo-estimate-amount"><%= number_to_currency(form.total || form.subtotal) %></span>
<% if invoice && form.balance && form.total && form.balance.to_d != form.total.to_d %>
<span class="qbo-estimate-amount-label"><%= l(:label_invoice_balance, balance: number_to_currency(form.balance)) %></span>
<% end %>
</div>
</div>
<div class="qbo-estimate-row qbo-estimate-details">
<div class="qbo-field qbo-field-address">
<span class="qbo-label"><%= l(:label_billing_address) %></span>
<div class="qbo-address" id="qbo-estimate-address"><%= form.billing_address.to_s %></div>
</div>
<div class="qbo-field qbo-field-date">
<label for="qbo_estimate_txn_date"><%= l(invoice ? :label_invoice_date : :label_estimate_date) %></label>
<%= date_field_tag 'estimate[txn_date]', form.txn_date, id: 'qbo_estimate_txn_date' %>
</div>
<div class="qbo-field qbo-field-date">
<% if invoice %>
<label for="qbo_estimate_due_date"><%= l(:label_due_date) %></label>
<%# Left empty, QuickBooks works it out from the customer's terms %>
<%= date_field_tag 'estimate[due_date]', form.due_date, id: 'qbo_estimate_due_date' %>
<% else %>
<label for="qbo_estimate_expiration_date"><%= l(:label_expiration_date) %></label>
<%= date_field_tag 'estimate[expiration_date]', form.expiration_date, id: 'qbo_estimate_expiration_date' %>
<% end %>
</div>
<div class="qbo-field qbo-field-number">
<label for="qbo_estimate_doc_number"><%= l(invoice ? :label_invoice_no : :label_estimate_no) %></label>
<%# Not editable: QuickBooks numbers estimates. Posted only so the page can show it again. %>
<%= hidden_field_tag 'estimate[doc_number]', form.doc_number, id: nil %>
<%= text_field_tag nil, form.doc_number.presence, id: 'qbo_estimate_doc_number', readonly: true, tabindex: -1,
placeholder: l(:text_assigned_by_quickbooks) %>
</div>
</div>
<div class="qbo-estimate-row qbo-estimate-details">
<div class="qbo-field qbo-field-sales-person">
<label for="qbo_estimate_sales_person"><%= sales_field&.name || l(:label_sales_person) %></label>
<%= text_field_tag nil, form.sales_person, id: 'qbo_estimate_sales_person', readonly: true, tabindex: -1 %>
<% if settings_read && !sales_field %>
<em class="info"><%= l(:text_no_sales_person_field) %></em>
<% end %>
</div>
<div class="qbo-field qbo-field-vin">
<label for="qbo_estimate_vin"><%= vin_field&.name || l(:label_vin) %></label>
<%= text_field_tag 'estimate[vin]', form.vin, id: 'qbo_estimate_vin', list: 'qbo-estimate-vins', maxlength: 31,
autocomplete: 'off', spellcheck: false, disabled: vin_field.nil? %>
<datalist id="qbo-estimate-vins">
<% vehicles.each do |vehicle| %>
<option value="<%= vehicle.vin %>"><%= vehicle.to_s %></option>
<% end %>
</datalist>
<% if settings_read && !vin_field %>
<em class="info"><%= l(:text_no_vin_field) %></em>
<% end %>
</div>
<%# Mileage only shows when QuickBooks has a text field named like "Mileage" %>
<% if mileage_field %>
<div class="qbo-field qbo-field-mileage">
<label for="qbo_estimate_mileage"><%= mileage_field.name %></label>
<%= text_field_tag 'estimate[mileage]', form.mileage, id: 'qbo_estimate_mileage', maxlength: 31,
inputmode: 'numeric', autocomplete: 'off' %>
</div>
<% end %>
<% if settings_read && (sales_field.nil? || vin_field.nil?) && User.current.admin? %>
<div class="qbo-field qbo-field-refresh">
<%= link_to sprite_icon('reload', l(:button_refresh_quickbooks_fields)), refresh_company_qbo_estimates_path,
method: :post, class: 'icon icon-reload' %>
<em class="info">
<%= l(:text_quickbooks_custom_fields_found,
fields: company.custom_fields.map { |f| "#{f.name} (##{f.id})" }.join(', ').presence || l(:label_none)) %>
</em>
</div>
<% end %>
</div>
<%# Product/service lines %>
<div class="qbo-estimate-lines-wrap">
<table class="qbo-estimate-lines" id="qbo-estimate-lines">
<thead>
<tr>
<th class="qbo-line-handle"></th>
<th class="qbo-line-number">#</th>
<th class="qbo-line-item"><%= l(:label_product_service) %></th>
<th class="qbo-line-description"><%= l(:field_description) %></th>
<th class="qbo-line-qty"><%= l(:label_qty) %></th>
<th class="qbo-line-rate"><%= l(:label_rate) %></th>
<th class="qbo-line-amount"><%= l(:label_amount) %></th>
<th class="qbo-line-tax"><%= l(:label_tax) %></th>
<th class="qbo-line-remove"></th>
</tr>
</thead>
<tbody>
<% form.lines.each_with_index do |line, index| %>
<%= render partial: (line.subtotal? ? 'qbo_estimates/subtotal_line' : 'qbo_estimates/line'),
locals: { line: line, key: index, number: index + 1 } %>
<% end %>
</tbody>
</table>
</div>
<template id="qbo-estimate-line-template">
<%= render partial: 'qbo_estimates/line', locals: { line: RedmineQboBilling::EstimateForm::Line.new(taxable: true), key: '__KEY__', number: '' } %>
</template>
<template id="qbo-estimate-subtotal-template">
<%= render partial: 'qbo_estimates/subtotal_line', locals: { line: RedmineQboBilling::EstimateForm::Line.new, key: '__KEY__', number: '' } %>
</template>
<p class="qbo-estimate-line-buttons">
<button type="button" class="qbo-button" id="qbo-estimate-add-lines"><%= l(:button_add_lines) %></button>
<button type="button" class="qbo-button" id="qbo-estimate-add-subtotal"><%= l(:button_add_subtotal) %></button>
<button type="button" class="qbo-button" id="qbo-estimate-clear-lines"
data-confirm-text="<%= l(:text_clear_all_lines_confirmation) %>"><%= l(:button_clear_all_lines) %></button>
<% if invoice %>
<button type="button" class="qbo-button" id="qbo-import-open"><%= l(:button_import_time_estimates) %></button>
<button type="button" class="qbo-button" id="qbo-import-undo" hidden><%= l(:button_undo_import) %></button>
<% end %>
</p>
<% if invoice %>
<%# Import: billable QuickBooks time (replacing the lines ticked) and open estimates. Filled by the script. %>
<div class="qbo-import-panel" id="qbo-import-panel" hidden
data-loading-text="<%= l(:label_loading) %>" data-none-text="<%= l(:label_none) %>"
data-need-customer-text="<%= l(:error_estimate_needs_customer) %>"
data-many-vehicles-text="<%= l(:text_invoice_many_vehicles) %>">
<div class="qbo-import-columns">
<section class="qbo-import-time">
<h4><%= l(:label_billable_time) %></h4>
<table class="qbo-import-table" id="qbo-import-time">
<thead>
<tr>
<th><input type="checkbox" class="qbo-import-all" data-target="qbo-import-time" aria-label="<%= l(:button_check_all) %>"></th>
<th><%= l(:label_date) %></th>
<th><%= l(:label_product_service) %></th>
<th><%= l(:field_description) %></th>
<th class="qbo-num"><%= l(:label_hours) %></th>
<th class="qbo-num"><%= l(:label_amount) %></th>
</tr>
</thead>
<tbody></tbody>
</table>
</section>
<section class="qbo-import-replace">
<h4><%= l(:label_replace_lines) %></h4>
<p><em class="info"><%= l(:text_replace_lines) %></em></p>
<ul id="qbo-import-replace"></ul>
</section>
</div>
<section class="qbo-import-estimates">
<h4><%= l(:label_open_estimates) %></h4>
<table class="qbo-import-table" id="qbo-import-estimates">
<thead>
<tr>
<th><input type="checkbox" class="qbo-import-all" data-target="qbo-import-estimates" aria-label="<%= l(:button_check_all) %>"></th>
<th><%= l(:label_estimate) %></th>
<th><%= l(:label_date) %></th>
<th><%= l(:field_description) %></th>
<th class="qbo-num"><%= l(:label_estimate_total) %></th>
</tr>
</thead>
<tbody></tbody>
</table>
</section>
<p class="qbo-import-buttons">
<button type="button" class="qbo-button qbo-button-primary" id="qbo-import-add"><%= l(:button_add_to_invoice) %></button>
<button type="button" class="qbo-button" id="qbo-import-close"><%= l(:button_cancel) %></button>
<span class="qbo-import-status" id="qbo-import-status"></span>
</p>
</div>
<% end %>
<div class="qbo-estimate-bottom">
<div class="qbo-estimate-notes">
<div class="qbo-field">
<label for="qbo_estimate_customer_memo"><%= l(invoice ? :label_message_on_invoice : :label_message_on_estimate) %></label>
<%= text_area_tag 'estimate[customer_memo]', form.customer_memo, id: 'qbo_estimate_customer_memo', rows: 4, maxlength: 1000 %>
</div>
<div class="qbo-field">
<label for="qbo_estimate_private_note"><%= l(:label_memo) %></label>
<%= text_area_tag 'estimate[private_note]', form.private_note, id: 'qbo_estimate_private_note', rows: 4, maxlength: 4000,
placeholder: l(:text_memo_is_private) %>
</div>
</div>
<table class="qbo-estimate-totals">
<tr>
<th><%= l(:label_subtotal) %></th>
<td id="qbo-estimate-subtotal"><%= number_to_currency(form.subtotal) %></td>
</tr>
<tr>
<th><%= l(:label_taxable_subtotal) %></th>
<td id="qbo-estimate-taxable-subtotal"></td>
</tr>
<% if form.discount.to_f != 0 %>
<tr>
<th><%= l(:label_discount_from_quickbooks) %></th>
<td>-<%= number_to_currency(form.discount) %></td>
</tr>
<% end %>
<tr>
<th><%= l(:label_sales_tax) %></th>
<td id="qbo-estimate-tax"
data-pending-text="<%= l(:text_tax_calculated_by_quickbooks) %>"><%= form.total_tax ? number_to_currency(form.total_tax) : l(:text_tax_calculated_by_quickbooks) %></td>
</tr>
<tr class="qbo-estimate-total">
<th><%= l(:label_estimate_total) %></th>
<td id="qbo-estimate-total"><%= number_to_currency(form.total || form.subtotal) %></td>
</tr>
</table>
</div>
</fieldset>
<%# Action bar, like the bar along the bottom of QuickBooks' estimate screen %>
<div class="qbo-estimate-actions">
<%= link_to l(:button_cancel), cancel_path, class: 'qbo-button qbo-button-dark', id: 'qbo-estimate-cancel' %>
<% unless form.locked %>
<span class="qbo-estimate-actions-save">
<%= submit_tag l(:button_save), name: 'save', class: 'qbo-button qbo-button-dark' %>
<% if sender %>
<%= submit_tag l(:button_save_and_send), name: 'save_and_send', class: 'qbo-button qbo-button-primary',
id: 'qbo-estimate-save-and-send', data: { needs_email_text: l(:text_estimate_send_needs_email) } %>
<% end %>
</span>
<% end %>
</div>
<% end %>
<%= render partial: 'qbo_estimates/styles' %>
<%= render partial: 'qbo_estimates/script' %>
+80
View File
@@ -0,0 +1,80 @@
<%# Title with the customer breadcrumb, errors, and warnings shared by the estimate and invoice pages %>
<%
customer = Customer.find_by(id: form.customer_id) if form.customer_id.present?
invoice = form.invoice?
%>
<h2>
<%= link_to l(:label_customers), customers_path %>
&#187;
<% if customer %>
<%= link_to customer.name, customer_path(customer) %>
&#187;
<% end %>
<% if form.persisted? %>
<%= l(invoice ? :label_invoice : :label_estimate) %> #<%= form.doc_number %>
<% if form.sent? %>
<span class="qbo-estimate-status qbo-estimate-status-sent"><%= l(:label_estimate_sent) %></span>
<% end %>
<% if invoice && form.locked == :paid %>
<% fully_paid = form.balance.to_d.zero? %>
<span class="qbo-estimate-status qbo-estimate-status-<%= fully_paid ? 'closed' : 'accepted' %>"><%= l(fully_paid ? :label_invoice_paid : :label_invoice_partially_paid) %></span>
<% elsif !invoice && form.txn_status.present? && form.txn_status != 'Pending' %>
<span class="qbo-estimate-status qbo-estimate-status-<%= form.txn_status.downcase %>"><%= form.txn_status %></span>
<% end %>
<% else %>
<%= l(invoice ? :label_new_invoice : :label_new_estimate) %>
<% end %>
</h2>
<%= error_messages_for form %>
<% if @conflict %>
<p class="warning">
<%= l(:text_estimate_reload) %>
<%= link_to l(:button_reload_estimate), invoice ? edit_qbo_invoice_path(form.id) : edit_qbo_estimate_path(form.id) %>
</p>
<% end %>
<% if !invoice && Array(form.invoiced_on).any? %>
<div class="warning qbo-estimate-notice">
<%= l(:text_estimate_billed_on) %>
<ul>
<% form.invoiced_on.each do |invoice_id, number| %>
<li><%= link_to "#{l(:label_invoice)} ##{number}", RedmineQboBilling.invoice_writer? ? edit_qbo_invoice_path(invoice_id) : invoice_path(invoice_id) %></li>
<% end %>
</ul>
</div>
<% end %>
<% if form.duplicated_from.present? %>
<div class="flash notice"><%= l(:text_estimate_duplicated_from, number: form.duplicated_from) %></div>
<% end %>
<% if form.converted_from.present? %>
<div class="flash notice"><%= l(:text_invoice_from_estimate, number: form.converted_from) %></div>
<% end %>
<% if form.locked == :linked %>
<div class="warning qbo-estimate-notice">
<%= l(:error_estimate_linked_to_issues) %>
<ul>
<% Array(@linked_issues).each do |issue| %>
<li><%= link_to_issue(issue, truncate: 60) %></li>
<% end %>
</ul>
</div>
<% elsif form.locked == :paid %>
<p class="warning"><%= l(:error_invoice_paid) %></p>
<% elsif form.locked == :bundles %>
<p class="warning"><%= l(invoice ? :error_invoice_has_bundles : :error_estimate_has_bundles) %></p>
<% elsif !invoice && %w[Converted Closed].include?(form.txn_status.to_s) && Array(form.invoiced_on).empty? %>
<p class="warning"><%= l(:text_estimate_closed) %></p>
<% end %>
<% if RedmineQboBilling::Company.settings.empty? %>
<p class="warning">
<%= l(:text_quickbooks_settings_unavailable) %>
<% if User.current.admin? %>
<%= link_to l(:button_refresh_quickbooks_fields), refresh_company_qbo_estimates_path, method: :post %>
<% end %>
</p>
<% end %>
+38
View File
@@ -0,0 +1,38 @@
<%# One row of the line table. key is the row's params key; rows are posted in table order. %>
<% name = "estimate[lines][#{key}]" %>
<tr class="qbo-line<%= ' qbo-line-unmatched' if line.unmatched_item? %><%= ' qbo-line-time' if line.time_activity_id.present? %>">
<td class="qbo-line-handle" title="<%= l(:label_drag_to_reorder) %>"><%= sprite_icon('reorder') %></td>
<td class="qbo-line-number"><%= number %></td>
<td class="qbo-line-item" data-label="<%= l(:label_product_service) %>">
<%= hidden_field_tag "#{name}[id]", line.id, id: nil %>
<%= hidden_field_tag "#{name}[item_id]", line.item_id, id: nil, class: 'qbo-line-item-id' %>
<%# Invoices: the QuickBooks time activity this line bills %>
<%= hidden_field_tag "#{name}[time_activity_id]", line.time_activity_id, id: nil, class: 'qbo-line-time-id' %>
<%= text_field_tag "#{name}[item_name]", line.item_name, id: nil, class: 'qbo-line-item-name',
autocomplete: 'off', aria: { label: l(:label_product_service) } %>
</td>
<td class="qbo-line-description" data-label="<%= l(:field_description) %>">
<span class="qbo-line-time-badge" title="<%= l(:text_line_bills_time) %>"><%= l(:label_time_badge) %></span>
<%= text_area_tag "#{name}[description]", line.description, id: nil, rows: 1, class: 'qbo-line-description-input',
aria: { label: l(:field_description) } %>
</td>
<td class="qbo-line-qty" data-label="<%= l(:label_qty) %>">
<%= text_field_tag "#{name}[quantity]", line.quantity, id: nil, class: 'qbo-line-qty-input', inputmode: 'decimal',
autocomplete: 'off', aria: { label: l(:label_qty) } %>
</td>
<td class="qbo-line-rate" data-label="<%= l(:label_rate) %>">
<%= text_field_tag "#{name}[rate]", line.rate, id: nil, class: 'qbo-line-rate-input', inputmode: 'decimal',
autocomplete: 'off', aria: { label: l(:label_rate) } %>
</td>
<td class="qbo-line-amount" data-label="<%= l(:label_amount) %>">
<%# Typing an amount works out the rate, like QuickBooks; only qty and rate are posted %>
<input type="text" class="qbo-line-amount-input" inputmode="decimal" autocomplete="off" aria-label="<%= l(:label_amount) %>">
</td>
<td class="qbo-line-tax" data-label="<%= l(:label_tax) %>">
<%= hidden_field_tag "#{name}[taxable]", '0', id: nil %>
<%= check_box_tag "#{name}[taxable]", '1', line.taxable?, id: nil, class: 'qbo-line-taxable', aria: { label: l(:label_tax) } %>
</td>
<td class="qbo-line-remove">
<button type="button" class="qbo-line-remove-button" title="<%= l(:button_delete) %>"><%= sprite_icon('del') %></button>
</td>
</tr>
+593
View File
@@ -0,0 +1,593 @@
<%# Inline so the page never depends on precompiled plugin assets %>
<%= javascript_tag do %>
$(function () {
var $form = $('#qbo-estimate-form');
if (!$form.length) return;
var $tbody = $('#qbo-estimate-lines tbody');
var template = document.getElementById('qbo-estimate-line-template').innerHTML;
var subtotalTemplate = document.getElementById('qbo-estimate-subtotal-template').innerHTML;
var money = new Intl.NumberFormat(<%= raw (current_language.to_s.presence || 'en').to_json %>, { style: 'currency', currency: 'USD' });
var savedSubtotal = $form.data('savedSubtotal') === '' ? null : parseFloat($form.data('savedSubtotal'));
var savedTax = $form.data('savedTax') === '' ? null : parseFloat($form.data('savedTax'));
// Discounts are kept from QuickBooks as they are; QuickBooks works out a percent discount again on save
var discount = $form.data('discount') === '' ? 0 : parseFloat($form.data('discount'));
var locked = $form.find('.qbo-estimate-sheet').prop('disabled');
// Row keys must be digits: Rails' strong parameters only keep a hash of rows when every key is a number
var nextKey = Date.now();
var dirty = false;
// ---- numbers ----
function parseNumber(value) {
var text = String(value == null ? '' : value).replace(/[$,\s]/g, '');
if (text === '') return null;
var n = Number(text);
return isFinite(n) ? n : NaN;
}
function round(n, places) { var f = Math.pow(10, places); return Math.round(n * f) / f; }
function plain(n, places) { return String(round(n, places)); }
// ---- rows ----
function rows() { return $tbody.children('tr.qbo-line'); }
function isSubtotal($row) { return $row.hasClass('qbo-line-subtotal'); }
function rowIsBlank($row) {
if (isSubtotal($row)) return false;
return !$row.find('.qbo-line-item-id').val() && !$row.find('.qbo-line-item-name').val().trim() &&
!$row.find('.qbo-line-description-input').val().trim() && !$row.find('.qbo-line-rate-input').val().trim();
}
function addRow() {
var $row = $(template.replace(/__KEY__/g, String(nextKey++)));
$tbody.append($row);
setupRow($row);
renumber();
return $row;
}
// QuickBooks keeps a spare empty line at the bottom; filling it adds another
function ensureSpareRow() {
var $last = rows().last();
if (!$last.length || !rowIsBlank($last)) addRow();
}
function renumber() {
rows().each(function (i) { $(this).find('.qbo-line-number').text(i + 1); });
}
function autoGrow(textarea) {
textarea.style.height = 'auto';
textarea.style.height = (textarea.scrollHeight + 2) + 'px';
}
// Works out the line amount from qty x rate (qty defaults to 1, like QuickBooks)
function lineAmount($row) {
var rate = parseNumber($row.find('.qbo-line-rate-input').val());
if (rate === null || isNaN(rate)) return null;
var qty = parseNumber($row.find('.qbo-line-qty-input').val());
if (qty === null) qty = 1;
if (isNaN(qty)) return null;
return round(qty * rate, 2);
}
function recalc() {
var subtotal = 0, taxable = 0, section = 0;
rows().each(function () {
var $row = $(this);
// A subtotal row totals the lines since the previous subtotal
if (isSubtotal($row)) {
$row.find('.qbo-line-subtotal-amount').text(money.format(round(section, 2)));
section = 0;
return;
}
var amount = lineAmount($row);
var $amount = $row.find('.qbo-line-amount-input');
if (!$amount.is(':focus')) $amount.val(amount === null ? '' : amount.toFixed(2));
if (amount !== null) {
subtotal += amount;
section += amount;
if ($row.find('.qbo-line-taxable').is(':checked')) taxable += amount;
}
});
subtotal = round(subtotal, 2);
// QuickBooks works out the sales tax when the estimate is saved; show the saved tax until the lines change
var $tax = $('#qbo-estimate-tax');
var total = round(subtotal - discount, 2);
if (savedTax !== null && savedSubtotal !== null && Math.abs(subtotal - savedSubtotal) < 0.005) {
$tax.text(money.format(savedTax)).removeClass('qbo-pending');
total = round(total + savedTax, 2);
} else {
$tax.text($tax.data('pendingText')).addClass('qbo-pending');
}
$('#qbo-estimate-subtotal').text(money.format(subtotal));
$('#qbo-estimate-taxable-subtotal').text(money.format(round(taxable, 2)));
$('#qbo-estimate-total').text(money.format(total));
$('#qbo-estimate-amount').text(money.format(total));
}
// ---- product/service search ----
function setupItemSearch($input) {
$input.autocomplete({
appendTo: 'body',
minLength: 0,
delay: 150,
source: function (request, response) {
$.getJSON($form.data('itemsUrl'), { q: request.term })
.done(function (items) {
response(items.map(function (item) {
return { label: item.name, value: item.name, item: item };
}));
})
.fail(function () { response([]); });
},
select: function (event, ui) {
var $row = $input.closest('tr');
var item = ui.item.item;
var $description = $row.find('.qbo-line-description-input');
var previous = $row.data('itemDescription');
$input.val(item.name);
$row.find('.qbo-line-item-id').val(item.id);
$row.removeClass('qbo-line-unmatched');
// Keep a description the user typed; replace one that came from the previous product
if (!$description.val().trim() || $description.val() === previous) {
$description.val(item.description || '');
autoGrow($description[0]);
}
$row.data('itemDescription', item.description || '');
if (item.price !== null && item.price !== undefined && item.price !== '') {
$row.find('.qbo-line-rate-input').val(plain(parseFloat(item.price), 5));
tidyNumbers($row);
}
if (!$row.find('.qbo-line-qty-input').val().trim()) $row.find('.qbo-line-qty-input').val('1');
$row.find('.qbo-line-taxable').prop('checked', item.taxable !== false);
changed();
return false;
}
});
$input.autocomplete('instance')._renderItem = function (ul, entry) {
var item = entry.item;
var $div = $('<div>');
if (item.price !== null && item.price !== undefined && item.price !== '') {
$('<span class="qbo-item-option-price">').text(money.format(parseFloat(item.price))).appendTo($div);
}
$('<strong>').text(item.name).appendTo($div);
var meta = [item.sku, item.description].filter(function (s) { return s; }).join(' · ');
if (meta) $('<div class="qbo-item-option-meta">').text(meta.length > 90 ? meta.slice(0, 90) + '…' : meta).appendTo($div);
return $('<li>').append($div).appendTo(ul);
};
// Like QuickBooks, the list opens when the box is clicked
$input.on('focus', function () {
if (!$input.val()) $input.autocomplete('search', '');
});
// Typing a different name unlinks the product until one is picked from the list
$input.on('input', function () {
var $row = $input.closest('tr');
$row.find('.qbo-line-item-id').val('');
$row.toggleClass('qbo-line-unmatched', $input.val().trim() !== '');
});
}
function setupRow($row) {
if (isSubtotal($row) || $row.data('qboSetup')) return;
$row.data('qboSetup', true);
setupItemSearch($row.find('.qbo-line-item-name'));
$row.find('.qbo-line-description-input').each(function () { autoGrow(this); });
$row.data('itemDescription', $row.find('.qbo-line-item-id').val() ? $row.find('.qbo-line-description-input').val() : null);
}
function changed() {
dirty = true;
recalc();
ensureSpareRow();
}
// ---- line events ----
$tbody.on('input', '.qbo-line-qty-input, .qbo-line-rate-input, .qbo-line-description-input, .qbo-line-item-name', changed);
$tbody.on('change', '.qbo-line-taxable', changed);
$tbody.on('input', '.qbo-line-description-input', function () { autoGrow(this); });
// Typing an amount works out the rate from the quantity
$tbody.on('input', '.qbo-line-amount-input', function () {
var $row = $(this).closest('tr');
var amount = parseNumber($(this).val());
if (amount === null || isNaN(amount)) return;
var qty = parseNumber($row.find('.qbo-line-qty-input').val());
if (qty === null || isNaN(qty) || qty === 0) qty = 1;
$row.find('.qbo-line-rate-input').val(plain(amount / qty, 5));
changed();
});
// Rates show cents (1120 -> 1120.00) unless they need more places; quantities stay plain
function tidyNumbers($row) {
$row.find('.qbo-line-qty-input, .qbo-line-rate-input').each(function () {
var n = parseNumber(this.value);
if (n === null || isNaN(n)) return;
var isRate = $(this).hasClass('qbo-line-rate-input');
this.value = isRate && round(n, 2) === round(n, 5) ? n.toFixed(2) : plain(n, 5);
});
}
$tbody.on('blur', '.qbo-line-rate-input, .qbo-line-qty-input, .qbo-line-amount-input', function () {
tidyNumbers($(this).closest('tr'));
recalc();
});
$tbody.on('click', '.qbo-line-remove-button', function () {
var $row = $(this).closest('tr');
if (rows().length > 1) {
$row.remove();
} else {
$row.find('input[type=text], textarea, .qbo-line-item-id').val('');
$row.removeClass('qbo-line-unmatched');
}
renumber();
changed();
});
$('#qbo-estimate-add-lines').on('click', function () {
for (var i = 0; i < 4; i++) addRow();
dirty = true;
});
// A subtotal goes after the last filled line, above the spare empty rows
$('#qbo-estimate-add-subtotal').on('click', function () {
var $subtotal = $(subtotalTemplate.replace(/__KEY__/g, String(nextKey++)));
var $filled = rows().filter(function () { return !rowIsBlank($(this)); });
if ($filled.length) { $filled.last().after($subtotal); } else { $tbody.prepend($subtotal); }
renumber();
changed();
});
$('#qbo-estimate-clear-lines').on('click', function () {
if (!window.confirm($(this).data('confirmText'))) return;
rows().remove();
addRow(); addRow();
changed();
});
// Drag lines by the handle to reorder them; they're saved in table order
$tbody.sortable({
handle: '.qbo-line-handle',
axis: 'y',
items: '> tr.qbo-line',
placeholder: 'qbo-line-placeholder',
helper: function (event, tr) {
var $originals = tr.children();
var $helper = tr.clone();
$helper.children().each(function (i) { $(this).width($originals.eq(i).outerWidth()); });
return $helper;
},
start: function (event, ui) { ui.placeholder.html('<td colspan="9"></td>'); },
// Moving a line or a subtotal changes what each subtotal covers
update: function () { renumber(); changed(); }
});
// ---- customer ----
var $email = $('#qbo_estimate_email');
var $vin = $('#qbo_estimate_vin');
var loadedEmail = $email.val();
$('#customer_id').on('change', function () {
var id = $(this).val();
if (!id) return;
dirty = true;
$.getJSON($form.data('customerInfoUrl'), { customer_id: id }).done(function (info) {
// Replace the email only if it was the previous customer's (or empty)
if (!$email.val().trim() || $email.val() === loadedEmail) $email.val(info.email || '');
loadedEmail = info.email || '';
$('#qbo-estimate-address').text(info.billing_address || '');
var $list = $('#qbo-estimate-vins').empty();
(info.vehicles || []).forEach(function (vehicle) {
$('<option>').attr('value', vehicle.vin).text(vehicle.name).appendTo($list);
});
if ($vin.length && !$vin.prop('disabled') && !$vin.val().trim() && (info.vehicles || []).length === 1) {
$vin.val(info.vehicles[0].vin);
}
});
});
// Clearing the customer name clears the customer
$('#qbo_estimate_customer_name').on('input', function () {
if (!this.value.trim()) $('#customer_id').val('');
});
$vin.on('blur', function () { this.value = this.value.trim().toUpperCase(); });
// New estimates expire a set number of days after the estimate date (plugin setting)
var expirationDays = parseInt($form.data('expirationDays'), 10) || 0;
var $txnDate = $('#qbo_estimate_txn_date');
var $expiration = $('#qbo_estimate_expiration_date');
function addDays(iso, days) {
var parts = iso.split('-').map(Number);
var date = new Date(Date.UTC(parts[0], parts[1] - 1, parts[2] + days));
return date.toISOString().slice(0, 10);
}
if (expirationDays > 0) {
var lastDefault = $txnDate.val() ? addDays($txnDate.val(), expirationDays) : '';
$txnDate.on('change', function () {
if (!this.value) return;
// Only move a date that's still the default (or empty), not one picked by hand
if (!$expiration.val() || $expiration.val() === lastDefault) {
lastDefault = addDays(this.value, expirationDays);
$expiration.val(lastDefault);
}
});
}
// ---- invoices: import billable time and open estimates ----
var $panel = $('#qbo-import-panel');
if ($panel.length) {
var importData = null;
var undoState = null;
var $status = $('#qbo-import-status');
var setStatus = function (text) { $status.text(text || ''); };
var linkedEstimateIds = function () {
return $('#qbo-linked-estimates input').map(function () { return this.value; }).get();
};
var timeIdsInForm = function () {
return $tbody.find('.qbo-line-time-id').map(function () { return this.value; }).get().filter(Boolean);
};
// A new row (not yet in the table) filled with an imported line
var makeRow = function (line) {
if (line.kind === 'subtotal') return $(subtotalTemplate.replace(/__KEY__/g, String(nextKey++)));
var $row = $(template.replace(/__KEY__/g, String(nextKey++)));
$row.find('.qbo-line-item-id').val(line.item_id || '');
$row.find('.qbo-line-item-name').val(line.item_name || '');
$row.find('.qbo-line-description-input').val(line.description || '');
$row.find('.qbo-line-qty-input').val(line.quantity || '');
$row.find('.qbo-line-rate-input').val(line.rate || '');
$row.find('.qbo-line-taxable').prop('checked', !!line.taxable);
if (line.time_activity_id) {
$row.find('.qbo-line-time-id').val(line.time_activity_id);
$row.addClass('qbo-line-time');
}
return $row;
};
// The issue a line came from: "Install #116: some job" on time, "Added from: Install #116: ..." on estimates
var issueOf = function (text) {
var match = /#(\d+):/.exec((text || '').split('\n')[0]);
return match ? match[1] : null;
};
// The last time line on the invoice for the issue
var timeRowForIssue = function (issueId) {
return rows().filter(function () {
var $row = $(this);
return $row.hasClass('qbo-line-time') && issueOf($row.find('.qbo-line-description-input').val()) === issueId;
}).last();
};
// Issues behind the invoice's time lines and "Added from" notes
var invoiceIssueIds = function () {
var ids = [];
rows().each(function () {
var $row = $(this);
if (isSubtotal($row)) return;
var description = $row.find('.qbo-line-description-input').val() || '';
if (!$row.hasClass('qbo-line-time') && !/^\s*Added from:/i.test(description)) return;
var id = issueOf(description);
if (id && ids.indexOf(id) < 0) ids.push(id);
});
return ids;
};
// VIN and mileage from the work orders (via plugins such as redmine_qbo_vehicles and redmine_mileage_cp):
// one vehicle fills the VIN box; the highest mileage fills the mileage box
var updateVehicleFields = function (issueIds) {
var values = (importData && importData.issue_values) || {};
var vins = [], mileage = null;
issueIds.forEach(function (id) {
var v = values[id] || {};
if (v.vin && vins.indexOf(v.vin.toUpperCase()) < 0) vins.push(v.vin.toUpperCase());
var miles = parseNumber(v.mileage);
if (miles !== null && !isNaN(miles) && (mileage === null || miles > mileage)) mileage = miles;
});
var $vinBox = $('#qbo_estimate_vin');
if (vins.length === 1 && $vinBox.length && !$vinBox.prop('disabled')) $vinBox.val(vins[0]);
var $mileageBox = $('#qbo_estimate_mileage');
if (mileage !== null && $mileageBox.length) $mileageBox.val(String(mileage));
return vins;
};
// Rows go after the last filled line, above the spare empty rows
var insertAfterFilled = function ($rows) {
var $filled = rows().filter(function () { return !rowIsBlank($(this)); });
if ($filled.length) { $filled.last().after($rows); } else { $tbody.prepend($rows); }
};
var lineLabel = function ($row) {
var item = $row.find('.qbo-line-item-name').val();
var description = ($row.find('.qbo-line-description-input').val() || '').split('\n')[0];
var amount = $row.find('.qbo-line-amount-input').val();
return '#' + $row.find('.qbo-line-number').text().trim() + ' ' + [item, description].filter(Boolean).join(' – ') +
(amount ? ' (' + money.format(parseFloat(amount)) + ')' : '');
};
// The invoice's lines, for ticking the ones the time replaces (e.g. the estimate's labor lines).
// When products/services are set as replaceable by time in the plugin settings, only lines with one of
// them are offered; with none set, every line is.
var replaceable = ($form.data('replaceableItemIds') || []).map(String);
var fillReplaceList = function () {
var $list = $('#qbo-import-replace').empty();
rows().each(function () {
var $row = $(this);
if (isSubtotal($row) || rowIsBlank($row) || $row.hasClass('qbo-line-time')) return;
if (replaceable.length && replaceable.indexOf(String($row.find('.qbo-line-item-id').val())) < 0) return;
var $box = $('<input type="checkbox">').data('row', $row);
$('<li>').append($('<label>').append($box, ' ', document.createTextNode(lineLabel($row)))).appendTo($list);
});
if (!$list.children().length) $('<li>').text($panel.data('noneText')).appendTo($list);
};
var emptyRow = function ($tbodyEl, columns) {
$('<tr>').append($('<td>').attr('colspan', columns).addClass('qbo-import-none').text($panel.data('noneText'))).appendTo($tbodyEl);
};
var renderImport = function () {
var used = timeIdsInForm();
var linked = linkedEstimateIds();
var $time = $('#qbo-import-time tbody').empty();
importData.time_activities.forEach(function (activity, index) {
if (used.indexOf(activity.id) >= 0) return;
$('<tr>').append(
$('<td>').append($('<input type="checkbox" class="qbo-import-pick">').val(index)),
$('<td>').text(activity.date),
$('<td>').text(activity.item_name || ''),
$('<td>').text([activity.employee, activity.description].filter(Boolean).join(': ')),
$('<td class="qbo-num">').text(activity.quantity),
$('<td class="qbo-num">').text(money.format(parseFloat(activity.amount)))
).appendTo($time);
});
if (!$time.children().length) emptyRow($time, 6);
var $estimates = $('#qbo-import-estimates tbody').empty();
importData.estimates.forEach(function (estimate, index) {
if (linked.indexOf(estimate.id) >= 0) return;
var first = estimate.lines.filter(function (l) { return l.description; })[0];
$('<tr>').append(
$('<td>').append($('<input type="checkbox" class="qbo-import-pick">').val(index)),
$('<td>').text('#' + estimate.doc_number),
$('<td>').text(estimate.date),
$('<td>').text(estimate.issue || (first ? first.description.split('\n')[0] : '')),
$('<td class="qbo-num">').text(money.format(parseFloat(estimate.total || 0)))
).appendTo($estimates);
});
if (!$estimates.children().length) emptyRow($estimates, 5);
};
$('#qbo-import-open').on('click', function () {
$panel.prop('hidden', false);
importData = null;
$('#qbo-import-time tbody, #qbo-import-estimates tbody').empty();
fillReplaceList();
var customerId = $('#customer_id').val();
if (!customerId) { setStatus($panel.data('needCustomerText')); return; }
setStatus($panel.data('loadingText'));
$.getJSON($form.data('importUrl'), { customer_id: customerId, issue_ids: invoiceIssueIds() })
.done(function (data) { importData = data; renderImport(); setStatus(''); })
.fail(function (xhr) { setStatus((xhr.responseJSON && xhr.responseJSON.error) || xhr.statusText); });
});
$('#qbo-import-close').on('click', function () { $panel.prop('hidden', true); });
$panel.on('change', '.qbo-import-all', function () {
$('#' + $(this).data('target') + ' .qbo-import-pick').prop('checked', this.checked);
});
$('#qbo-import-add').on('click', function () {
if (!importData) return;
var times = $('#qbo-import-time .qbo-import-pick:checked').map(function () { return importData.time_activities[this.value]; }).get();
var estimates = $('#qbo-import-estimates .qbo-import-pick:checked').map(function () { return importData.estimates[this.value]; }).get();
if (!times.length && !estimates.length) return;
// Kept so the import can be undone before saving (clones keep what was typed)
undoState = { rows: rows().clone(), linked: $('#qbo-linked-estimates').children().clone() };
// Time goes where the first ticked line was; the ticked lines are removed
if (times.length) {
var $timeRows = $(times.map(function (activity) {
return makeRow($.extend({}, activity, { time_activity_id: activity.id }))[0];
}));
var $replaced = $('#qbo-import-replace input:checked').map(function () { return $(this).data('row')[0]; });
var $anchor = rows().filter(function () { return $replaced.index(this) >= 0; }).first();
if ($anchor.length) { $anchor.before($timeRows); } else { insertAfterFilled($timeRows); }
$replaced.remove();
}
// Each estimate's lines go right after the time for the same issue (e.g. lineitems' "Added from:
// Install #116" estimate after the time for #116), and its "Added from" note is dropped since the time
// line already names the issue. Estimates with no matching time keep the note and go at the end.
// The estimate is linked and closed when the invoice is saved.
var isAddedFromNote = function (line) {
return !line.kind && !line.item_id && !line.rate && /^\s*Added from:/i.test(line.description || '');
};
var lastForIssue = {};
estimates.forEach(function (estimate) {
var issueId = estimate.issue_id ? String(estimate.issue_id) : null;
var $anchor = issueId ? (lastForIssue[issueId] || timeRowForIssue(issueId)) : $();
var placed = !!($anchor && $anchor.length);
var lines = placed ? estimate.lines.filter(function (line) { return !isAddedFromNote(line); }) : estimate.lines;
var $estimateRows = $(lines.map(function (line) { return makeRow(line)[0]; }));
if (!$estimateRows.length) {
// Nothing but the note: nothing to add
} else if (placed) {
$anchor.after($estimateRows);
lastForIssue[issueId] = $estimateRows.last();
} else {
insertAfterFilled($estimateRows);
}
$('<input type="hidden" name="estimate[linked_estimate_ids][]">').val(estimate.id).appendTo('#qbo-linked-estimates');
});
rows().each(function () { setupRow($(this)); tidyNumbers($(this)); });
renumber();
changed();
// Imported estimates' notes are dropped next to their time, so their issues are added here
var issueIds = invoiceIssueIds();
estimates.forEach(function (estimate) {
if (estimate.issue_id && issueIds.indexOf(String(estimate.issue_id)) < 0) issueIds.push(String(estimate.issue_id));
});
var vins = updateVehicleFields(issueIds);
$panel.prop('hidden', true);
if (vins.length > 1) window.alert($panel.data('manyVehiclesText') + ' ' + vins.join(', '));
$('#qbo-import-undo').prop('hidden', false);
});
$('#qbo-import-undo').on('click', function () {
if (!undoState) return;
$tbody.empty().append(undoState.rows);
$('#qbo-linked-estimates').empty().append(undoState.linked);
undoState = null;
rows().each(function () { setupRow($(this)); });
renumber();
changed();
$(this).prop('hidden', true);
});
}
// ---- saving ----
$form.on('input change', '.qbo-estimate-top input, .qbo-estimate-details input, .qbo-estimate-notes textarea', function () { dirty = true; });
// Enter in a text box shouldn't save the estimate half-written
$form.on('keydown', 'input[type=text], input[type=date]', function (event) {
if (event.key === 'Enter' && !$(this).closest('.ui-autocomplete').length) event.preventDefault();
});
$form.on('submit', function (event) {
var submitter = event.originalEvent && event.originalEvent.submitter;
if (submitter && submitter.id === 'qbo-estimate-save-and-send' && !$email.val().trim()) {
event.preventDefault();
window.alert($(submitter).data('needsEmailText'));
$email.trigger('focus');
return;
}
dirty = false;
});
window.addEventListener('beforeunload', function (event) {
if (!dirty || !$form.data('warnUnsaved')) return;
event.preventDefault();
event.returnValue = '';
});
rows().each(function () { tidyNumbers($(this)); });
// Estimates with bundles are shown read-only
if (locked) { recalc(); return; }
rows().each(function () { setupRow($(this)); });
ensureSpareRow();
recalc();
});
<% end %>
+163
View File
@@ -0,0 +1,163 @@
<%# Inline so the page never depends on precompiled plugin assets %>
<style>
.qbo-estimate { --qbo-border: #babec5; --qbo-muted: #6b6c72; --qbo-green: #2ca01c; --qbo-green-dark: #108000; --qbo-bar: #393a3d; }
.qbo-estimate-sheet { border: 1px solid #e3e5e8; border-radius: 4px; background: #fff; padding: 20px 24px 24px; margin: 0 0 0; min-width: 0; }
.qbo-estimate-sheet[disabled] { opacity: .75; }
.qbo-estimate-sheet[disabled] .qbo-estimate-line-buttons, .qbo-estimate-sheet[disabled] .qbo-line-handle svg,
.qbo-estimate-sheet[disabled] .qbo-line-remove-button { display: none; }
.qbo-estimate-top { display: flex; justify-content: space-between; align-items: flex-start; gap: 24px; }
.qbo-estimate-row { display: flex; flex-wrap: wrap; gap: 16px 20px; align-items: flex-start; margin-bottom: 16px; }
.qbo-field { display: flex; flex-direction: column; gap: 4px; }
.qbo-field label, .qbo-field .qbo-label { font-size: 0.9em; font-weight: 600; color: #393a3d; }
.qbo-field input[type=text], .qbo-field input[type=date], .qbo-field textarea {
border: 1px solid var(--qbo-border); border-radius: 4px; padding: 6px 8px; font-size: 1em; box-sizing: border-box; background: #fff;
font-family: inherit; height: auto;
}
.qbo-field input[type=text], .qbo-field input[type=date] { height: 34px; }
.qbo-field input:focus, .qbo-field textarea:focus, .qbo-estimate-lines input:focus, .qbo-estimate-lines textarea:focus {
outline: none; border-color: var(--qbo-green); box-shadow: 0 0 0 2px rgba(44,160,28,.25);
}
.qbo-field input[readonly], .qbo-field input[disabled] { background: #f4f5f8; color: #393a3d; }
.qbo-field em.info { font-size: .85em; max-width: 220px; }
.qbo-field-customer input { width: 280px; }
.qbo-field-email input { width: 300px; }
.qbo-field-date input { width: 150px; }
.qbo-field-number input { width: 160px; }
.qbo-field-sales-person input { width: 200px; }
.qbo-field-vin input { width: 220px; font-family: monospace; text-transform: uppercase; }
.qbo-field-mileage input { width: 120px; }
.qbo-field-refresh { align-self: flex-end; padding-bottom: 6px; max-width: 420px; }
.qbo-address { min-width: 220px; min-height: 4.5em; white-space: pre-line; color: #393a3d; padding: 6px 0; line-height: 1.4; }
.qbo-estimate-amount { text-align: right; flex-shrink: 0; }
.qbo-estimate-amount-label { display: block; font-size: .8em; font-weight: 600; letter-spacing: .05em; text-transform: uppercase; color: var(--qbo-muted); }
.qbo-estimate-amount-value { display: block; font-size: 2.6em; font-weight: 700; color: #393a3d; line-height: 1.1; font-variant-numeric: tabular-nums; }
.qbo-estimate-lines-wrap { overflow-x: auto; margin-top: 8px; }
.qbo-estimate-lines { width: 100%; border-collapse: collapse; min-width: 820px; }
.qbo-estimate-lines th { font-size: .78em; font-weight: 600; letter-spacing: .04em; text-transform: uppercase; color: var(--qbo-muted);
text-align: left; padding: 8px 6px; border-bottom: 2px solid #d4d7dc; white-space: nowrap; }
.qbo-estimate-lines td { padding: 6px; border-bottom: 1px solid #e3e5e8; vertical-align: top; }
.qbo-estimate-lines input[type=text], .qbo-estimate-lines textarea {
width: 100%; box-sizing: border-box; border: 1px solid transparent; border-radius: 3px; padding: 5px 6px; font-size: 1em; background: transparent; font-family: inherit;
}
.qbo-estimate-lines tr:hover input[type=text], .qbo-estimate-lines tr:hover textarea,
.qbo-estimate-lines tr:focus-within input[type=text], .qbo-estimate-lines tr:focus-within textarea { border-color: var(--qbo-border); background: #fff; }
.qbo-estimate-lines textarea { resize: none; min-height: 2.1em; line-height: 1.35; overflow: hidden; }
.qbo-estimate-lines .qbo-line-handle { width: 18px; cursor: grab; color: #8d9096; padding-top: 10px; }
.qbo-estimate-lines .qbo-line-number { width: 24px; color: var(--qbo-muted); padding-top: 11px; text-align: right; }
.qbo-estimate-lines .qbo-line-item { width: 22%; }
.qbo-estimate-lines .qbo-line-qty { width: 70px; }
.qbo-estimate-lines .qbo-line-rate, .qbo-estimate-lines .qbo-line-amount { width: 100px; }
.qbo-estimate-lines td.qbo-line-qty input, .qbo-estimate-lines td.qbo-line-rate input, .qbo-estimate-lines td.qbo-line-amount input { text-align: right; font-variant-numeric: tabular-nums; }
.qbo-estimate-lines th.qbo-line-qty, .qbo-estimate-lines th.qbo-line-rate, .qbo-estimate-lines th.qbo-line-amount { text-align: right; }
.qbo-estimate-lines .qbo-line-tax { width: 40px; text-align: center; padding-top: 11px; }
.qbo-estimate-lines .qbo-line-remove { width: 28px; padding-top: 8px; }
.qbo-line-remove-button { border: 0; background: none; cursor: pointer; color: #8d9096; padding: 2px; visibility: hidden; }
.qbo-estimate-lines tr:hover .qbo-line-remove-button, .qbo-estimate-lines tr:focus-within .qbo-line-remove-button { visibility: visible; }
.qbo-line-remove-button:hover { color: #c00; }
.qbo-line.qbo-line-unmatched .qbo-line-item-name { border-color: #d52b1e !important; background: #fff4f3 !important; }
.qbo-line-subtotal td { background: #f4f5f8; }
.qbo-estimate-lines td.qbo-line-subtotal-label { text-align: right; font-weight: 600; padding-top: 11px; color: #393a3d; }
.qbo-estimate-lines td.qbo-line-subtotal-amount { text-align: right; font-weight: 600; padding: 11px 12px 6px 6px; font-variant-numeric: tabular-nums; }
.qbo-line.ui-sortable-helper { background: #fff; box-shadow: 0 2px 8px rgba(0,0,0,.2); display: table; }
.qbo-line-placeholder td { background: #eef7ec; height: 2.4em; }
.ui-autocomplete .qbo-item-option-meta { color: var(--qbo-muted, #6b6c72); font-size: .85em; }
.ui-autocomplete .qbo-item-option-price { float: right; margin-left: 12px; font-variant-numeric: tabular-nums; }
/* Invoice lines that bill a QuickBooks time activity */
.qbo-estimate .qbo-button[hidden] { display: none; }
.qbo-line-time-badge { display: none; }
.qbo-estimate-lines td.qbo-line-description { position: relative; }
.qbo-line-time .qbo-line-time-badge { display: block; position: absolute; top: 0; right: 8px; z-index: 1; font-size: .65em; font-weight: 600;
text-transform: uppercase; letter-spacing: .04em; background: #e8eefa; color: #0d47a1; border-radius: 8px; padding: 0 6px; pointer-events: none; }
/* Invoice import panel */
.qbo-import-panel { border: 1px solid #d4d7dc; border-radius: 4px; background: #f8f9fa; padding: 12px 16px; margin: 0 0 20px; }
.qbo-import-panel[hidden] { display: none; }
.qbo-import-panel h4 { margin: 4px 0 8px; font-size: .95em; }
.qbo-import-columns { display: flex; gap: 24px; flex-wrap: wrap; }
.qbo-import-time { flex: 2 1 480px; min-width: 0; }
.qbo-import-replace { flex: 1 1 260px; }
.qbo-import-replace ul { list-style: none; margin: 0; padding: 0; max-height: 260px; overflow: auto; }
.qbo-import-replace li { padding: 3px 0; }
.qbo-import-table { width: 100%; border-collapse: collapse; background: #fff; }
.qbo-import-table th { font-size: .78em; text-transform: uppercase; color: var(--qbo-muted); text-align: left; padding: 6px; border-bottom: 1px solid #d4d7dc; }
.qbo-import-table td { padding: 6px; border-bottom: 1px solid #eceef1; vertical-align: top; }
.qbo-import-table .qbo-num { text-align: right; font-variant-numeric: tabular-nums; white-space: nowrap; }
.qbo-import-table td.qbo-import-none { color: var(--qbo-muted); font-style: italic; }
.qbo-import-estimates { margin-top: 14px; }
.qbo-import-buttons { display: flex; gap: 8px; align-items: center; margin: 14px 0 0; }
.qbo-import-status { color: var(--qbo-muted); }
.qbo-estimate-line-buttons { margin: 12px 0 20px; display: flex; flex-wrap: wrap; gap: 8px; }
.qbo-estimate-bottom { display: flex; justify-content: space-between; gap: 32px; flex-wrap: wrap; }
.qbo-estimate-notes { display: flex; flex-direction: column; gap: 14px; flex: 1 1 320px; max-width: 460px; }
.qbo-estimate-notes textarea { width: 100%; }
.qbo-estimate-totals { border-collapse: collapse; min-width: 300px; align-self: flex-start; font-variant-numeric: tabular-nums; }
.qbo-estimate-totals th { text-align: right; font-weight: normal; color: #393a3d; padding: 6px 16px 6px 0; }
.qbo-estimate-totals td { text-align: right; padding: 6px 0; min-width: 110px; }
.qbo-estimate-totals #qbo-estimate-tax.qbo-pending { color: var(--qbo-muted); font-style: italic; font-size: .9em; }
.qbo-estimate-totals .qbo-estimate-total th, .qbo-estimate-totals .qbo-estimate-total td { font-weight: 700; font-size: 1.15em; border-top: 1px solid #d4d7dc; padding-top: 10px; }
.qbo-estimate .qbo-button { display: inline-flex; align-items: center; box-sizing: border-box; height: 34px; margin: 0;
border: 1px solid #8d9096; background: #fff; color: #393a3d; border-radius: 4px; padding: 0 16px;
font-size: 1em; font-family: inherit; font-weight: 600; cursor: pointer; text-decoration: none; line-height: 1; white-space: nowrap; }
.qbo-estimate .qbo-button:hover { background: #f4f5f8; text-decoration: none; }
.qbo-estimate-actions { position: sticky; bottom: 0; z-index: 5; display: flex; justify-content: space-between; align-items: center;
background: var(--qbo-bar); padding: 10px 24px; border-radius: 0 0 4px 4px; margin-top: 0; }
.qbo-estimate-actions-save { display: flex; gap: 8px; }
.qbo-estimate .qbo-button-dark { background: transparent; color: #fff; border-color: #fff; }
.qbo-estimate .qbo-button-dark:hover { background: rgba(255,255,255,.12); color: #fff; }
.qbo-estimate-actions a.qbo-button-dark, .qbo-estimate-actions a.qbo-button-dark:hover { color: #fff; }
.qbo-estimate .qbo-button-primary { background: var(--qbo-green); border-color: var(--qbo-green); color: #fff; }
.qbo-estimate .qbo-button-primary:hover { background: var(--qbo-green-dark); border-color: var(--qbo-green-dark); color: #fff; }
.qbo-estimate-status { display: inline-block; font-size: .6em; font-weight: 600; vertical-align: middle; padding: 2px 8px; border-radius: 10px;
background: #eceef1; color: #393a3d; margin-left: 6px; }
.qbo-estimate-status-sent { background: #e6f4e4; color: #108000; }
.qbo-estimate-status-accepted { background: #e6f4e4; color: #108000; }
.qbo-estimate-status-closed, .qbo-estimate-status-converted { background: #e8eefa; color: #0d47a1; }
/* Warnings with a list (linked issues, invoices): the text, then one item per line */
div.warning.qbo-estimate-notice { text-align: left; }
div.warning.qbo-estimate-notice ul { margin: 6px 0 0; padding-left: 22px; }
div.warning.qbo-estimate-notice li { margin: 2px 0; }
.qbo-estimate-status-rejected { background: #fdecea; color: #b71c1c; }
.qbo-estimate-edit-link { margin-left: 4px; vertical-align: middle; }
/* Phones: each line becomes a small card (number, product and delete; description; qty, rate, amount and tax) */
@media (max-width: 699px) {
.qbo-estimate-lines { min-width: 0; }
.qbo-estimate-lines thead { display: none; }
.qbo-estimate-lines tr.qbo-line { display: grid; grid-template-columns: 24px 1fr 1fr 1fr 44px; gap: 4px 8px; padding: 10px 0; border-bottom: 1px solid #d4d7dc; }
.qbo-estimate-lines tr.qbo-line td { display: block; border: 0; padding: 0; width: auto; }
.qbo-estimate-lines td[data-label]::before { content: attr(data-label); display: block; font-size: .75em; font-weight: 600; text-transform: uppercase; color: var(--qbo-muted); margin-bottom: 2px; }
.qbo-estimate-lines tr.qbo-line td.qbo-line-handle { display: none; }
.qbo-estimate-lines td.qbo-line-number { grid-column: 1; grid-row: 1; padding-top: 22px; text-align: left; }
.qbo-estimate-lines td.qbo-line-item { grid-column: 2 / 5; grid-row: 1; }
.qbo-estimate-lines td.qbo-line-remove { grid-column: 5; grid-row: 1; padding-top: 18px; text-align: center; }
.qbo-estimate-lines td.qbo-line-description { grid-column: 2 / 6; grid-row: 2; }
.qbo-estimate-lines td.qbo-line-qty { grid-column: 2; grid-row: 3; }
.qbo-estimate-lines td.qbo-line-rate { grid-column: 3; grid-row: 3; }
.qbo-estimate-lines td.qbo-line-amount { grid-column: 4; grid-row: 3; }
.qbo-estimate-lines td.qbo-line-tax { grid-column: 5; grid-row: 3; text-align: center; }
.qbo-estimate-lines td.qbo-line-tax input { margin-top: 8px; }
.qbo-estimate-lines tr.qbo-line-subtotal { background: #f4f5f8; }
.qbo-estimate-lines tr.qbo-line-subtotal td.qbo-line-subtotal-label { grid-column: 2 / 4; grid-row: 1; padding-top: 4px; }
.qbo-estimate-lines tr.qbo-line-subtotal td.qbo-line-subtotal-amount { grid-column: 4; grid-row: 1; padding: 4px 0 0; }
.qbo-estimate-lines tr.qbo-line-subtotal td.qbo-line-number { padding-top: 4px; }
.qbo-estimate-lines tr.qbo-line-subtotal td.qbo-line-remove { padding-top: 0; }
.qbo-estimate-lines tr.qbo-line-subtotal td.qbo-line-tax { display: none; }
.qbo-estimate-lines input[type=text], .qbo-estimate-lines textarea { border-color: var(--qbo-border); background: #fff; }
.qbo-line-remove-button { visibility: visible; }
}
@media (max-width: 899px) {
.qbo-estimate-sheet { padding: 14px; }
.qbo-estimate-top { flex-direction: column-reverse; gap: 8px; }
.qbo-estimate-amount { text-align: left; }
.qbo-field-customer input, .qbo-field-email input { width: 100%; }
.qbo-field-customer, .qbo-field-email { flex: 1 1 100%; }
.qbo-estimate-totals { width: 100%; }
.qbo-estimate-actions { padding: 10px 14px; }
}
</style>
@@ -0,0 +1,16 @@
<%# A subtotal row: totals the lines above it, back to the previous subtotal (QuickBooks works out the amount) %>
<% name = "estimate[lines][#{key}]" %>
<tr class="qbo-line qbo-line-subtotal">
<td class="qbo-line-handle" title="<%= l(:label_drag_to_reorder) %>"><%= sprite_icon('reorder') %></td>
<td class="qbo-line-number"><%= number %></td>
<td class="qbo-line-subtotal-label" colspan="4">
<%= hidden_field_tag "#{name}[id]", line.id, id: nil %>
<%= hidden_field_tag "#{name}[kind]", 'subtotal', id: nil %>
<%= l(:label_subtotal) %>
</td>
<td class="qbo-line-amount qbo-line-subtotal-amount"></td>
<td class="qbo-line-tax"></td>
<td class="qbo-line-remove">
<button type="button" class="qbo-line-remove-button" title="<%= l(:button_delete) %>"><%= sprite_icon('del') %></button>
</td>
</tr>
+26
View File
@@ -0,0 +1,26 @@
<% html_title "#{l(:label_estimate)} ##{@form.doc_number}" %>
<div class="contextual">
<%# Plugins add estimate actions here (e.g. redmine_qbo_calendar's Add appointment) %>
<%= call_hook :view_qbo_estimate_contextual, { estimate_id: @form.id, customer_id: @form.customer_id, vin: @form.vin, doc_number: @form.doc_number } %>
<%# An estimate is billed once: no Create invoice once it's on an invoice, closed or rejected %>
<% if RedmineQboBilling.invoice_writer? && Array(@form.invoiced_on).empty? && !%w[Converted Closed Rejected].include?(@form.txn_status.to_s) %>
<%= link_to sprite_icon('document', l(:button_create_invoice)), new_qbo_invoice_path(estimate_id: @form.id), class: 'icon icon-document' %>
<% end %>
<% if User.current.allowed_to?(:create_estimate_issues, nil, global: true) %>
<%= link_to sprite_icon('issue', l(:button_create_estimate_issues)), issues_preview_qbo_estimate_path(@form.id), class: 'icon icon-issue' %>
<% end %>
<%= link_to sprite_icon('copy', l(:button_duplicate)), new_qbo_estimate_path(duplicate: @form.id), class: 'icon icon-copy' %>
<%= link_to sprite_icon('application-pdf', l(:label_estimate_pdf)), estimate_path(@form.id), class: 'icon icon-pdf', target: :_blank %>
<% if RedmineQboBilling.sender? && @form.email.present? %>
<%= link_to sprite_icon('email', l(:button_email_estimate)), send_email_qbo_estimate_path(@form.id, email: @form.email),
method: :post, class: 'icon icon-email',
data: { confirm: l(:text_email_estimate_confirmation, number: @form.doc_number, email: @form.email) } %>
<% end %>
<%= link_to sprite_icon('link', l(:button_open_in_quickbooks)),
"https://#{RedmineQbo.sandbox_mode? ? 'sandbox' : 'app'}.qbo.intuit.com/app/estimate?txnId=#{@form.id}",
class: 'icon icon-link', target: :_blank, rel: 'noopener' %>
</div>
<%= render partial: 'qbo_estimates/header', locals: { form: @form } %>
<%= render partial: 'qbo_estimates/form', locals: { form: @form } %>
@@ -0,0 +1,261 @@
<% html_title l(:button_create_estimate_issues) %>
<%# Extra params to carry through (e.g. appointment_id from redmine_qbo_calendar) %>
<% carry = request.query_parameters.merge(request.request_parameters).slice('appointment_id') %>
<div class="contextual">
<%= link_to sprite_icon('angle-left', @return_label), @return_path, class: 'icon icon-angle-left' %>
</div>
<h2>
<%= l(:button_create_estimate_issues) %>
<span class="estimate-preview-subtitle">
&middot; <%= l(:label_estimate) %> #<%= @estimate.doc_number %>
<% if @estimate.customer %>&middot; <%= @estimate.customer.name %><% end %>
</span>
</h2>
<%# Target project: changing it reloads the page with that project's trackers and templates %>
<% if @available_projects.size > 1 %>
<%= form_tag issues_preview_qbo_estimate_path(@estimate.id), method: :get, id: 'estimate-issues-project-form' do %>
<% carry.each do |key, value| %><%= hidden_field_tag key, value, id: nil %><% end %>
<p>
<label for="project_id"><strong><%= l(:field_project) %>:</strong></label>
<%= select_tag :project_id,
options_from_collection_for_select(@available_projects, :id, :name, @target_project.id),
onchange: 'this.form.submit();' %>
<noscript><%= submit_tag l(:button_apply), name: nil %></noscript>
</p>
<% end %>
<% else %>
<p><strong><%= l(:field_project) %>:</strong> <%= link_to_project @target_project %></p>
<% end %>
<% if @builder.errors.any? %>
<div id="errorExplanation">
<ul>
<% @builder.errors.each do |message| %>
<li><%= message %></li>
<% end %>
</ul>
</div>
<% end %>
<% proposals = @builder.proposals %>
<% if proposals.empty? %>
<p class="nodata">
<%= l(:error_no_labor_lines_found) %>
(<%= l(:label_estimate_item_codes) %>: <%= RedmineQboBilling::EstimateIssueBuilder.item_codes.join(', ') %>)
<% if User.current.admin? %>
&middot; <%= link_to l(:label_settings), plugin_settings_path(id: 'redmine_qbo') %>
<% end %>
</p>
<% else %>
<%
templates_enabled = RedmineQboBilling::IssueTemplateSupport.enabled_for?(@target_project)
template_data = @templates.map { |t| { key: t.key, title: t.title, tracker_id: t.tracker_id, is_default: t.is_default, group: t.group } }
default_template_for = ->(tracker_id) { @templates.detect { |t| t.tracker_id == tracker_id.to_i && t.is_default }&.key }
selectable_count = proposals.count { |p| !p.created? }
%>
<%= form_tag create_issues_qbo_estimate_path(@estimate.id),
method: :post,
id: 'estimate-issues-form',
data: { templates: template_data.to_json } do %>
<%= hidden_field_tag :project_id, @target_project.id %>
<% carry.each do |key, value| %><%= hidden_field_tag key, value, id: nil %><% end %>
<table class="list estimate-issues-preview">
<thead>
<tr>
<th class="checkbox">
<% if selectable_count > 0 %>
<input type="checkbox" id="estimate-issues-toggle-all" checked title="<%= l(:button_check_all) %>">
<% end %>
</th>
<th><%= l(:label_estimate_item) %></th>
<th><%= l(:field_subject) %></th>
<th><%= l(:field_tracker) %></th>
<% if templates_enabled %>
<th><%= l(:label_issue_template) %></th>
<% end %>
<th><%= l(:field_estimated_hours) %></th>
</tr>
</thead>
<tbody>
<% proposals.each do |proposal| %>
<% field = "lines[#{proposal.line_id}]" %>
<% if proposal.created? %>
<tr class="estimate-line created">
<td class="checkbox"><input type="checkbox" disabled></td>
<td><%= proposal.item_name %></td>
<td class="subject"><%= proposal.description %></td>
<td colspan="<%= templates_enabled ? 3 : 2 %>">
<%= l(:label_estimate_line_already_created) %>:
<%= link_to_issue(proposal.existing_issue, truncate: 60) %>
</td>
</tr>
<% else %>
<%
row = (@rows[proposal.line_id] || {}).to_h
selected = row.empty? || row['selected'] == '1'
tracker_id = (row['tracker_id'].presence || @default_tracker&.id).to_i
template_key = row.key?('template') ? row['template'] : default_template_for.call(tracker_id)
hours = row.key?('estimated_hours') ? row['estimated_hours'] : proposal.hours
%>
<tr class="estimate-line">
<td class="checkbox">
<%= hidden_field_tag "#{field}[selected]", '0', id: nil %>
<%= check_box_tag "#{field}[selected]", '1', selected, class: 'estimate-line-select', id: nil %>
</td>
<td><%= proposal.item_name %></td>
<td class="subject">
<%= text_field_tag "#{field}[subject]", row['subject'] || proposal.description,
maxlength: 255, class: 'estimate-line-subject', id: nil %>
</td>
<td>
<%= select_tag "#{field}[tracker_id]",
options_from_collection_for_select(@trackers, :id, :name, tracker_id),
class: 'estimate-line-tracker', id: nil %>
</td>
<% if templates_enabled %>
<td>
<%# Options are filled by the script below to match the chosen tracker %>
<%= select_tag "#{field}[template]",
options_for_select([[l(:label_no_issue_template), '']] +
@templates.select { |t| t.tracker_id == tracker_id }.map { |t| [t.title, t.key] }, template_key),
class: 'estimate-line-template', id: nil %>
</td>
<% end %>
<td>
<%= number_field_tag "#{field}[estimated_hours]", hours, step: 0.25, min: 0, size: 6, id: nil %>
</td>
</tr>
<% end %>
<% end %>
</tbody>
</table>
<%# Custom fields for the chosen trackers, entered once and applied to every issue that uses them %>
<% if @field_set&.any? %>
<fieldset class="box tabular estimate-issue-fields" id="estimate-issue-fields">
<legend><%= l(:label_estimate_issue_fields) %></legend>
<p class="estimate-issue-fields-info"><em class="info"><%= l(:text_estimate_issue_fields_info) %></em></p>
<% @field_set.fields.each do |field| %>
<p class="estimate-issue-field"
data-tracker-ids="<%= field.tracker_ids.join(',') %>"
data-required-tracker-ids="<%= field.required_tracker_ids.join(',') %>">
<label for="<%= custom_field_tag_id('issue', field.custom_field) %>">
<%= custom_field_name_tag(field.custom_field) %>
<span class="required estimate-field-required"<%= ' style="display:none"'.html_safe unless field.required_for_any? %>> *</span>
</label>
<%= custom_field_tag('issue', field.custom_value) %>
</p>
<% end %>
</fieldset>
<% end %>
<p class="estimate-issues-hint">
<% if templates_enabled %>
<%= l(:text_estimate_issues_template_hint) %>
<% else %>
<%= l(:text_estimate_issues_hint) %>
<% end %>
</p>
<p>
<% if selectable_count > 0 %>
<%= submit_tag l(:button_create_estimate_issues_submit), data: { disable_with: l(:label_loading) } %>
<% end %>
<%= link_to l(:button_cancel), @return_path %>
</p>
<% end %>
<%= javascript_tag do %>
(function () {
var form = document.getElementById('estimate-issues-form');
if (!form) return;
// Select / deselect all lines
var toggleAll = document.getElementById('estimate-issues-toggle-all');
if (toggleAll) {
toggleAll.addEventListener('change', function () {
form.querySelectorAll('.estimate-line-select').forEach(function (box) { box.checked = toggleAll.checked; });
});
}
// Keep each template dropdown limited to templates for the chosen tracker
var templates = [];
try { templates = JSON.parse(form.dataset.templates || '[]'); } catch (e) { templates = []; }
var noneLabel = <%= raw l(:label_no_issue_template).to_json %>;
function fillTemplates(templateSelect, trackerId, useDefault) {
var current = templateSelect.value;
var matches = templates.filter(function (t) { return String(t.tracker_id) === String(trackerId); });
templateSelect.innerHTML = '';
templateSelect.appendChild(new Option(noneLabel, ''));
matches.forEach(function (t) {
templateSelect.appendChild(new Option(t.title + (t.group === 'global' ? ' (global)' : ''), t.key));
});
var defaultTemplate = matches.find(function (t) { return t.is_default; });
if (useDefault) {
templateSelect.value = defaultTemplate ? defaultTemplate.key : '';
} else if (matches.some(function (t) { return t.key === current; })) {
templateSelect.value = current;
}
}
form.querySelectorAll('tr.estimate-line').forEach(function (row) {
var tracker = row.querySelector('.estimate-line-tracker');
var template = row.querySelector('.estimate-line-template');
if (!tracker || !template) return;
fillTemplates(template, tracker.value, false);
tracker.addEventListener('change', function () { fillTemplates(template, tracker.value, true); });
});
// Show only the custom fields used by the trackers of the selected lines, and star the required ones
var fieldBox = document.getElementById('estimate-issue-fields');
function idList(value) {
return (value || '').split(',').filter(function (v) { return v !== ''; });
}
function updateFields() {
if (!fieldBox) return;
var trackerIds = [];
form.querySelectorAll('tr.estimate-line').forEach(function (row) {
var box = row.querySelector('.estimate-line-select');
var tracker = row.querySelector('.estimate-line-tracker');
if (box && tracker && box.checked && trackerIds.indexOf(tracker.value) < 0) trackerIds.push(tracker.value);
});
var visibleCount = 0;
fieldBox.querySelectorAll('.estimate-issue-field').forEach(function (field) {
var used = idList(field.dataset.trackerIds).some(function (id) { return trackerIds.indexOf(id) >= 0; });
var required = idList(field.dataset.requiredTrackerIds).some(function (id) { return trackerIds.indexOf(id) >= 0; });
field.style.display = used ? '' : 'none';
var star = field.querySelector('.estimate-field-required');
if (star) star.style.display = required ? '' : 'none';
if (used) visibleCount++;
});
fieldBox.style.display = visibleCount > 0 ? '' : 'none';
}
form.querySelectorAll('.estimate-line-select, .estimate-line-tracker').forEach(function (el) {
el.addEventListener('change', updateFields);
});
if (toggleAll) toggleAll.addEventListener('change', updateFields);
updateFields();
})();
<% end %>
<% end %>
<%# Inline so the page never depends on precompiled plugin assets %>
<style>
.estimate-preview-subtitle { font-weight: normal; font-size: 0.8em; color: #777; }
table.estimate-issues-preview td.subject { text-align: left; }
table.estimate-issues-preview td.subject input { width: 98%; }
table.estimate-issues-preview tr.created td { color: #888; }
.estimate-issues-hint { color: #777; font-size: 0.9em; }
.estimate-issue-fields .estimate-issue-fields-info { padding-left: 0; }
</style>
+4
View File
@@ -0,0 +1,4 @@
<% html_title l(:label_new_estimate) %>
<%= render partial: 'qbo_estimates/header', locals: { form: @form } %>
<%= render partial: 'qbo_estimates/form', locals: { form: @form } %>
@@ -0,0 +1,2 @@
<%= link_to sprite_icon('document', l(:button_create_invoice)), new_qbo_invoice_path(customer_id: customer.id),
class: 'icon icon-document' %>
@@ -0,0 +1,5 @@
<%# Invoices with a payment applied are read-only, so they get a View link instead of Edit %>
<% paid = invoice.balance && invoice.total_amount && invoice.balance.to_d < invoice.total_amount.to_d %>
<%= link_to sprite_icon(paid ? 'zoom-in' : 'edit', l(paid ? :button_view_invoice : :button_edit)), edit_qbo_invoice_path(invoice.id),
class: "icon-only #{paid ? 'icon-zoom-in' : 'icon-edit'} qbo-estimate-edit-link",
title: l(paid ? :button_view_invoice : :button_edit_invoice) %>
+19
View File
@@ -0,0 +1,19 @@
<% html_title "#{l(:label_invoice)} ##{@form.doc_number}" %>
<div class="contextual">
<% if RedmineQboBilling.payment_receiver? && @form.balance.to_d > 0 %>
<%= link_to sprite_icon('add', l(:button_receive_payment)), new_qbo_payment_path(customer_id: @form.customer_id), class: 'icon icon-add' %>
<% end %>
<%= link_to sprite_icon('application-pdf', l(:label_estimate_pdf)), invoice_path(@form.id), class: 'icon icon-pdf', target: :_blank %>
<% if RedmineQboBilling.invoice_sender? && @form.email.present? %>
<%= link_to sprite_icon('email', l(:button_email_estimate)), send_email_qbo_invoice_path(@form.id, email: @form.email),
method: :post, class: 'icon icon-email',
data: { confirm: l(:text_email_invoice_confirmation, number: @form.doc_number, email: @form.email) } %>
<% end %>
<%= link_to sprite_icon('link', l(:button_open_in_quickbooks)),
"https://#{RedmineQbo.sandbox_mode? ? 'sandbox' : 'app'}.qbo.intuit.com/app/invoice?txnId=#{@form.id}",
class: 'icon icon-link', target: :_blank, rel: 'noopener' %>
</div>
<%= render partial: 'qbo_estimates/header', locals: { form: @form } %>
<%= render partial: 'qbo_estimates/form', locals: { form: @form } %>
+4
View File
@@ -0,0 +1,4 @@
<% html_title l(:label_new_invoice) %>
<%= render partial: 'qbo_estimates/header', locals: { form: @form } %>
<%= render partial: 'qbo_estimates/form', locals: { form: @form } %>
+82
View File
@@ -0,0 +1,82 @@
<% html_title @customer.name, l(:label_payments) %>
<div class="contextual">
<% if RedmineQboBilling.payment_receiver? %>
<%= link_to sprite_icon('add', l(:button_receive_payment)), new_qbo_payment_path(customer_id: @customer.id), class: 'icon icon-add' %>
<% end %>
<%= link_to sprite_icon('link', l(:button_open_in_quickbooks)),
"https://#{RedmineQbo.sandbox_mode? ? 'sandbox' : 'app'}.qbo.intuit.com/app/customerdetail?nameId=#{@customer.id}",
class: 'icon icon-link', target: :_blank, rel: 'noopener' %>
</div>
<h2>
<%= link_to l(:label_customers), customers_path %> &#187;
<%= link_to @customer.name, customer_path(@customer) %> &#187;
<%= l(:label_payments) %>
</h2>
<% if @payments.empty? %>
<p class="nodata"><%= l(:label_no_payments) %></p>
<% else %>
<div class="autoscroll">
<table class="list qbo-payments">
<thead>
<tr>
<th><%= l(:label_payment_date) %></th>
<th><%= l(:label_payment_method) %></th>
<th><%= l(:label_payment_reference) %></th>
<th class="applied"><%= l(:label_payment_applies_to) %></th>
<th class="memo"><%= l(:label_memo) %></th>
<th class="amount"><%= l(:label_amount) %></th>
<th class="amount"><%= l(:label_payment_unapplied) %></th>
<th></th>
</tr>
</thead>
<tbody>
<% @payments.each do |payment| %>
<% applied = RedmineQboBilling::PaymentWriter.applied_invoices(payment) %>
<% unapplied = BigDecimal(payment.unapplied_amount.to_s.presence || '0') %>
<tr>
<td class="date"><%= link_to format_date(payment.txn_date), qbo_payment_path(payment.id) %></td>
<td><%= RedmineQboBilling::PaymentWriter.payment_method_name(payment) %></td>
<td><%= payment.payment_ref_number %></td>
<td class="applied">
<% if applied.empty? %>
<em><%= l(:label_payment_deposit) %></em>
<% else %>
<% applied.each do |invoice_id, number, amount| %>
<div>
<%= link_to "##{number}", RedmineQboBilling.invoice_writer? ? edit_qbo_invoice_path(invoice_id) : invoice_path(invoice_id) %>
<%= number_to_currency(amount) %>
</div>
<% end %>
<% end %>
</td>
<td class="memo"><%= truncate(payment.private_note.to_s, length: 60) %></td>
<td class="amount"><%= number_to_currency(payment.total) %></td>
<td class="amount"><%= unapplied > 0 ? number_to_currency(unapplied) : '' %></td>
<td class="buttons">
<%= link_to sprite_icon('application-pdf', l(:button_print_payment)), pdf_qbo_payment_path(payment.id),
class: 'icon icon-pdf', target: :_blank %>
</td>
</tr>
<% end %>
</tbody>
<tfoot>
<tr class="total">
<td colspan="5"><strong><%= l(:label_payment_totals) %></strong> (<%= @payments.size %>)</td>
<td class="amount"><strong><%= number_to_currency(@totals[:received]) %></strong></td>
<td class="amount"><strong><%= @totals[:unapplied] > 0 ? number_to_currency(@totals[:unapplied]) : '' %></strong></td>
<td></td>
</tr>
</tfoot>
</table>
</div>
<% end %>
<style>
table.qbo-payments td { vertical-align: top; }
table.qbo-payments .applied, table.qbo-payments .memo { text-align: left; }
table.qbo-payments .amount { text-align: right; white-space: nowrap; }
table.qbo-payments tfoot td { border-top: 2px solid #ccc; }
</style>
+187
View File
@@ -0,0 +1,187 @@
<% html_title l(:button_receive_payment) %>
<% customer = Customer.find_by(id: @form.customer_id) if @form.customer_id.present? %>
<h2>
<%= link_to l(:label_customers), customers_path %> &#187;
<% if customer %><%= link_to customer.name, customer_path(customer) %> &#187;<% end %>
<%= l(:button_receive_payment) %>
</h2>
<%= error_messages_for @form %>
<%= form_tag qbo_payments_path, id: 'qbo-payment-form',
data: { open_invoices_url: open_invoices_qbo_payments_path, none_text: l(:label_no_open_invoices) } do %>
<div class="box tabular">
<p>
<label for="qbo_payment_customer_name"><%= l(:label_customer) %><span class="required"> *</span></label>
<%= text_field_tag 'payment[customer_name]', @form.customer_name, id: 'qbo_payment_customer_name', class: 'customer-name',
autocomplete: 'off', size: 40, placeholder: l(:label_choose_a_customer),
data: { autocomplete_url: '/customers/autocomplete' } %>
<%= hidden_field_tag 'payment[customer_id]', @form.customer_id, id: 'customer_id' %>
</p>
<p>
<label for="qbo_payment_txn_date"><%= l(:label_payment_date) %><span class="required"> *</span></label>
<%= date_field_tag 'payment[txn_date]', @form.txn_date, id: 'qbo_payment_txn_date' %>
</p>
<p>
<label for="qbo_payment_method"><%= l(:label_payment_method) %><span class="required"> *</span></label>
<%= select_tag 'payment[payment_method_id]', options_for_select(@payment_methods, @form.payment_method_id),
include_blank: true, id: 'qbo_payment_method' %>
<% if @payment_methods.empty? %>
<em class="info"><%= l(:text_no_payment_methods) %></em>
<% end %>
</p>
<p>
<label for="qbo_payment_reference"><%= l(:label_payment_reference) %></label>
<%= text_field_tag 'payment[reference]', @form.reference, id: 'qbo_payment_reference', size: 20, maxlength: 21 %>
<em class="info"><%= l(:text_payment_reference) %></em>
</p>
<p>
<label for="qbo_payment_amount"><%= l(:label_amount) %><span class="required"> *</span></label>
<%= text_field_tag 'payment[amount]', @form.amount, id: 'qbo_payment_amount', size: 12, inputmode: 'decimal', autocomplete: 'off' %>
</p>
<p>
<label for="qbo_payment_deposit"><%= l(:label_payment_deposit) %></label>
<%= hidden_field_tag 'payment[deposit]', '0', id: nil %>
<%= check_box_tag 'payment[deposit]', '1', @form.deposit?, id: 'qbo_payment_deposit' %>
<em class="info"><%= l(:text_payment_deposit) %></em>
</p>
<p>
<label for="qbo_payment_memo"><%= l(:label_memo) %></label>
<%= text_area_tag 'payment[memo]', @form.memo, id: 'qbo_payment_memo', rows: 3, cols: 60, maxlength: 4000 %>
</p>
</div>
<%# How the amount will be applied: the customer's open invoices, oldest first (worked out again when saving) %>
<fieldset class="box" id="qbo-payment-invoices">
<legend><%= l(:label_payment_applies_to) %></legend>
<p><em class="info"><%= l(:text_payment_pick_invoices) %></em></p>
<table class="list qbo-payment-invoices">
<thead>
<tr>
<th class="checkbox"><input type="checkbox" id="qbo-payment-all" aria-label="<%= l(:button_check_all) %>"></th>
<th><%= l(:label_invoice) %></th>
<th><%= l(:label_date) %></th>
<th><%= l(:label_due_date) %></th>
<th class="qbo-num"><%= l(:label_estimate_total) %></th>
<th class="qbo-num"><%= l(:label_open_balance) %></th>
<th class="qbo-num"><%= l(:label_payment_applied) %></th>
</tr>
</thead>
<tbody id="qbo-payment-invoice-rows">
<% @open_invoices.each do |invoice| %>
<tr data-balance="<%= invoice[:balance] %>">
<td class="checkbox"><%= check_box_tag 'payment[invoice_ids][]', invoice[:id], @form.invoice_ids.include?(invoice[:id]), id: nil, class: 'qbo-payment-pick' %></td>
<td>#<%= invoice[:doc_number] %></td>
<td><%= invoice[:date] %></td>
<td><%= invoice[:due_date] %></td>
<td class="qbo-num"><%= number_to_currency(invoice[:total]) %></td>
<td class="qbo-num"><%= number_to_currency(invoice[:balance]) %></td>
<td class="qbo-num qbo-payment-applied"></td>
</tr>
<% end %>
<% if @open_invoices.empty? %>
<tr class="qbo-payment-none"><td colspan="7"><%= l(:label_no_open_invoices) %></td></tr>
<% end %>
</tbody>
<tfoot>
<tr>
<th colspan="6" class="qbo-num"><%= l(:label_payment_unapplied) %></th>
<th class="qbo-num" id="qbo-payment-unapplied"></th>
</tr>
</tfoot>
</table>
</fieldset>
<p>
<%= submit_tag l(:button_save_payment) %>
<%= link_to l(:button_cancel), customer ? customer_path(customer) : home_path %>
</p>
<% end %>
<style>
table.qbo-payment-invoices { width: auto; min-width: 60%; }
table.qbo-payment-invoices .qbo-num { text-align: right; font-variant-numeric: tabular-nums; white-space: nowrap; }
table.qbo-payment-invoices td.qbo-payment-applied { font-weight: 600; }
#qbo-payment-form.qbo-deposit table.qbo-payment-invoices td.qbo-payment-applied { color: #999; font-weight: normal; }
</style>
<%= javascript_tag do %>
$(function () {
var $form = $('#qbo-payment-form');
if (!$form.length) return;
var money = new Intl.NumberFormat(<%= raw (current_language.to_s.presence || 'en').to_json %>, { style: 'currency', currency: 'USD' });
var $rows = $('#qbo-payment-invoice-rows');
function amount() {
var n = Number(String($('#qbo_payment_amount').val() || '').replace(/[$,\s]/g, ''));
return isFinite(n) && n > 0 ? n : 0;
}
function picked() { return $rows.find('.qbo-payment-pick:checked'); }
// Oldest first, like QuickBooks: on the ticked invoices if any are ticked, otherwise on all of them.
// A deposit applies to nothing.
function recalc() {
var deposit = $('#qbo_payment_deposit').is(':checked');
$form.toggleClass('qbo-deposit', deposit);
var left = deposit ? 0 : Math.round(amount() * 100);
var onlyPicked = picked().length > 0;
$rows.children('tr[data-balance]').each(function () {
var balance = Math.round(parseFloat($(this).data('balance')) * 100);
var counts = !onlyPicked || $(this).find('.qbo-payment-pick').is(':checked');
var take = counts ? Math.min(left, balance) : 0;
left -= take;
$(this).find('.qbo-payment-applied').text(take > 0 ? money.format(take / 100) : '');
});
var unapplied = deposit ? amount() : left / 100;
$('#qbo-payment-unapplied').text(money.format(unapplied));
}
function loadInvoices(customerId) {
$rows.empty();
if (!customerId) { recalc(); return; }
$.getJSON($form.data('openInvoicesUrl'), { customer_id: customerId }).done(function (invoices) {
(invoices || []).forEach(function (invoice) {
$('<tr>').attr('data-balance', invoice.balance).append(
$('<td class="checkbox">').append($('<input type="checkbox" name="payment[invoice_ids][]" class="qbo-payment-pick">').val(invoice.id)),
$('<td>').text('#' + invoice.doc_number), $('<td>').text(invoice.date), $('<td>').text(invoice.due_date),
$('<td class="qbo-num">').text(money.format(parseFloat(invoice.total || 0))),
$('<td class="qbo-num">').text(money.format(parseFloat(invoice.balance))),
$('<td class="qbo-num qbo-payment-applied">')
).appendTo($rows);
});
if (!$rows.children().length) {
$('<tr class="qbo-payment-none">').append($('<td colspan="7">').text($form.data('noneText'))).appendTo($rows);
}
recalc();
});
}
$('#customer_id').on('change', function () { loadInvoices(this.value); });
$('#qbo_payment_customer_name').on('input', function () { if (!this.value.trim()) $('#customer_id').val(''); });
// Ticking invoices fills in the amount: the total of their open balances
function fillAmount() {
var cents = 0;
picked().each(function () { cents += Math.round(parseFloat($(this).closest('tr').data('balance')) * 100); });
if (picked().length) {
$('#qbo_payment_amount').val((cents / 100).toFixed(2));
$('#qbo_payment_deposit').prop('checked', false);
}
var $all = $('#qbo-payment-all');
var boxes = $rows.find('.qbo-payment-pick');
$all.prop('checked', boxes.length > 0 && picked().length === boxes.length);
recalc();
}
$rows.on('change', '.qbo-payment-pick', fillAmount);
$('#qbo-payment-all').on('change', function () {
$rows.find('.qbo-payment-pick').prop('checked', this.checked);
if (!this.checked) $('#qbo_payment_amount').val('');
fillAmount();
});
$('#qbo_payment_amount').on('input', recalc);
$('#qbo_payment_deposit').on('change', recalc);
$form.on('keydown', 'input[type=text]', function (e) { if (e.key === 'Enter' && $(this).hasClass('customer-name')) e.preventDefault(); });
recalc();
});
<% end %>
+58
View File
@@ -0,0 +1,58 @@
<% html_title l(:label_payment) %>
<% method_name = RedmineQboBilling::PaymentWriter.payment_method_name(@payment) %>
<div class="contextual">
<%= link_to sprite_icon('application-pdf', l(:button_print_payment)), pdf_qbo_payment_path(@payment.id), class: 'icon icon-pdf', target: :_blank %>
<% if @customer && RedmineQboBilling.payment_receiver? %>
<%= link_to sprite_icon('add', l(:button_receive_payment)), new_qbo_payment_path(customer_id: @customer.id), class: 'icon icon-add' %>
<% end %>
<%= link_to sprite_icon('link', l(:button_open_in_quickbooks)),
"https://#{RedmineQbo.sandbox_mode? ? 'sandbox' : 'app'}.qbo.intuit.com/app/recvpayment?txnId=#{@payment.id}",
class: 'icon icon-link', target: :_blank, rel: 'noopener' %>
</div>
<h2>
<%= link_to l(:label_customers), customers_path %> &#187;
<% if @customer %><%= link_to @customer.name, customer_path(@customer) %> &#187;
<%= link_to l(:label_payments), qbo_payments_path(customer_id: @customer.id) %> &#187;<% end %>
<%= l(:label_payment) %> <%= number_to_currency(@payment.total) %>
</h2>
<div class="issue details">
<div class="attributes">
<div class="splitcontent">
<div class="splitcontentleft">
<div class="attribute"><div class="label"><%= l(:label_payment_date) %>:</div><div class="value"><%= format_date(@payment.txn_date) %></div></div>
<div class="attribute"><div class="label"><%= l(:label_payment_method) %>:</div><div class="value"><%= method_name %></div></div>
<div class="attribute"><div class="label"><%= l(:label_payment_reference) %>:</div><div class="value"><%= @payment.payment_ref_number %></div></div>
</div>
<div class="splitcontentright">
<div class="attribute"><div class="label"><%= l(:label_amount) %>:</div><div class="value"><%= number_to_currency(@payment.total) %></div></div>
<div class="attribute"><div class="label"><%= l(:label_payment_unapplied) %>:</div><div class="value"><%= number_to_currency(@payment.unapplied_amount || 0) %></div></div>
</div>
</div>
</div>
<% if @payment.private_note.present? %>
<hr />
<p><strong><%= l(:label_memo) %></strong></p>
<p><%= @payment.private_note %></p>
<% end %>
</div>
<h3><%= l(:label_payment_applies_to) %></h3>
<% applied = RedmineQboBilling::PaymentWriter.applied_invoices(@payment) %>
<% if applied.empty? %>
<p class="nodata"><%= l(:text_payment_unapplied_deposit) %></p>
<% else %>
<table class="list">
<thead><tr><th><%= l(:label_invoice) %></th><th><%= l(:label_payment_applied) %></th></tr></thead>
<tbody>
<% applied.each do |invoice_id, number, amount| %>
<tr>
<td><%= link_to "##{number}", RedmineQboBilling.invoice_writer? ? edit_qbo_invoice_path(invoice_id) : invoice_path(invoice_id) %></td>
<td><%= number_to_currency(amount) %></td>
</tr>
<% end %>
</tbody>
</table>
<% end %>
-1
View File
@@ -1 +0,0 @@
!function(t){t.fn.railsAutocomplete=function(e){var a=function(){this.railsAutoCompleter||(this.railsAutoCompleter=new t.railsAutocomplete(this))};if(void 0!==t.fn.on){if(!e)return;return t(document).on("focus",e,a)}return this.live("focus",a)},t.railsAutocomplete=function(t){var e=t;this.init(e)},t.railsAutocomplete.options={showNoMatches:!0,noMatchesLabel:"no existing match"},t.railsAutocomplete.fn=t.railsAutocomplete.prototype={railsAutocomplete:"0.0.1"},t.railsAutocomplete.fn.extend=t.railsAutocomplete.extend=t.extend,t.railsAutocomplete.fn.extend({init:function(e){function a(t){return t.split(e.delimiter)}function i(t){return a(t).pop().replace(/^\s+/,"")}e.delimiter=t(e).attr("data-delimiter")||null,e.min_length=t(e).attr("data-min-length")||t(e).attr("min-length")||2,e.append_to=t(e).attr("data-append-to")||null,e.autoFocus=t(e).attr("data-auto-focus")||!1,t(e).autocomplete({appendTo:e.append_to,autoFocus:e.autoFocus,delay:t(e).attr("delay")||0,source:function(a,r){var n=this.element[0],o={term:i(a.term)};t(e).attr("data-autocomplete-fields")&&t.each(t.parseJSON(t(e).attr("data-autocomplete-fields")),function(e,a){o[e]=t(a).val()}),t.getJSON(t(e).attr("data-autocomplete"),o,function(){var a={};t.extend(a,t.railsAutocomplete.options),t.each(a,function(i,r){if(a.hasOwnProperty(i)){var n=t(e).attr("data-"+i);a[i]=n?n:r}}),0==arguments[0].length&&t.inArray(a.showNoMatches,[!0,"true"])>=0&&(arguments[0]=[],arguments[0][0]={id:"",label:a.noMatchesLabel}),t(arguments[0]).each(function(a,i){var r={};r[i.id]=i,t(e).data(r)}),r.apply(null,arguments),t(n).trigger("railsAutocomplete.source",arguments)})},change:function(e,a){if(t(this).is("[data-id-element]")&&""!==t(t(this).attr("data-id-element")).val()&&(t(t(this).attr("data-id-element")).val(a.item?a.item.id:"").trigger("change"),t(this).attr("data-update-elements"))){var i=t.parseJSON(t(this).attr("data-update-elements")),r=a.item?t(this).data(a.item.id.toString()):{};if(i&&""===t(i.id).val())return;for(var n in i){var o=t(i[n]);o.is(":checkbox")?null!=r[n]&&o.prop("checked",r[n]):o.val(a.item?r[n]:"").trigger("change")}}},search:function(){var t=i(this.value);return t.length<e.min_length?!1:void 0},focus:function(){return!1},select:function(i,r){if(r.item.value=r.item.value.toString(),-1!=r.item.value.toLowerCase().indexOf("no match")||-1!=r.item.value.toLowerCase().indexOf("too many results"))return t(this).trigger("railsAutocomplete.noMatch",r),!1;var n=a(this.value);if(n.pop(),n.push(r.item.value),null!=e.delimiter)n.push(""),this.value=n.join(e.delimiter);else if(this.value=n.join(""),t(this).attr("data-id-element")&&t(t(this).attr("data-id-element")).val(r.item.id).trigger("change"),t(this).attr("data-update-elements")){var o=r.item,l=-1!=r.item.value.indexOf("Create New")?!0:!1,u=t.parseJSON(t(this).attr("data-update-elements"));for(var s in u)"checkbox"===t(u[s]).attr("type")?o[s]===!0||1===o[s]?t(u[s]).attr("checked","checked"):t(u[s]).removeAttr("checked"):l&&o[s]&&-1==o[s].indexOf("Create New")||!l?t(u[s]).val(o[s]).trigger("change"):t(u[s]).val("").trigger("change")}var c=this.value;return t(this).bind("keyup.clearId",function(){t.trim(t(this).val())!=t.trim(c)&&(t(t(this).attr("data-id-element")).val("").trigger("change"),t(this).unbind("keyup.clearId"))}),t(e).trigger("railsAutocomplete.select",r),!1}}),t(e).trigger("railsAutocomplete.init")}}),t(document).ready(function(){t("input[data-autocomplete]").railsAutocomplete("input[data-autocomplete]")})}(jQuery);
+102
View File
@@ -0,0 +1,102 @@
(function () {
// Helper: escape HTML for safety
function escapeHtml(str) {
return $("<div>").text(str).html();
}
// Helper: highlight all occurrences of term (case-insensitive)
function highlightTerm(text, term) {
if (!term) return text;
const escapedTerm = term.replace(/[.*+?^${}()|[\]\\]/g, "\\$&");
const regex = new RegExp("(" + escapedTerm + ")", "ig");
return text.replace(regex, "<strong>$1</strong>");
}
window.initCustomerAutocomplete = function(context) {
let scope = context || document;
$(scope).find(".customer-name").each(function() {
if ($(this).data("autocomplete-initialized")) return;
$(this).data("autocomplete-initialized", true);
let $input = $(this);
let ac = $input.autocomplete({
appendTo: "body", // crucial for Redmine positioning
minLength: 2,
source: function(request, response) {
$.getJSON("/customers/autocomplete", { q: request.term })
.done(function(data) {
response(data.map(function(item) {
// combine secondary info
let secondary = [];
if (item.phone_number) secondary.push(item.phone_number);
if (item.mobile_phone_number) secondary.push(item.mobile_phone_number);
let meta = secondary.length ? " (" + secondary.join(" • ") + ")" : "";
// escape HTML to avoid XSS
let safeText = escapeHtml(item.name + meta);
return {
label: item.name + meta, // plain fallback
value: item.name, // goes into input
id: item.id,
html: highlightTerm(safeText, request.term)
};
}));
})
.fail(function() {
response([]);
});
},
select: function(event, ui) {
$input.val(ui.item.value); // visible text
$("#customer_id").val(ui.item.id); // hidden ID
// trigger Redmine form update safely
setTimeout(function() {
$("#customer_id").trigger("change");
}, 0);
return false;
},
change: function(event, ui) {
// clear hidden field if no valid selection
if (!ui.item && !$input.val()) {
$("#customer_id").val("");
}
}
});
// Render item HTML for highlight
ac.autocomplete("instance")._renderItem = function(ul, item) {
return $("<li>")
.append($("<div>").html(item.html))
.appendTo(ul);
};
});
};
// Re-init after Redmine AJAX form updates
$(document).on("ajaxComplete", function() {
if (window.initCustomerAutocomplete) {
window.initCustomerAutocomplete(document);
}
});
// Init on page load
$(document).ready(function() {
window.initCustomerAutocomplete(document);
});
// Also init on Turbo/Redmine load events
document.addEventListener("turbo:load", function() {
window.initCustomerAutocomplete(document);
});
})();
+5
View File
@@ -0,0 +1,5 @@
/* Keep Redmine default look, just enhance metadata */
.ui-autocomplete .autocomplete-meta {
color: #888;
font-size: 0.9em;
}
+211
View File
@@ -11,6 +11,9 @@
# English strings go here for Rails i18n # English strings go here for Rails i18n
# Usage I18n.t(:label) # Usage I18n.t(:label)
en: en:
notice_qbo_oauth_state_mismatch: "QuickBooks connection was not completed: the request could not be verified. Please try connecting again."
permission_bill_issues: "Bill issue time to QuickBooks"
permission_share_issues_with_customers: "Share issues with customers"
button_bulk_pdf: "Bulk PDF" button_bulk_pdf: "Bulk PDF"
customer_details: "Customer Details" customer_details: "Customer Details"
field_billed: "Billed" field_billed: "Billed"
@@ -36,6 +39,7 @@ en:
label_create_estimate: "Create Estimate" label_create_estimate: "Create Estimate"
label_customer_count: "Customer Count" label_customer_count: "Customer Count"
label_customer_link_expires: "This customer link expires in" label_customer_link_expires: "This customer link expires in"
label_customer: "Customer"
label_customers: "Customers" label_customers: "Customers"
label_delete: "Delete" label_delete: "Delete"
label_deposit_into: "Deposit to Account" label_deposit_into: "Deposit to Account"
@@ -49,6 +53,7 @@ en:
label_error: "Error" label_error: "Error"
label_estimate_404: "Estimate not found" label_estimate_404: "Estimate not found"
label_estimate_count: "Estimate Count" label_estimate_count: "Estimate Count"
label_estimate: "Estimate"
label_estimates: "Estimates" label_estimates: "Estimates"
label_hours: "Hours" label_hours: "Hours"
label_invoice_404: "Invoice not found" label_invoice_404: "Invoice not found"
@@ -62,6 +67,7 @@ en:
label_model: "Model" label_model: "Model"
label_name: "Name" label_name: "Name"
label_new_customer: "New Customer" label_new_customer: "New Customer"
label_new_issue: "New Issue"
label_qbo_never_synced: "Never Synced" label_qbo_never_synced: "Never Synced"
label_no_customers: "There are no customers matching the search term(s)." label_no_customers: "There are no customers matching the search term(s)."
label_no_estimates: "No Estimates" label_no_estimates: "No Estimates"
@@ -82,6 +88,10 @@ en:
label_shipping_address: "Shipping Address" label_shipping_address: "Shipping Address"
label_sync: "Sync" label_sync: "Sync"
label_sync_now: "Sync Now" label_sync_now: "Sync Now"
label_sync_now_customers: "Sync Customers"
label_sync_now_employees: "Sync Employees"
label_sync_now_invoices: "Sync Invoices"
label_sync_now_estimate: "Sync Estimates"
label_syncing: "Syncing QuickBooks" label_syncing: "Syncing QuickBooks"
label_trim: "Trim" label_trim: "Trim"
label_webhook_token: "Intuit QBO Webhook Token" label_webhook_token: "Intuit QBO Webhook Token"
@@ -107,3 +117,204 @@ en:
notice_invoice_updated: "Invoice updated in QuickBooks" notice_invoice_updated: "Invoice updated in QuickBooks"
notice_issue_not_found: "Issue not found" notice_issue_not_found: "Issue not found"
warn_ru_sure: "Are you sure?" warn_ru_sure: "Are you sure?"
# ---- Billing: estimates, invoices, payments, items and accounts ----
label_billing_settings: "Billing"
# Permissions
permission_write_estimates: "Write estimates"
permission_send_estimates: "Email estimates"
permission_write_invoices: "Write invoices"
permission_send_invoices: "Email invoices"
permission_create_estimate_issues: "Create issues from estimates"
permission_receive_payments: "Receive payments"
button_add_lines: "Add lines"
button_add_subtotal: "Add subtotal"
button_clear_all_lines: "Clear all lines"
button_duplicate: "Duplicate"
button_edit_estimate: "Edit estimate"
button_view_estimate: "View estimate"
button_email_estimate: "Email"
button_open_in_quickbooks: "Open in QuickBooks"
button_refresh_quickbooks_fields: "Refresh QuickBooks fields"
button_reload_estimate: "Reload the estimate"
button_save_and_send: "Save and send"
error_estimate_changed_in_quickbooks: "This estimate was changed in QuickBooks after you opened it, so it wasn't saved."
error_estimate_field_invalid: "%{field} is not valid"
error_estimate_linked_to_issues: "This estimate is linked to these issues, so it can't be changed here. Duplicate it to make a new estimate:"
error_estimate_has_bundles: "This estimate has bundles, which can only be edited in QuickBooks."
error_estimate_line_description: "Line %{line} needs a description, a product or service, or a rate"
error_estimate_line_number: "Line %{line} has a quantity or rate that isn't a number"
error_estimate_line_unmatched_item: "Line %{line}: pick \"%{name}\" from the product/service list"
error_estimate_needs_a_line: "Add at least one line"
error_estimate_needs_customer: "Choose a customer"
error_estimate_not_saved: "QuickBooks didn't save the estimate"
error_estimate_not_sent: "QuickBooks didn't send the estimate"
error_estimate_saved_not_sent: "It was saved but not sent: %{message}"
label_choose_a_customer: "Choose a customer"
label_customer_email: "Customer email"
label_discount_from_quickbooks: "Discount"
label_drag_to_reorder: "Drag to reorder"
label_estimate_date: "Estimate date"
label_estimate_expiration_days: "Estimates expire after (days)"
label_estimate_no: "Estimate no."
label_estimate_pdf: "PDF"
label_estimate_sent: "Sent"
label_estimate_total: "Total"
label_expiration_date: "Expiration date"
label_memo: "Memo"
label_message_on_estimate: "Message displayed on estimate"
label_new_estimate: "New estimate"
label_product_service: "Product/service"
label_qty: "Qty"
label_rate: "Rate"
label_sales_person: "Sales person"
label_sales_tax: "Sales tax"
label_subtotal: "Subtotal"
label_tax: "Tax"
label_taxable_subtotal: "Taxable subtotal"
label_vin: "VIN"
notice_estimate_saved_and_sent: "Estimate #%{number} saved in QuickBooks and emailed to %{email}"
notice_estimate_saved_in_quickbooks: "Estimate #%{number} saved in QuickBooks"
notice_estimate_sent: "Estimate #%{number} emailed to %{email}"
notice_estimate_settings_refreshed: "QuickBooks custom fields and estimate settings were read again"
text_assigned_by_quickbooks: "Assigned when saved"
text_clear_all_lines_confirmation: "Clear all lines?"
text_email_estimate_confirmation: "Email estimate #%{number} to %{email}?"
text_estimate_duplicated_from: "Copied from estimate #%{number}. It's saved as a new estimate."
text_estimate_closed: "This estimate is closed (it was turned into an invoice). Changes here won't change the invoice."
text_estimate_expiration_days: "New estimates get an expiration date this many days after the estimate date, e.g. 30. Leave blank for no expiration date."
text_estimate_reload: "Reloading shows the latest version from QuickBooks; changes made on this page will be lost."
text_estimate_send_needs_email: "Enter the customer's email to send it."
text_memo_is_private: "Internal, not shown to the customer"
text_no_sales_person_field: "QuickBooks isn't sharing a text custom field named Sales Person, so this isn't saved."
text_no_vin_field: "QuickBooks isn't sharing a text custom field named VIN."
text_quickbooks_custom_fields_found: "Custom fields QuickBooks shares with apps: %{fields}. QuickBooks only shares its first three text fields; a field it doesn't list in its settings shows up here once it's filled in on an estimate."
text_quickbooks_settings_unavailable: "QuickBooks' estimate settings couldn't be read, so custom fields and the default message are missing. Check the QuickBooks connection."
text_separate_emails_with_comma: "Separate emails with a comma"
text_tax_calculated_by_quickbooks: "Calculated by QuickBooks when saved"
# QuickBooks product/service list and income accounts
field_classification: "Classification"
field_sku: "SKU"
field_taxable: "Taxable"
field_unit_price: "Unit Price"
label_active: "Active"
label_account: "Account"
label_accounts: "Accounts"
label_account_count: "Number of Accounts:"
label_back: "Back"
label_default_account: "Default Item Income Account"
label_description: "Description"
label_edit_item: "Edit Item"
label_item: "Item"
label_item_count: "Item Count:"
label_item_new: "New Item"
label_items: "Items"
label_management_and_sync: "Management & Synchronization"
label_never_synced: "Never synced"
label_no: "No"
label_sync_now_accounts: "Sync Accounts"
label_sync_now_items: "Sync Items"
label_type: "Type"
label_yes: "Yes"
error_default_account_not_selected: "Select an account to make it the default."
notice_default_account_updated: "Default account updated."
# Invoices
button_add_to_invoice: "Add to invoice"
button_create_invoice: "Create invoice"
button_edit_invoice: "Edit invoice"
button_import_time_estimates: "Import time & estimates"
button_undo_import: "Undo import"
button_view_invoice: "View invoice"
error_estimate_already_invoiced: "Estimate #%{number} is already billed on invoice #%{invoice}."
error_estimate_closed_billed: "Estimate #%{number} is already billed (%{status})."
error_estimate_rejected: "Estimate #%{number} was rejected, so it can't be billed."
text_estimate_billed_on: "This estimate is billed on:"
error_invoice_changed_in_quickbooks: "This invoice was changed in QuickBooks after you opened it, so it wasn't saved."
error_invoice_has_bundles: "This invoice has bundles, which can only be edited in QuickBooks."
error_invoice_not_saved: "QuickBooks didn't save the invoice"
error_invoice_not_sent: "QuickBooks didn't send the invoice"
error_invoice_paid: "A payment has been applied to this invoice, so it can't be changed here."
label_billable_time: "Billable time"
label_due_date: "Due date"
label_invoice: "Invoice"
label_invoice_balance: "Balance due %{balance}"
label_invoice_date: "Invoice date"
label_invoice_no: "Invoice no."
label_invoice_paid: "Paid"
label_invoice_partially_paid: "Partially paid"
label_message_on_invoice: "Message displayed on invoice"
label_new_invoice: "New invoice"
label_open_estimates: "Open estimates"
label_replace_lines: "Replace these lines"
label_replaceable_items: "Replaced by imported time"
label_time_badge: "Time"
notice_invoice_saved_and_sent: "Invoice #%{number} saved in QuickBooks and emailed to %{email}"
notice_invoice_saved_in_quickbooks: "Invoice #%{number} saved in QuickBooks"
notice_invoice_sent: "Invoice #%{number} emailed to %{email}"
text_email_invoice_confirmation: "Email invoice #%{number} to %{email}?"
text_invoice_from_estimate: "Made from estimate #%{number}. The estimate is closed when the invoice is saved."
text_invoice_many_vehicles: "These work orders are for more than one vehicle:"
text_line_bills_time: "Bills a QuickBooks time activity; saving marks the time as billed"
text_replaceable_items: "Products/services that billable time can replace on invoices, e.g. Labor. Only invoice lines with these are offered under Replace these lines when time is imported. Leave empty to offer every line. Ctrl/Cmd-click to pick several."
text_replace_lines: "Tick the lines the time replaces (e.g. the estimate's labor lines). The time goes where the first ticked line is."
# Issues from estimates (moved from redmine_qbo_calendar)
button_create_estimate_issues_submit: "Create issues"
button_create_estimate_issues: "Create issues"
error_estimate_lines_already_created: "Some of these estimate lines were just turned into issues by someone else. Please review and try again."
error_no_estimate_lines_selected: "Select at least one estimate line"
error_no_labor_lines_found: "No lines with a description and a matching item code were found on the estimate"
label_default_project: "Default project"
label_default_tracker: "Default tracker"
label_estimate_issue_fields: "Issue fields"
label_estimate_issue_settings: "Issues from estimates"
label_estimate_item: "Item"
label_estimate_item_codes: "Estimate item codes"
label_estimate_line_already_created: "Already created"
label_issue_template: "Template"
label_no_issue_template: "(no template)"
notice_estimate_issues_created:
one: "1 issue created from the estimate"
other: "%{count} issues created from the estimate"
text_default_project_info: "Where issues from estimates are created when nothing else picks a project (e.g. an appointment's project). It can still be changed on the page."
text_default_tracker_info: "Pre-selected for each proposed issue. Leave blank to use the project's first tracker."
text_estimate_issue_fields_info: "Entered once and applied to every created issue whose tracker uses the field. Fields marked * are required by the selected trackers."
text_estimate_issues_hint: "The subject comes from the estimate line's description and estimated hours from its quantity. Edit anything before creating. New issues are related to each other and to issues already created from this estimate."
text_estimate_issues_template_hint: "The subject comes from the estimate line's description and estimated hours from its quantity. A template supplies the issue's description. New issues are related to each other and to issues already created from this estimate."
text_estimate_item_codes_info: "QBO item names that can become issues, one per line (e.g. Labor, Alignments). Matches the full item name or any part of a Category:Item name, ignoring case. Their quantities are also an estimate's labor hours (an appointment's hours can't be less)."
# Payments
button_print_payment: "Print"
button_receive_payment: "Receive payment"
button_save_payment: "Save payment"
error_payment_amount: "Enter the amount received"
error_payment_needs_method: "Choose the payment method"
error_payment_not_saved: "QuickBooks didn't save the payment"
label_no_open_invoices: "No open invoices: the payment is kept as a credit"
label_open_balance: "Open balance"
label_payment: "Payment"
label_payment_applied: "Payment"
label_payment_applies_to: "Applied to"
label_payment_date: "Payment date"
label_payment_deposit: "Deposit"
label_payment_method: "Payment method"
label_payment_reference: "Reference no."
label_payment_unapplied: "Unapplied (credit)"
label_payments: "Payments"
label_no_payments: "No payments from this customer in QuickBooks"
label_payment_totals: "Total"
permission_view_payments: "View payments"
notice_payment_not_found: "Payment not found in QuickBooks"
notice_payment_saved: "Payment of %{amount} saved in QuickBooks"
text_no_payment_methods: "QuickBooks' payment methods couldn't be read. Check the QuickBooks connection."
text_payment_deposit: "Keep it as a credit on the customer's account instead of paying open invoices"
text_payment_pick_invoices: "Tick invoices to fill in the amount and pay just those. With none ticked, the payment goes on the oldest invoices first."
text_payment_reference: "e.g. the check number"
text_payment_unapplied_deposit: "Not applied to any invoice: it's a credit on the customer's account."
+61 -5
View File
@@ -14,17 +14,20 @@ get 'qbo/oauth_callback', to: 'qbo#oauth_callback'
#manual sync #manual sync
get 'qbo/sync', to: 'qbo#sync' get 'qbo/sync', to: 'qbo#sync'
get 'invoices/sync', to: 'invoices#sync'
get 'estimates/sync', to: 'estimates#sync'
get 'employees/sync', to: 'employees#sync'
#webhook #webhook
post 'qbo/webhook', to: 'qbo#webhook' post 'qbo/webhook', to: 'qbo#webhook'
# Estimate & Invoice PDF # Estimate & Invoice PDF
get 'estimates/:id', to: 'estimate#show', as: :estimate get 'estimates/:id', to: 'estimates#show', as: :estimate
get 'estimates/doc/', to: 'estimate#doc', as: :estimate_doc get 'estimates/doc/', to: 'estimates#doc', as: :estimate_doc
get 'invoices/:id', to: 'invoice#show', as: :invoice get 'invoices/:id', to: 'invoices#show', as: :invoice
#manual billing #manual billing
get 'bill/:id', to: 'qbo#bill', as: :bill post 'bill/:id', to: 'qbo#bill', as: :bill
#customer issue view #customer issue view
get 'customers/view/:token', to: 'customers#view', as: :view get 'customers/view/:token', to: 'customers#view', as: :view
@@ -35,5 +38,58 @@ get 'filter_estimates_by_customer' => 'customers#filter_estimates_by_customer'
get 'filter_invoices_by_customer' => 'customers#filter_invoices_by_customer' get 'filter_invoices_by_customer' => 'customers#filter_invoices_by_customer'
resources :customers do resources :customers do
get :autocomplete_customer_name, on: :collection collection do
get :autocomplete
get :sync
end
end
# Estimate writer pages. Kept under /qbo_estimates so they don't clash with redmine_qbo's /estimates/:id PDF route.
resources :qbo_estimates, only: [:new, :create, :edit, :update] do
member do
post :send_email
get :issues_preview
post :create_issues
end
collection do
get :customer_info
get :items
post :refresh_company
end
end
# Invoice writer pages (redmine_qbo has /invoices/:id for the PDF)
resources :qbo_invoices, only: [:new, :create, :edit, :update] do
member do
post :send_email
end
collection do
get :import_options
end
end
# Receive payment pages, and a customer's payments (/qbo_payments?customer_id=)
resources :qbo_payments, only: [:index, :new, :create, :show] do
member do
get :pdf
end
collection do
get :open_invoices
end
end
# QuickBooks product/service list (moved from redmine_qbo_lineitems; same URLs)
resources :items do
collection do
get :autocomplete
get :sync
end
end
# QuickBooks income accounts
resources :accounts do
collection do
patch :set_default
get :sync
end
end end
+201
View File
@@ -0,0 +1,201 @@
Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
1. Definitions.
"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.
"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.
"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.
"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.
"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.
"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.
"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).
"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.
"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."
"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.
2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.
3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.
4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:
(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and
(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and
(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and
(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.
You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.
5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.
6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.
7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.
8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.
9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.
END OF TERMS AND CONDITIONS
APPENDIX: How to apply the Apache License to your work.
To apply the Apache License to your work, attach the following
boilerplate notice, with the fields enclosed by brackets "{}"
replaced with your own identifying information. (Don't include
the brackets!) The text should be enclosed in the appropriate
comment syntax for the file format. We also recommend that a
file or class name and description of purpose be included on the
same "printed page" as the copyright notice for easier
identification within third-party archives.
Copyright {yyyy} {name of copyright owner}
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
+9
View File
@@ -0,0 +1,9 @@
# Nickname data
`names.csv` is from the [nicknames](https://github.com/carltonnorthern/nicknames) project by
Carlton Northern and contributors (commit `ed160b3`), used under the Apache License 2.0
(see `LICENSE.txt`). It is unmodified.
Each row is `name1,has_nickname,name2`. `CustomerSearchService` uses it so that a search for
"Bill Smith" finds "William Smith". To update it, replace `names.csv` with a newer copy from the
project; extra name groups can also be added in `CustomerSearchService::EXTRA_NICKNAME_GROUPS`.
File diff suppressed because it is too large. Load diff
+33
View File
@@ -0,0 +1,33 @@
#The MIT License (MIT)
#
#Copyright (c) 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:
#
#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 QuickBooks product/service list. The table was created by redmine_qbo_lineitems before items moved
# into this plugin, so each step is skipped when an existing database already has it: nothing is dropped or
# copied, the existing table is simply used from here on.
class CreateItemsTable < ActiveRecord::Migration[7.0]
def up
return if table_exists?(:items)
create_table :items do |t|
t.text :description, null: false
t.decimal :unit_price,
precision: 15,
scale: 4,
null: false,
default: 0
t.boolean :active, default: true, null: false
t.timestamps
end
end
def down
drop_table :items if table_exists?(:items)
end
end
+22
View File
@@ -0,0 +1,22 @@
#The MIT License (MIT)
#
#Copyright (c) 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:
#
#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.
# Item name and SKU (skipped where redmine_qbo_lineitems already added them)
class AddItemNameAndSku < ActiveRecord::Migration[7.0]
def up
add_column :items, :name, :string, null: false unless column_exists?(:items, :name)
add_column :items, :sku, :string unless column_exists?(:items, :sku)
end
def down
remove_column :items, :sku if column_exists?(:items, :sku)
remove_column :items, :name if column_exists?(:items, :name)
end
end
+37
View File
@@ -0,0 +1,37 @@
#The MIT License (MIT)
#
#Copyright (c) 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:
#
#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.
# QuickBooks income accounts, and each item's account, type and taxable flag
# (skipped where redmine_qbo_lineitems already created them)
class CreateAccountsTable < ActiveRecord::Migration[7.0]
def up
unless table_exists?(:accounts)
create_table :accounts do |t|
t.text :name, null: false
t.text :description
t.boolean :active, default: true, null: false
t.boolean :default, default: false, null: false
t.text :classification
t.timestamps
end
end
add_reference :items, :account, foreign_key: true unless column_exists?(:items, :account_id)
add_column :items, :type, :string unless column_exists?(:items, :type)
add_column :items, :taxable, :boolean, null: true unless column_exists?(:items, :taxable)
end
def down
remove_column :items, :taxable if column_exists?(:items, :taxable)
remove_column :items, :type if column_exists?(:items, :type)
remove_reference :items, :account, foreign_key: true if column_exists?(:items, :account_id)
drop_table :accounts if table_exists?(:accounts)
end
end
@@ -0,0 +1,46 @@
#The MIT License (MIT)
#
#Copyright (c) 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:
#
#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.
# Records which issue was created from which QuickBooks estimate line, so a line can't be turned into an
# issue twice. Issues redmine_qbo_calendar created from appointment estimates are copied in, so they still
# count as created.
class CreateQboEstimateLineIssues < ActiveRecord::Migration[7.0]
class LineIssue < ActiveRecord::Base
self.table_name = 'qbo_estimate_line_issues'
end
def up
unless table_exists?(:qbo_estimate_line_issues)
create_table :qbo_estimate_line_issues do |t|
t.bigint :estimate_id, null: false
t.string :line_id, null: false
t.references :issue, null: false, index: { unique: true }
t.datetime :created_on, null: false
end
add_index :qbo_estimate_line_issues, [:estimate_id, :line_id], unique: true, name: 'index_qbo_estimate_line_issues_on_line'
end
return unless table_exists?(:appointment_estimate_issues)
LineIssue.reset_column_information
existing_issue_ids = select_values('SELECT id FROM issues').map(&:to_i).to_set
select_all('SELECT estimate_id, line_id, issue_id, created_on FROM appointment_estimate_issues').each do |row|
next unless existing_issue_ids.include?(row['issue_id'].to_i)
next if LineIssue.exists?(estimate_id: row['estimate_id'], line_id: row['line_id']) || LineIssue.exists?(issue_id: row['issue_id'])
LineIssue.create!(estimate_id: row['estimate_id'], line_id: row['line_id'], issue_id: row['issue_id'],
created_on: row['created_on'] || Time.current)
end
end
def down
drop_table :qbo_estimate_line_issues if table_exists?(:qbo_estimate_line_issues)
end
end
+27 -13
View File
@@ -13,8 +13,8 @@ Redmine::Plugin.register :redmine_qbo do
# About # About
name 'Redmine QBO plugin' name 'Redmine QBO plugin'
author 'Rick Barrette' author 'Rick Barrette'
description 'A pluging for Redmine to connect with QuickBooks Online to create Time Activity Entries for billable hours logged when an Issue is closed' description 'A pluging for Redmine to connect with QuickBooks Online: customers, time activities for billable hours when an issue is closed, and estimates, invoices and payments written in Redmine'
version '2026.3.1' version '2026.11.1'
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'
@@ -30,12 +30,32 @@ Redmine::Plugin.register :redmine_qbo do
# set per_page globally # set per_page globally
WillPaginate.per_page = 20 WillPaginate.per_page = 20
# Permissions for security # Global Permissions
permission :view_customers, customers: :index, public: false # autocomplete and the filter_* actions feed the customer, estimate and invoice pickers on issue forms
permission :add_customers, customers: :new, public: false permission :view_customers, { customers: [:index, :show, :autocomplete,
:filter_estimates_by_customer, :filter_invoices_by_customer] }, global: true
permission :add_customers, { customers: [:new, :create] }, global: true
permission :edit_customers, { customers: [:edit, :update] }, global: true
permission :share_issues_with_customers, { customers: [:share] }, global: true
# Project permissions
permission :bill_issues, { qbo: [:bill] }
# Billing (global): estimates, invoices, payments, issues from estimates
# customer_info and items feed the customer details and product/service search on the estimate/invoice editor
permission :write_estimates, { qbo_estimates: [:new, :create, :edit, :update, :customer_info, :items] }, global: true
permission :send_estimates, { qbo_estimates: [:send_email] }, global: true
permission :create_estimate_issues, { qbo_estimates: [:issues_preview, :create_issues] }, global: true
permission :write_invoices, { qbo_invoices: [:new, :create, :edit, :update, :import_options],
qbo_estimates: [:customer_info, :items] }, global: true
permission :send_invoices, { qbo_invoices: [:send_email] }, global: true
permission :view_payments, { qbo_payments: [:index, :show, :pdf] }, global: true
permission :receive_payments, { qbo_payments: [:index, :new, :create, :show, :pdf, :open_invoices],
qbo_estimates: [:customer_info] }, global: true
# The product/service list, accounts and their syncs are admin-only (see ItemsController, AccountsController)
# Register top menu items # Register top menu items
menu :top_menu, :customers, { controller: :customers, action: :index }, caption: :label_customers, if: Proc.new {User.current.logged?} menu :top_menu, :customers, { controller: :customers, action: :index }, caption: :label_customers, if: Proc.new {User.current.allowed_to?(:view_customers, nil, global: true)}
Redmine::Search.map do |search| Redmine::Search.map do |search|
search.register :customers search.register :customers
@@ -43,10 +63,4 @@ Redmine::Plugin.register :redmine_qbo do
end end
# Dynamically load all Hooks & Patches recursively RedmineQbo.setup
base_dir = File.join(File.dirname(__FILE__), 'lib')
# '**' looks inside subdirectories, '*.rb' matches Ruby files
Dir.glob(File.join(base_dir, '**', '*.rb')).sort.each do |file|
require file
end
+67
View File
@@ -0,0 +1,67 @@
#The MIT License (MIT)
#
#Copyright (c) 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:
#
#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.
module RedmineQbo
def self.setup
# === Models ===
Issue.prepend RedmineQbo::Patches::IssuePatch
User.prepend RedmineQbo::Patches::UserPatch
# === Queries ===
IssueQuery.prepend RedmineQbo::Patches::QueryPatch
TimeEntryQuery.prepend RedmineQbo::Patches::TimeEntryQueryPatch
# === Controllers ===
RedmineQbo::Patches::IssuesControllerPatch.apply
RedmineQbo::Patches::AttachmentsControllerPatch.apply
# === Helpers / Exports ===
Redmine::Export::PDF::IssuesPdfHelper.prepend RedmineQbo::Patches::PdfPatch
# === Hooks ===
RedmineQbo::Hooks::IssuesHookListener
RedmineQbo::Hooks::UsersShowHookListener
RedmineQbo::Hooks::ViewHookListener
# === Billing: estimates, invoices, payments, items and accounts ===
RedmineQboBilling.setup
# If the SubtaskFieldCopier plugin is installed, register our fields
if defined?(SubtaskFieldCopier)
SubtaskFieldCopier.registered_fields << :customer
SubtaskFieldCopier.registered_fields << :estimate
# Ensure there are no duplicates in case of hot-reloads in development mode
SubtaskFieldCopier.registered_fields.uniq!
end
end
def self.settings
Setting.plugin_redmine_qbo
end
def self.oauth_consumer_key
settings[:oauth_consumer_key]
end
def self.oauth_consumer_secret
settings[:oauth_consumer_secret]
end
def self.sandbox_mode?
settings[:sandbox] ? true : false
end
def self.webhook_token_secret
settings[:webhook_token]
end
end
@@ -24,12 +24,11 @@ module RedmineQbo
# Customer Name Text Box with database backed autocomplete # Customer Name Text Box with database backed autocomplete
# onchange event will update the hidden customer_id field # onchange event will update the hidden customer_id field
search_customer = f.autocomplete_field :customer, search_customer = f.text_field :customer,
autocomplete_customer_name_customers_path, class: "customer-name",
selected: issue.customer, autocomplete: "off",
update_elements: { data: {
id: '#issue_customer_id', autocomplete_url: "/customers/autocomplete"
value: '#issue_customer'
} }
# We need to handle 3 cases for the onchange event of the customer name field: # We need to handle 3 cases for the onchange event of the customer name field:
@@ -47,7 +46,7 @@ module RedmineQbo
# This hidden field is used for the customer ID for the issue # This hidden field is used for the customer ID for the issue
# the onchange event will reload the issue form via ajax to update the available estimates # the onchange event will reload the issue form via ajax to update the available estimates
customer_id = f.hidden_field :customer_id, customer_id = f.hidden_field :customer_id,
id: "issue_customer_id", id: "customer_id",
onchange: js_path.html_safe onchange: js_path.html_safe
# Generate the drop down list of quickbooks estimates owned by the selected customer # Generate the drop down list of quickbooks estimates owned by the selected customer
Loaded 100 of 128 files, more files were not shown because too many files have changed in this diff. Show more