Compare commits

..
17 Commits
Author SHA1 Message Date
ricky a1fb88e77c 2026.11.13 2026-11-04 10:07:54 -05:00
rickyandClaude Opus 5.5 0a7b2e34b8 Fix the settings page before QuickBooks is connected
The token expiry came back as "never synced" text, which the page treated as a
time, so it failed. It's now empty, shown as N/A.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-04 10:07:54 -05:00
rickyandClaude Opus 5.5 895733f534 Let admins hide QuickBooks custom fields from estimates and invoices
QuickBooks doesn't tell apps which custom fields are inactive, and a field stays on
its old estimates after it's turned off, so an inactive "Sales Rep old" kept showing
and was filled in with the sales person. The billing settings now list the fields
found, with a box to hide each; hidden fields are left out of the editor, the sales
person and other plugins' field lookups.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-04 10:07:54 -05:00
ricky fa1b4eed06 2026.11.12 2026-11-04 09:47:36 -05:00
rickyandClaude Opus 5.5 95e76a41fd Use QuickBooks' newer custom fields once estimates show them
QuickBooks keeps listing the legacy sales form fields (DefinitionIds 1-3) in the
preferences after a company moves to its newer custom fields, often renamed or inactive
(e.g. "Sales Rep old"). Once estimates show any newer field, only those are used.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-04 09:47:36 -05:00
ricky 92b2a18eb6 2026.11.11 2026-11-03 22:12:47 -05:00
rickyandClaude Opus 5.5 084df36061 Link the Customer column in issue lists to the customer
Only for users with View customers, who can open the customer page; others see
the name as plain text. CSV and PDF exports are unchanged.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-03 22:12:47 -05:00
rickyandClaude Opus 5.5 3b51625df4 Fix sorting and grouping time entries by Billed
The time entry Billed column sorted by time_entries.name, which doesn't exist, so
sorting or grouping by it failed. The issue list's Billed column is removed: issues
have no billed value, so showing or sorting it always failed.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-03 22:12:47 -05:00
ricky 7cfc8a370e 2026.11.10 2026-11-03 21:53:13 -05:00
rickyandClaude Opus 5.5 d2cdd798cd Show names in issue history, and record invoices the webhook attaches
The history showed the customer and estimate as id numbers. It now shows their names,
for existing entries too. When the QuickBooks webhook attaches an invoice to an issue,
the issue's history gets "Invoice 1042 added", linking to the invoice PDF.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-03 21:53:13 -05:00
rickyandClaude Opus 5.5 159420fac1 Show estimate, invoice and payment activity on the activity page
Each type appears only on the overall activity page, and only for users who may see it:
estimates need View customers or Write estimates, invoices View customers or Write invoices,
and payments View or Receive payments.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-03 21:53:13 -05:00
rickyandClaude Opus 5.5 dbee228cdf 2026.11.9
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-02 22:22:51 -05:00
rickyandClaude Opus 5.5 ec00684edd Clear all lines asks in redmine_dark_mode's dialog when it's installed
On dark pages the confirmation is dark instead of the browser's bright box; without redmine_dark_mode
it's the browser's box as before.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-02 22:22:51 -05:00
rickyandClaude Opus 5.5 839ac976e6 2026.11.8
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-02 21:52:41 -05:00
rickyandClaude Opus 5.5 dc72b11766 Business report charts take their colours from the page
The grid lines and labels read --qbo-chart-grid and --qbo-chart-text (Chart.js' own colours when
unset), and recolour on redmine_dark_mode's redmine:color-scheme event, so the charts get lighter
grid lines in dark mode.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-02 21:52:41 -05:00
rickyandClaude Opus 5.5 778111825b 2026.11.7
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-02 17:56:49 -05:00
rickyandClaude Opus 5.5 4ba96e2dfd Warn about the customer's open issues on a new invoice
A new invoice lists the customer's open issues (any project, those the user can see) in a warning under
the title, so work orders aren't left open once the work is billed. It's there when the page opens with a
customer (from the customer page or an estimate) and follows the customer when it's changed: customer_info
returns open_issues_html for invoices.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-02 17:55:14 -05:00
23 changed files with 434 additions and 15 deletions

No files matched your search

+7 -1
View File
@@ -116,13 +116,19 @@ class QboEstimatesController < ApplicationController
customer = Customer.find_by(id: params[:customer_id])
return render(json: {}, status: :not_found) unless customer
render json: {
info = {
id: customer.id,
name: customer.name,
email: RedmineQboBilling::EstimateWriter.customer_email(customer),
billing_address: RedmineQboBilling::EstimateWriter.customer_address(customer),
field_options: RedmineQboBilling.field_options(customer)
}
# A new invoice warns about the customer's open issues
if params[:document] == 'invoice'
info[:open_issues_html] = render_to_string(partial: 'qbo_invoices/open_issues', formats: [:html],
locals: { customer: customer })
end
render json: info
end
# Product/service search for the line table (the QuickBooks item list)
+71
View File
@@ -0,0 +1,71 @@
#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.
# Estimates, invoices and payments on Redmine's activity page. They come from QuickBooks and belong to no
# project, so they show on the overall activity page only (not a project's, nor a user's), and each kind only to
# users with one of its global permissions.
module QboActivity
extend ActiveSupport::Concern
class_methods do
# event_type: the activity type registered in init.rb (e.g. 'qbo_estimates'); icon: the event's CSS class
# and icon in this plugin's sprite (assets/images/icons.svg); permissions: any one of these shows it
def qbo_activity(event_type, icon:, permissions:, title:, description:, url:)
# These models can load before Redmine adds acts_as_event to every model
include Redmine::Acts::Event unless respond_to?(:acts_as_event)
acts_as_event title: title, description: description, url: url, type: icon,
datetime: :activity_datetime, author: nil
class_attribute :qbo_activity_permissions, instance_writer: false, default: permissions
class_attribute :qbo_activity_event_type, instance_writer: false, default: event_type
end
def qbo_activity_visible_to?(user)
qbo_activity_permissions.any? { |permission| user.allowed_to?(permission, nil, global: true) }
end
# What Redmine::Activity::Fetcher reads for a project's activity page; these never show there
def activity_provider_options
{ qbo_activity_event_type => { permission: qbo_activity_permissions.first } }
end
# Documents dated from..to (the page's days, to not included), newest first. From the QuickBooks date, so
# a sync bringing in old documents doesn't pile them onto the day it ran.
def find_events(event_type, user, from, to, options)
return [] if options[:project] || options[:author] || !qbo_activity_visible_to?(user)
scope = includes(:customer).where.not(txn_date: nil)
scope = scope.where('txn_date >= ?', from.to_date) if from
scope = scope.where('txn_date < ?', to.to_date) if to
scope = scope.order(txn_date: :desc, id: :desc).limit(options[:limit]) if options[:limit]
scope.to_a
end
end
# When it happened: the time it reached Redmine when that was its QuickBooks date (created or changed in
# QuickBooks and sent by the webhook moments later), else midday on its QuickBooks date (e.g. a full sync)
def activity_datetime
return created_at if created_at && created_at.getlocal.to_date == txn_date
Time.local(txn_date.year, txn_date.month, txn_date.day, 12)
end
# Activity events have a project; these don't
def project
nil
end
def activity_money(amount)
ActiveSupport::NumberHelper.number_to_currency(amount) if amount
end
def activity_customer
customer&.name.presence || I18n.t(:label_none)
end
end
+6
View File
@@ -17,6 +17,12 @@ class Estimate < QboBaseModel
self.primary_key = :id
qbo_sync push: false
include QboActivity
qbo_activity 'qbo_estimates', icon: 'qbo-estimate', permissions: %i[view_customers write_estimates],
title: ->(e) { I18n.t(:label_activity_estimate, number: e.doc_number, customer: e.activity_customer) },
description: ->(e) { [e.activity_money(e[:total_amount]), e[:txn_status]].compact.join(' · ') },
url: ->(e) { { controller: 'estimates', action: 'show', id: e.id } }
def name
to_s
end
+15
View File
@@ -17,11 +17,26 @@ class Invoice < QboBaseModel
self.primary_key = :id
qbo_sync push: false
include QboActivity
qbo_activity 'qbo_invoices', icon: 'qbo-invoice', permissions: %i[view_customers write_invoices],
title: ->(i) { I18n.t(:label_activity_invoice, number: i.doc_number, customer: i.activity_customer) },
description: ->(i) { i.activity_description },
url: ->(i) { { controller: 'invoices', action: 'show', id: i.id } }
# Return the invoice's document number as its string representation
def to_s
doc_number
end
# Amount and where it stands, e.g. "$1,250.00 · Partially paid ($400.00 owed)"
def activity_description
state = status
owed = activity_money(self[:balance]) if state && self[:balance].to_d.positive?
[activity_money(self[:total_amount]),
(I18n.t(:"label_invoice_status_#{state}", default: state.to_s.humanize) if state),
(I18n.t(:text_activity_invoice_owed, amount: owed) if owed && state != :open && state != :overdue)].compact.join(' · ')
end
# Paid, partially paid, overdue, open or voided, from the cached total, balance and due date
# (RedmineQboBilling::InvoiceStatus); nil when the balance isn't cached
def status(today: User.current.today)
+13
View File
@@ -18,6 +18,19 @@ class Payment < QboBaseModel
self.primary_key = :id
qbo_sync push: false
include QboActivity
qbo_activity 'qbo_payments', icon: 'qbo-payment', permissions: %i[view_payments receive_payments],
title: ->(p) { I18n.t(:label_activity_payment, customer: p.activity_customer, amount: p.activity_money(p.total_amount)) },
description: ->(p) { p.activity_description },
url: ->(p) { { controller: 'qbo_payments', action: 'show', id: p.id } }
# Money not yet applied to an invoice, when there is some
def activity_description
return '' unless unapplied_amount.to_d.positive?
I18n.t(:text_activity_payment_unapplied, amount: activity_money(unapplied_amount))
end
def to_s
"#{txn_date} #{total_amount}"
end
+3 -2
View File
@@ -23,16 +23,17 @@ class Qbo < ActiveRecord::Base
return I18n.t(:label_qbo_never_synced)
end
# Token expiry times, or nil when QuickBooks isn't connected (the settings page shows N/A)
def self.oauth2_access_token_expires_at
QboConnectionService.current!.oauth2_access_token_expires_at
rescue
return I18n.t(:label_qbo_never_synced)
nil
end
def self.oauth2_refresh_token_expires_at
QboConnectionService.current!.oauth2_refresh_token_expires_at
rescue
return I18n.t(:label_qbo_never_synced)
nil
end
# Updates last sync time stamp
@@ -27,6 +27,7 @@ class InvoiceAttachmentService
unless issue.invoices.exists?(@invoice.id)
issue.invoices << @invoice
issue.save! if issue.changed?
journalize(issue)
log "Attached invoice ##{@invoice.id} to issue ##{issue.id}"
end
end
@@ -34,6 +35,18 @@ class InvoiceAttachmentService
private
# Records the new invoice in the issue's history (shown by RedmineQbo::Patches::IssuesHelperPatch).
# The webhook has no Redmine user, so the entry is by Anonymous. Saving the journal also sends
# Redmine's usual issue-updated emails.
def journalize(issue)
journal = Journal.new(journalized: issue, user: User.anonymous, notes: '')
journal.details << JournalDetail.new(property: 'invoice', prop_key: @invoice.id.to_s, value: @invoice.to_s.presence || @invoice.id.to_s)
journal.save
rescue => e
# The invoice is attached either way; a missing history entry shouldn't fail the sync
log "Couldn't add invoice ##{@invoice.id} to the history of issue ##{issue.id}: #{e.message}"
end
# Extract issue IDs from the invoice's private note and line descriptions
def extract_issue_ids
ids = []
+30
View File
@@ -16,6 +16,36 @@
multiple: true, size: 8, id: 'settings_labor_item_ids' %>
<em class="info"><%= l(:text_labor_items) %></em>
</p>
<%# QuickBooks custom fields to leave out of estimates and invoices (see RedmineQboBilling::Company). Hidden
fields that aren't found right now (e.g. no recent estimate has them) are kept as hidden. %>
<% company = RedmineQboBilling::Company %>
<% qbo_fields = company.all_custom_fields %>
<% hidden_ids = company.hidden_field_ids %>
<% sales_field = company.sales_person_field %>
<p class="qbo-custom-fields-setting">
<label><%= l(:label_qbo_hidden_custom_fields) %></label>
<%= hidden_field_tag 'settings[hidden_custom_field_ids][]', '', id: nil %>
<% (hidden_ids - qbo_fields.map { |f| f.id.to_i }).each do |id| %>
<%= hidden_field_tag 'settings[hidden_custom_field_ids][]', id, id: nil %>
<% end %>
<% if qbo_fields.empty? %>
<%= l(:label_none) %>
<% else %>
<% qbo_fields.each do |field| %>
<label class="block">
<%= check_box_tag 'settings[hidden_custom_field_ids][]', field.id, hidden_ids.include?(field.id.to_i),
id: "settings_hidden_custom_field_#{field.id}" %>
<%= field.name %>
<% if sales_field && sales_field.id.to_i == field.id.to_i %>
<em>(<%= l(:text_qbo_sales_person_field) %>)</em>
<% end %>
</label>
<% end %>
<% end %>
<%= 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_qbo_hidden_custom_fields) %></em>
</p>
</div>
<% issue_builder = RedmineQboBilling::EstimateIssueBuilder %>
+15 -5
View File
@@ -415,10 +415,18 @@ $(function () {
});
$('#qbo-estimate-clear-lines').on('click', function () {
if (!window.confirm($(this).data('confirmText'))) return;
rows().remove();
addRow(); addRow();
changed();
function clearLines() {
rows().remove();
addRow(); addRow();
changed();
}
// redmine_dark_mode asks in a dark dialog on dark pages; otherwise the browser's own box
var message = $(this).data('confirmText');
if (window.RedmineDarkMode && window.RedmineDarkMode.confirm) {
window.RedmineDarkMode.confirm(message, clearLines);
} else if (window.confirm(message)) {
clearLines();
}
});
// Drag lines by the handle to reorder them; they're saved in table order
@@ -446,7 +454,9 @@ $(function () {
var id = $(this).val();
if (!id) return;
dirty = true;
$.getJSON($form.data('customerInfoUrl'), { customer_id: id }).done(function (info) {
$.getJSON($form.data('customerInfoUrl'), { customer_id: id, document: $form.data('document') }).done(function (info) {
// A new invoice's open issues notice follows the customer
if (info.open_issues_html !== undefined) $('#qbo-open-issues').replaceWith(info.open_issues_html);
// 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 || '';
@@ -0,0 +1,17 @@
<%# A new invoice's customer still has open issues (work orders), so they're not left behind once billed.
Replaced when the customer is changed (customer_info's open_issues_html). %>
<%
issues = customer ? customer.issues.open.visible.order(id: :desc).to_a : []
%>
<div id="qbo-open-issues">
<% if issues.any? %>
<div class="warning qbo-estimate-notice">
<%= l(:text_invoice_customer_open_issues, count: issues.size) %>
<ul>
<% issues.each do |issue| %>
<li><%= link_to_issue(issue, truncate: 60) %> (<%= issue.status %>)</li>
<% end %>
</ul>
</div>
<% end %>
</div>
+1
View File
@@ -1,4 +1,5 @@
<% html_title l(:label_new_invoice) %>
<%= render partial: 'qbo_estimates/header', locals: { form: @form } %>
<%= render partial: 'qbo_invoices/open_issues', locals: { customer: (Customer.find_by(id: @form.customer_id) if @form.customer_id.present?) } %>
<%= render partial: 'qbo_estimates/form', locals: { form: @form } %>
+27 -1
View File
@@ -289,9 +289,28 @@
return 'rgba(' + (n >> 16 & 255) + ',' + (n >> 8 & 255) + ',' + (n & 255) + ',0.45)';
}
// Grid lines and text from the page's colours, so a dark mode (e.g. redmine_dark_mode) can set
// --qbo-chart-grid and --qbo-chart-text; Chart.js' own colours otherwise
function chartColors() {
var style = getComputedStyle(document.documentElement);
return { grid: style.getPropertyValue('--qbo-chart-grid').trim() || 'rgba(0,0,0,0.1)',
text: style.getPropertyValue('--qbo-chart-text').trim() || '#666' };
}
function applyColors(chart) {
var c = chartColors();
['x', 'y'].forEach(function(axis) {
var scale = chart.options.scales[axis];
scale.grid.color = c.grid;
scale.border.color = c.grid;
scale.ticks.color = c.text;
});
chart.options.plugins.legend.labels.color = c.text;
}
function draw(Chart, canvas, compare) {
var series = JSON.parse(canvas.getAttribute('data-series'));
var isMoney = canvas.getAttribute('data-kind') === 'money';
var colors = chartColors();
var datasets = [];
series.forEach(function(s) {
datasets.push({ label: s.label, data: s.current, borderColor: s.color, backgroundColor: s.color,
@@ -317,6 +336,7 @@
position: 'bottom',
labels: {
boxWidth: 12,
color: colors.text,
generateLabels: function(chart) {
var items = Chart.defaults.plugins.legend.labels.generateLabels(chart).filter(function(item) {
return !chart.data.datasets[item.datasetIndex].previous;
@@ -355,7 +375,9 @@
}
},
scales: {
y: { beginAtZero: true, ticks: { precision: isMoney ? 0 : 1, callback: function(v) { return isMoney ? money(v, 0) : v; } } }
x: { grid: { color: colors.grid }, border: { color: colors.grid }, ticks: { color: colors.text } },
y: { beginAtZero: true, grid: { color: colors.grid }, border: { color: colors.grid },
ticks: { color: colors.text, precision: isMoney ? 0 : 1, callback: function(v) { return isMoney ? money(v, 0) : v; } } }
}
}
});
@@ -406,6 +428,10 @@
$('.qbo-report-chart').hide();
});
$compare.on('change', function() { setCompare(this.checked); });
// Switching between light and dark (redmine_dark_mode) recolours the charts
document.addEventListener('redmine:color-scheme', function() {
charts.forEach(function(chart) { applyColors(chart); chart.update('none'); });
});
});
})();
<% end %>
+26
View File
@@ -0,0 +1,26 @@
<?xml version="1.0"?>
<!-- Activity icons (Tabler outline icons, MIT), in the layout of Redmine's own sprite -->
<svg xmlns="http://www.w3.org/2000/svg" class="icon--sprite">
<defs>
<symbol viewBox="0 0 24 24" stroke-linecap="round" stroke-linejoin="round" id="icon--qbo-estimate">
<path d="M9 5h-2a2 2 0 0 0 -2 2v12a2 2 0 0 0 2 2h10a2 2 0 0 0 2 -2v-12a2 2 0 0 0 -2 -2h-2"/>
<path d="M9 5a2 2 0 0 1 2 -2h2a2 2 0 0 1 2 2a2 2 0 0 1 -2 2h-2a2 2 0 0 1 -2 -2z"/>
<path d="M9 12h.01"/>
<path d="M13 12h2"/>
<path d="M9 16h.01"/>
<path d="M13 16h2"/>
</symbol>
<symbol viewBox="0 0 24 24" stroke-linecap="round" stroke-linejoin="round" id="icon--qbo-invoice">
<path d="M14 3v4a1 1 0 0 0 1 1h4"/>
<path d="M17 21h-10a2 2 0 0 1 -2 -2v-14a2 2 0 0 1 2 -2h7l5 5v11a2 2 0 0 1 -2 2z"/>
<path d="M9 7h1"/>
<path d="M9 13h6"/>
<path d="M13 17h2"/>
</symbol>
<symbol viewBox="0 0 24 24" stroke-linecap="round" stroke-linejoin="round" id="icon--qbo-payment">
<path d="M7 11a2 2 0 0 1 2 -2h10a2 2 0 0 1 2 2v6a2 2 0 0 1 -2 2h-10a2 2 0 0 1 -2 -2z"/>
<path d="M12 14a2 2 0 1 0 4 0a2 2 0 1 0 -4 0"/>
<path d="M17 9v-2a2 2 0 0 0 -2 -2h-10a2 2 0 0 0 -2 2v6a2 2 0 0 0 2 2h2"/>
</symbol>
</defs>
</svg>

After

Width:  |  Height:  |  Size: 1.3 KiB

+5
View File
@@ -12,3 +12,8 @@
margin: -4px 0 10px;
padding-left: 0;
}
/* Estimates, invoices and payments on the activity page belong to no project: no " - " after an empty name */
div#activity span.project:empty:after {
content: none;
}
+16
View File
@@ -129,6 +129,9 @@ en:
button_email_estimate: "Email"
button_open_in_quickbooks: "Open in QuickBooks"
button_refresh_quickbooks_fields: "Refresh QuickBooks fields"
label_qbo_hidden_custom_fields: "Hide QuickBooks custom fields"
text_qbo_sales_person_field: "filled in with the sales person"
text_qbo_hidden_custom_fields: "Ticked fields are left off estimates and invoices. QuickBooks doesn't tell apps which custom fields are inactive, and a field stays on its old estimates after it's turned off, so tick ones you no longer use (e.g. a renamed \"Sales Rep old\"). The sales person goes in the first field shown whose name has \"sales\" or \"rep\" in it."
button_reload_estimate: "Reload the estimate"
button_save_and_send: "Save and send"
@@ -256,6 +259,9 @@ en:
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_customer_open_issues:
one: "This customer has an open issue. Make sure its work is finished and billed so it isn't left open:"
other: "This customer has %{count} open issues. Make sure their work is finished and billed so none are left open:"
text_line_bills_time: "Bills a QuickBooks time activity; saving marks the time as billed"
text_replace_lines: "Tick the lines the time replaces (e.g. the estimate's labor lines). Each time entry takes the place of the line with its issue's description (e.g. Install Lift Kit), then any others in order."
@@ -355,3 +361,13 @@ en:
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."
# Activity page
label_qbo_estimate_plural: "Estimates"
label_qbo_invoice_plural: "Invoices"
label_qbo_payment_plural: "Payments"
label_activity_estimate: "Estimate #%{number}: %{customer}"
label_activity_invoice: "Invoice #%{number}: %{customer}"
label_activity_payment: "Payment from %{customer}: %{amount}"
text_activity_invoice_owed: "%{amount} owed"
text_activity_payment_unapplied: "%{amount} not applied to an invoice"
+8 -1
View File
@@ -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: customers, time activities for billable hours when an issue is closed, and estimates, invoices and payments written in Redmine'
version '2026.11.6'
version '2026.11.13'
url 'https://github.com/rickbarrette/redmine_qbo'
author_url 'https://barrettefabrication.com'
settings default: {empty: true}, partial: 'qbo/settings'
@@ -52,6 +52,13 @@ Redmine::Plugin.register :redmine_qbo do
permission :view_business_reports, { qbo_reports: [:index] }, global: true
# The product/service list, accounts and their syncs are admin-only (see ItemsController, AccountsController)
# Estimates, invoices and payments on the activity page (QboActivity): the overall page only, for users with
# View customers or Write estimates / invoices, and View or Receive payments
# (plugin: picks their icons from this plugin's sprite, assets/images/icons.svg)
activity_provider :qbo_estimates, class_name: 'Estimate', plugin: :redmine_qbo
activity_provider :qbo_invoices, class_name: 'Invoice', plugin: :redmine_qbo
activity_provider :qbo_payments, class_name: 'Payment', plugin: :redmine_qbo
# Register top menu items
menu :top_menu, :customers, { controller: :customers, action: :index }, caption: :label_customers, if: Proc.new {User.current.allowed_to?(:view_customers, nil, global: true)}
menu :top_menu, :qbo_reports, { controller: :qbo_reports, action: :index }, caption: :label_business_report,
+5
View File
@@ -18,11 +18,16 @@ module RedmineQbo
IssueQuery.prepend RedmineQbo::Patches::QueryPatch
TimeEntryQuery.prepend RedmineQbo::Patches::TimeEntryQueryPatch
# === Activity: estimates, invoices and payments, for users who may see them ===
Redmine::Activity::Fetcher.prepend RedmineQbo::Patches::ActivityFetcherPatch
# === Controllers ===
RedmineQbo::Patches::IssuesControllerPatch.apply
RedmineQbo::Patches::AttachmentsControllerPatch.apply
# === Helpers / Exports ===
IssuesHelper.prepend RedmineQbo::Patches::IssuesHelperPatch
QueriesHelper.prepend RedmineQbo::Patches::QueriesHelperPatch
Redmine::Export::PDF::IssuesPdfHelper.prepend RedmineQbo::Patches::PdfPatch
# === Hooks ===
@@ -0,0 +1,29 @@
#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.
module RedmineQbo
module Patches
# The activity page lists every activity type for the whole site, and a project's page those its members may
# see. QuickBooks estimates, invoices and payments (QboActivity) belong to no project: they're kept to the
# overall page, and to users with one of their permissions, so nobody gets a checkbox for activity they can't see.
module ActivityFetcherPatch
def event_types
return @event_types if @qbo_activity_checked
@qbo_activity_checked = true
@event_types = super.select do |event_type|
providers = Redmine::Activity.providers[event_type].map(&:constantize)
qbo = providers.select { |provider| provider.respond_to?(:qbo_activity_visible_to?) }
qbo.empty? || (project.nil? && qbo.any? { |provider| provider.qbo_activity_visible_to?(user) })
end
end
end
end
end
@@ -0,0 +1,69 @@
#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
module Patches
# Shows the customer and estimate by name, and invoices attached by the QuickBooks webhook, in an
# issue's history, emails and PDF. Redmine records the customer and estimate by id, like its own
# fields, but only looks up names for the fields it knows about. The ids stay in the database, so
# existing history entries show names too.
module IssuesHelperPatch
JOURNAL_NAMED_FIELDS = { 'customer_id' => 'Customer', 'estimate_id' => 'Estimate' }.freeze
def show_detail(detail, no_html = false, options = {})
return qbo_invoice_detail(detail, no_html, options) if detail.property == 'invoice'
model = detail.property == 'attr' && JOURNAL_NAMED_FIELDS[detail.prop_key]
return super unless model
# Hand Redmine a copy with names in place of ids, so it formats it like any other change
named = JournalDetail.new(property: detail.property, prop_key: detail.prop_key,
old_value: qbo_journal_name(model, detail.old_value),
value: qbo_journal_name(model, detail.value))
named.id = detail.id
named.journal_id = detail.journal_id
super(named, no_html, options)
end
private
# "Invoice 1042 added", recorded when the QuickBooks webhook attaches an invoice to the issue
# (see InvoiceAttachmentService). The number links to the invoice PDF while the invoice exists.
def qbo_invoice_detail(detail, no_html, options)
label = l(:field_invoice)
value = detail.value
old_value = detail.old_value
unless no_html
label = content_tag('strong', label)
if value.present?
value = Invoice.exists?(detail.prop_key) ? link_to(value, invoice_url(detail.prop_key, only_path: options[:only_path] != false)) : content_tag('i', value)
end
old_value = content_tag('del', content_tag('i', old_value)) if old_value.present?
end
if detail.value.present?
l(:text_journal_added, label: label, value: value).html_safe
else
l(:text_journal_deleted, label: label, old: old_value).html_safe
end
end
# The record's name, or the id when it no longer exists. Cached for the request, since a
# history can mention the same customer many times.
def qbo_journal_name(model, id)
return id if id.blank?
@qbo_journal_names ||= {}
@qbo_journal_names[[model, id]] ||= model.constantize.find_by(id: id)&.to_s.presence || id
end
end
end
end
@@ -0,0 +1,31 @@
#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
module Patches
# Links the Customer column in issue lists to the customer's page, for users who may open it
# (View customers). Others see the name as plain text. CSV and PDF exports are unchanged.
module QueriesHelperPatch
def column_value(column, item, value)
return super unless column.name == :customer && value.is_a?(Customer) && qbo_can_view_customers?
link_to(value.to_s, customer_path(value))
end
private
def qbo_can_view_customers?
return @qbo_can_view_customers if defined?(@qbo_can_view_customers)
@qbo_can_view_customers = User.current.allowed_to?(:view_customers, nil, global: true)
end
end
end
end
-1
View File
@@ -32,7 +32,6 @@ module RedmineQbo
unless @available_columns
@available_columns = self.class.available_columns.dup
@available_columns << QueryColumn.new(:customer, sortable: "#{Issue.table_name}.customer_id", groupable: true, caption: :field_customer)
@available_columns << QueryColumn.new(:billed, sortable: "#{TimeEntry.table_name}.billed", groupable: true, caption: :field_billed)
end
super
end
@@ -17,7 +17,7 @@ module RedmineQbo
def available_columns
unless @available_columns
@available_columns = self.class.available_columns.dup
@available_columns << QueryColumn.new(:billed, sortable: "#{TimeEntry.table_name}.name", groupable: true, caption: :field_billed)
@available_columns << QueryColumn.new(:billed, sortable: "#{TimeEntry.table_name}.billed", groupable: "#{TimeEntry.table_name}.billed", caption: :field_billed)
end
super
end
+26 -3
View File
@@ -24,6 +24,8 @@ module RedmineQboBilling
MISSING_FIELD_CACHE_TIME = 5.minutes
# Recent estimates also show which custom fields exist, for companies whose preferences don't list them
RECENT_ESTIMATES = 20
# QuickBooks' legacy sales form custom fields; its newer custom fields have larger DefinitionIds
LEGACY_FIELD_IDS = (1..3).freeze
# The sales person field is found loosely, e.g. "Sales Person", "Salesperson", "Sales Rep"
SALES_PERSON_NAME = /sales|\brep\b/i
@@ -32,11 +34,26 @@ module RedmineQboBilling
module_function
# All enabled sales form custom fields, in QuickBooks' order
# The sales form custom fields the plugin uses, in QuickBooks' order: all those found, except the ones
# hidden in the plugin settings. Everything else (the editor, the sales person, other plugins' VIN and
# mileage) goes through here, so a hidden field is never shown or filled in.
def custom_fields
hidden = hidden_field_ids
all_custom_fields.reject { |f| hidden.include?(f.id.to_i) }
end
# Every custom field found, hidden ones included (listed on the plugin settings page)
def all_custom_fields
Array(settings[:custom_fields]).map { |f| Field.new(f[:id], f[:name]) }
end
# Fields hidden in the plugin settings. QuickBooks doesn't tell apps which custom fields are inactive,
# and a field stays on its old estimates after it's turned off (e.g. a renamed "Sales Rep old"), so the
# plugin can't leave those out by itself.
def hidden_field_ids
Array((Setting.plugin_redmine_qbo || {})['hidden_custom_field_ids']).map(&:to_i).reject(&:zero?)
end
# The first enabled custom field whose name matches, e.g. a plugin's VIN field (/\bvin\b/i), or nil
def custom_field_matching(pattern)
custom_fields.detect { |f| f.name.to_s =~ pattern }
@@ -105,9 +122,15 @@ module RedmineQboBilling
nil
end
# Fields named in the preferences come first; fields only seen on estimates are added after them.
# QuickBooks' newer custom fields (e.g. on Advanced and sandbox companies) may not be in the preferences.
# QuickBooks' newer custom fields (made under Settings > Custom fields) aren't in the preferences, which
# keep listing the legacy fields (DefinitionIds 1-3) after a company moves to the newer ones, often
# renamed or inactive (e.g. "Sales Rep old"). Once estimates show any newer field, those are the
# company's fields and the legacy ones are left out. Otherwise the legacy fields named in the
# preferences come first, then any only seen on estimates.
def merge_fields(from_preferences, from_estimates)
newer = from_estimates.reject { |f| LEGACY_FIELD_IDS.cover?(f[:id]) }
return newer if newer.any?
ids = from_preferences.map { |f| f[:id] }
from_preferences + from_estimates.reject { |f| ids.include?(f[:id]) }
end