2026.3.9

Refactored models and services to use a base class

README.md

@@ -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 |
 | :--- | :--- |
@@ -17,85 +24,244 @@ The goal of this project is to allow Redmine to connect with QuickBooks Online t
 | Version 1.0.0+ | Redmine 4 |
 | 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.
+
+### Custom Field Synchronization
+
+Invoice custom fields can be mapped to Issue custom fields.
+
+Example use case:
+
+*   Mileage In/Out recorded in Redmine
+    
+*   Automatically synchronized to the QuickBooks invoice.
+    
+
+### Customer Synchronization
+
+Customer records are automatically updated in the local database when changes occur in QuickBooks.
+
+---
+
+## 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|: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
+Hook|process_invoice_custom_fields, { issue: issue, invoice: invoice }  | Used to process invoice custom fields
+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
+
+---
+
+# 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
 

app/controllers/estimate_controller.rb

@@ -65,7 +65,7 @@ class EstimateController < ApplicationController
 
   # Renders the estimate PDF or redirects with an error if rendering fails.
   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" )
   rescue StandardError => e
     log "PDF render failed for Estimate #{estimate&.id}: #{e.message}"

app/controllers/invoice_controller.rb

@@ -18,7 +18,7 @@ class InvoiceController < ApplicationController
     log "Processing request for #{request.original_url}"
 
     invoice_ids = Array(params[:invoice_ids] || params[:id])
-    pdf, ref = InvoicePdfService.new(qbo: QboConnectionService.current!).fetch_pdf(doc_ids: invoice_ids)
+    pdf, ref = PdfService.new(entity: Invoice).fetch_pdf(doc_ids: invoice_ids)
 
     send_data pdf, filename: "invoice #{ref}.pdf", disposition: :inline, type: "application/pdf"
 

app/controllers/qbo_controller.rb

@@ -46,9 +46,13 @@ class QboController < ApplicationController
     redirect_to issue || root_path, flash: { error: e.message }
   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
-    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) }
   end
 

app/jobs/bill_issue_time_job.rb

@@ -17,10 +17,8 @@ class BillIssueTimeJob < ActiveJob::Base
     issue = Issue.find(issue_id)
 
     log "Starting billing for issue ##{issue.id}"
-
     issue.with_lock do
       unbilled_entries = issue.time_entries.where(billed: [false, nil]).lock
-
       return if unbilled_entries.blank?
 
       totals = aggregate_hours(unbilled_entries)
@@ -28,8 +26,6 @@ class BillIssueTimeJob < ActiveJob::Base
       log "Aggregated hours for billing: #{totals.inspect}"
 
       qbo = QboConnectionService.current!
-      raise "No QBO configuration found" unless qbo
-
       qbo.perform_authenticated_request do |access_token|
         create_time_activities(issue, totals, access_token, qbo)
       end

app/jobs/customer_sync_job.rb

@@ -1,36 +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 CustomerSyncJob < ApplicationJob
-  queue_as :default
-  retry_on StandardError, wait: 5.minutes, attempts: 5
-
-  # Perform a full sync of all customers, or an incremental sync of only those updated since the last sync
-  def perform(full_sync: false, id: nil)
-    qbo = QboConnectionService.current!
-    raise "No QBO configuration found" unless qbo
-
-    log "Starting #{full_sync ? 'full' : 'incremental'} sync for customer ##{id || 'all'}..."
-
-    service = CustomerSyncService.new(qbo: qbo)
-
-    if id.present?
-      service.sync_by_id(id)
-    else
-      service.sync(full_sync: full_sync)
-    end
-  end
-
-  private
-
-  def log(msg)
-    Rails.logger.info "[CustomerSyncJob] #{msg}"
-  end
-end

app/jobs/employee_sync_job.rb

@@ -1,36 +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 EmployeeSyncJob < ApplicationJob
-  queue_as :default
-  retry_on StandardError, wait: 5.minutes, attempts: 5
-
-  # Performs a sync of employees from QuickBooks Online.
-  def perform(full_sync: false, id: nil)
-    qbo = QboConnectionService.current!
-    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
-
-  private
-
-  def log(msg)
-    Rails.logger.info "[EmployeeSyncJob] #{msg}"
-  end
-end

app/jobs/invoice_sync_job.rb

@@ -1,36 +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 InvoiceSyncJob < ApplicationJob
-  queue_as :default
-  retry_on StandardError, wait: 5.minutes, attempts: 5
-
-  # Performs a sync of invoices from QuickBooks Online.
-  def perform(full_sync: false, id: nil)
-    qbo = QboConnectionService.current!
-    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
-
-  private
-
-  def log(msg)
-    Rails.logger.info "[InvoiceSyncJob] #{msg}"
-  end
-end

app/jobs/qbo_sync_dispatcher.rb

@@ -11,14 +11,37 @@
 class QboSyncDispatcher
 
   SYNC_JOBS = [
-    CustomerSyncJob,
+    Customer,
-    EstimateSyncJob,
+    Estimate,
-    InvoiceSyncJob,
+    Invoice,
-    EmployeeSyncJob
+    Employee
   ].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
+
+  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
+        jobs.push context
+        log "Added additionals QBO Sync Job for #{context.to_s}"
+    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

app/jobs/qbo_sync_job.rb

@@ -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.
 
-class EstimateSyncJob < ApplicationJob
+class QboSyncJob < ApplicationJob
   queue_as :default
   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?
       service.sync_by_id(id)
     elsif doc_number.present?
-      service.sync_by_doc(doc_number)
+      service.sync_by_doc_number(doc_number)
     else
       service.sync(full_sync: full_sync)
     end
@@ -32,7 +31,8 @@ class EstimateSyncJob < ApplicationJob
 
   private
 
+  # Log messages with the entity type for better traceability
   def log(msg)
-    Rails.logger.info "[EstimateSyncJob] #{msg}"
+    Rails.logger.info "[#{@entity}SyncJob] #{msg}"
   end
 end

app/jobs/webhook_process_job.rb

@@ -43,7 +43,14 @@ class WebhookProcessJob < ActiveJob::Base
     name = entity['name']
     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
+        entities.push context
+        log "Added additional QBO entities: #{context}"
+    end
+    return unless entities.include?(name)
 
     model = name.safe_constantize
     return unless model

app/models/customer.rb

@@ -8,20 +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.
 
-class Customer < ActiveRecord::Base
+class Customer < QboBaseModel
 
   include Redmine::Acts::Searchable
   include Redmine::Acts::Event  
-  include Redmine::I18n
 
   has_many :issues
   has_many :invoices
   has_many :estimates
- 
+  validates_presence_of :name
-  validates_presence_of :id, :name
   before_validation :normalize_phone_numbers
-  
   self.primary_key = :id
+  qbo_sync push: true
   
   acts_as_searchable columns: %w[name phone_number mobile_phone_number ],
                      scope: ->(_context) { left_joins(:project) },
@@ -33,41 +31,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}"},
                 :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
   def email
-    details
+    return details&.email_address&.address
-    return @details&.email_address&.address
   end
   
   # Updates the customer's email address
   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
   
   # Customers are not bound by a project
@@ -76,35 +47,21 @@ class Customer < ActiveRecord::Base
     nil
   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
   def mobile_phone
-    details
+    return details&.mobile_phone&.free_form_number
-    return @details&.mobile_phone&.free_form_number
   end
   
   # Updates the custome's mobile phone number
   def mobile_phone=(n)
-    details
     pn = Quickbooks::Model::TelephoneNumber.new
     pn.free_form_number = n
-    @details.mobile_phone = pn
+    details.mobile_phone = pn
   end
 
   # Updates Both local DB name & QBO display_name
   def name=(s)
-    details
+    details.display_name = s
-    @details.display_name = s
     super
   end
 
@@ -116,27 +73,19 @@ class Customer < ActiveRecord::Base
 
   # Sets the notes for the customer
   def notes=(s)
-    details
+    details.notes = s
-    @details.notes = s
   end
 
   # returns the customer's primary phone
   def primary_phone
-    details
+    return details&.primary_phone&.free_form_number
-    return @details&.primary_phone&.free_form_number
   end
   
   # Updates the customer's primary phone number
   def primary_phone=(n)
-    details
     pn = Quickbooks::Model::TelephoneNumber.new
     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
 
   # Seach for customers by name or phone number
@@ -160,47 +109,10 @@ class Customer < ActiveRecord::Base
     ids.index_with { |id| id }
   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
   def to_s
     last4 = phone_number&.last(4)
     last4.present? ? "#{name} - #{last4}" : name.to_s
   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

app/models/employee.rb

@@ -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.
 
-class Employee < ActiveRecord::Base
+class Employee < QboBaseModel
-  
-  include Redmine::I18n
 
   has_many :users
   validates_presence_of :id, :name
-
   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

app/models/estimate.rb

@@ -8,45 +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.
 
-class Estimate < ActiveRecord::Base
+class Estimate < QboBaseModel
-  
-  include Redmine::I18n
 
   has_and_belongs_to_many :issues
   belongs_to :customer 
   validates_presence_of :doc_number, :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
 
   # returns a human readable string
   def to_s
     return self[:doc_number]
   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)
-    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

app/models/invoice.rb

@@ -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.
 
-class Invoice < ActiveRecord::Base
+class Invoice < QboBaseModel
-
-  include Redmine::I18n
 
   has_and_belongs_to_many :issues
   belongs_to :customer
-
   validates :id, presence: true, uniqueness: true
   validates :doc_number, :txn_date, presence: true
-
   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
   def to_s
     doc_number
   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

app/models/qbo.rb

@@ -15,6 +15,26 @@ class Qbo < ActiveRecord::Base
 
   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
   def self.update_time_stamp
     date = DateTime.now
@@ -24,13 +44,6 @@ class Qbo < ActiveRecord::Base
     qbo.save
   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
 
   # Logs a message with a QBO-specific prefix for easier identification in the logs.

app/models/qbo_base_model.rb

@@ -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

app/services/customer_service.rb

@@ -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.
 
-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 
 
-  # 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

app/services/customer_sync_service.rb

@@ -17,16 +17,13 @@ class CustomerSyncService < SyncServiceBase
     Customer
   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?
   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

app/services/employee_sync_service.rb

@@ -17,14 +17,11 @@ class EmployeeSyncService < SyncServiceBase
     Employee
   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?
   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

app/services/estimate_pdf_service.rb

@@ -1,16 +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 EstimatePdfService < PdfServiceBase
-
-  def self.model_class
-    Estimate
-  end
-
-end

app/services/estimate_sync_service.rb

@@ -10,6 +10,14 @@
 
 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
 
   # Specify the local model this service syncs
@@ -17,11 +25,7 @@ class EstimateSyncService < SyncServiceBase
     Estimate
   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

app/services/invoice_pdf_service.rb

@@ -1,16 +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 InvoicePdfService < PdfServiceBase
-
-  def self.model_class
-    Invoice
-  end
-
-end

app/services/invoice_push_service.rb

@@ -17,20 +17,11 @@ class InvoicePushService
   # 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)
-
+    remote = QboConnectionService.with_qbo_service(entity: Invoice) do |service|
-    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

app/services/invoice_sync_service.rb

@@ -17,19 +17,14 @@ class InvoiceSyncService < SyncServiceBase
     Invoice
   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
   def attach_documents(local, remote)
     InvoiceAttachmentService.new(local, remote).attach
   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

app/services/pdf_service.rb

@@ -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 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'
 
   # 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
 
   # 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:)
     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
-
       combined_pdf(service, doc_ids)
     end
   end

app/services/qbo_connection_service.rb

@@ -10,6 +10,11 @@
 
 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.
   def self.replace!(token:, refresh_token:, realm_id:)
     Qbo.transaction do
@@ -24,9 +29,14 @@ class QboConnectionService
     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

app/services/qbo_oauth_service.rb

@@ -10,7 +10,8 @@
 
 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.
+  # The URL includes necessary parameters such as response type, state, and scope.
   def self.authorization_url(callback_url:)
     client.auth_code.authorize_url(
       redirect_uri: callback_url,
@@ -20,7 +21,8 @@ class QboOauthService
     )
   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:)
     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 )

app/services/service_base.rb

@@ -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

app/services/sync_service_base.rb

@@ -12,10 +12,14 @@ class SyncServiceBase
   PAGE_SIZE = 1000
 
   # 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
+    @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
 
   # 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
   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
 
     log "#{@entity.name} sync complete"
   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)
     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)
       persist(remote)
     end
@@ -64,39 +59,152 @@ class SyncServiceBase
     # Override in subclasses if the entity has attachments (e.g. Invoice)
   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)
-  def destroy_remote?(remote)
+  def destroy_local?(remote)
     false
   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
   def log(msg)
     Rails.logger.info "[#{@entity.name}SyncService] #{msg}"
   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
   def persist(remote)
     local = @entity.find_or_initialize_by(id: remote.id)
     
-    if destroy_remote?(remote)
+    if destroy_local?(remote)
       if local.persisted?
         local.destroy
         log "Deleted #{@entity.name} #{remote.id}"
@@ -104,24 +212,30 @@ class SyncServiceBase
       return
     end
 
-    # Map remote attributes to local model fields, this should be implemented in subclasses
     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!
-      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)
     end
 
   rescue => e
-      log "Failed to sync #{@entity.name} #{remote.id}: #{e.message}"
+    log "Failed to sync #{@entity.name} #{remote.id}: #{e.message}"
   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)
-    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

app/views/customers/_search.html.erb

@@ -3,3 +3,4 @@
     <%= submit_tag t(:label_search) %>
 <% end %>
 <%= button_to t(:label_new_customer), new_customer_path, method: :get%>
+<%= button_to(t(:label_sync), qbo_sync_path, method: :get) if User.current.admin?%>

app/views/qbo/_settings.html.erb

@@ -66,12 +66,12 @@ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLI
 
      <tr>
         <th><%=t(:label_oauth_expires)%></th>
-        <td><%= QboConnectionService.current!&.oauth2_access_token_expires_at %>
+        <td><%= Qbo.oauth2_access_token_expires_at %>
       </tr>
       
       <tr>
         <th><%=t(:label_oauth2_refresh_token_expires_at)%></th>
-        <td><%= QboConnectionService.current!&.oauth2_refresh_token_expires_at %>
+        <td><%= Qbo.oauth2_refresh_token_expires_at %>
      </tr>
 
   </tbody>
@@ -107,5 +107,5 @@ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLI
     <br/>
     
     <div>
-        <b><%=t(:label_last_sync)%> </b> <%= Qbo.last_sync if Qbo.exists? %> <%= link_to t(:label_sync_now), qbo_sync_path %>
+        <b><%=t(:label_last_sync)%> </b> <%= Qbo.last_sync if Qbo.exists? %> <%= link_to t(:label_sync_now), qbo_sync_path(full_sync: true) %>
 </div>

init.rb

@@ -14,7 +14,7 @@ Redmine::Plugin.register :redmine_qbo do
   name 'Redmine QBO plugin'
   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'
-  version '2026.3.1'
+  version '2026.3.9'
   url 'https://github.com/rickbarrette/redmine_qbo'
   author_url 'https://barrettefabrication.com'
   settings default: {empty: true}, partial: 'qbo/settings'

lib/redmine_qbo/patches/pdf_patch.rb

@@ -260,7 +260,7 @@ module RedmineQbo
 
           # Check to see if there is an estimate attached, then combine them
           if issue.estimate
-            e_pdf, ref = EstimatePdfService.new(qbo: QboConnectionService.current!).fetch_pdf(doc_ids: [issue.estimate.id])
+            e_pdf, ref = PdfService.new(entity: Estimate).fetch_pdf(doc_ids: [issue.estimate.id])
             pdf = CombinePDF.parse(pdf.output, allow_optional_content: true)
             pdf << CombinePDF.parse(e_pdf)
             return pdf.to_pdf