Refunds for canceled orders and returned parts (SOP-OPS-014)

A Refund page on the customer: the canceled order's estimate fills in
the parts the 30% restocking fee is worked out on. Refunding makes the
fee invoice, pays it from the customer's credit, records the rest as a
Check (company check) or Expense (card refund on the terminal) with the
category Accounts Receivable, applies the credit to it so the balance
comes back to $0.00, and optionally marks the estimate Rejected,
cancels its work orders with the reason as a note and emails the
customer. Each refund has a page with a PDF of it.

New permission: Issue refunds. New settings under Billing » Refunds.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
This commit is contained in:
rickyandClaude Opus 5.5 committed 2026-11-16 20:43:36 -05:00
1 parent 16f9441568
commit 9fa199aa98
21 files changed
+1737

No files matched your search

+16
View File
@@ -140,6 +140,20 @@ Estimates and invoices keep their number, date, customer, total and **man-hours*
* The saved payment's page shows where it was applied and has **Print**, QuickBooks' payment PDF.
* **Payments** on the customer page lists all of the customer's payments from QuickBooks, newest first: date, method, reference no., the invoices each was applied to (or Deposit), memo, amount and what's still unapplied, with totals. Each date opens the payment's page and **Print** opens its PDF.
### Refunds
Refunds for canceled orders and returned parts, following SOP-OPS-014, so they don't have to be made in QuickBooks:
* **Refund** on the customer page. Pick the canceled order's estimate: its parts (the lines that aren't labor, including those in bundles, before tax) fill in the amount the restocking fee is worked out on, and can be changed (e.g. only some parts are returned). Labor carries no fee.
* Choose how the money goes back: **Company check** (with its number) or **Card** (a partial refund on the terminal). There are no cash refunds. The page shows the customer's credit, the fee and the exact amount to refund.
* **Refund** then, in QuickBooks:
1. makes the restocking fee invoice, its line showing the math ("Restocking fee: 30% × $307.99 parts on E1068 = $92.40"), and pays it from the customer's credit, oldest first (unless QuickBooks already applied the credit to it on its own);
2. records the rest of the credit as a refund with the category **Accounts Receivable**, from the bank account in the settings, described "Refund for deposit on E1068": a **Check** for a check, an **Expense** for a card refund;
3. applies the customer's remaining credit to that check or expense, so the deposit, the fee invoice and the refund reconcile, and reads back the customer's balance (it should be $0.00).
* As ticked on the page, it also marks the estimate **Rejected**, sets the order's work orders to the canceled status with the reason as a note, and emails the customer a summary (through redmine_qbo_reminders' mail settings when that plugin is set up, otherwise Redmine's).
* Each refund has its own page, listed on the customer page: what was refunded and how, with the fee invoice (opened in Redmine), a **PDF** of the refund (QuickBooks has no PDF of a check or an expense), the fee invoice's PDF, and **Email the customer** to send the summary again. If a QuickBooks step fails, the refund stops there and its page says which step and what was already done, to finish in QuickBooks.
* It refunds all of the customer's remaining credit held as unapplied payments. Credit held as credit memos isn't refunded here.
### Business report
**Business report** in the top menu compares, for a period (this or last week, month, quarter or year, or custom dates; weeks start on the day set in Redmine's *Start calendars on* setting, Monday when it follows the language):
@@ -192,11 +206,13 @@ Administration → Items lists the QuickBooks product/service list (synced from
* **View business reports**: the Business report
* **Write invoices**: create and edit invoices, and import time and estimates into them
* **Email invoices**: email invoices to customers
* **Issue refunds**: the Refund page, refunds and their PDFs
2. Settings (Administration -> Plugins -> Configure)
* **Estimates expire after (days)**: new estimates get an expiration date this many days after the estimate date (e.g. 30). Leave blank for none.
* **Labor products/services** (e.g. Labor): one list used three ways. An estimate's lines with them can become issues (their quantities are also the estimate's labor hours, which an appointment's hours can't be less than); an invoice's lines with them are offered under Replace these lines when time is imported; and their quantities are the hours on estimates and invoices in the business report. While none are chosen, products/services named Labor are used.
* **Issues from estimates**: the default project and the default tracker.
* **Refunds**: the restocking fee (SOP-OPS-014: 30%) and the product/service on its invoice (e.g. a "Restocking Fee" service, which sets the income account), the bank accounts refund checks and card refunds come out of (blank: the first bank account), and the status canceled work orders are set to (blank: a closed status named Canceled).
* Item and account counts, the default income account and their syncs are under Synchronization.
3. Writing an estimate
+108
View File
@@ -0,0 +1,108 @@
#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.
# Customer refunds (SOP-OPS-014): the Refund page for a customer with credit, and a refund once it's made
class QboRefundsController < ApplicationController
before_action :authorize_global
QBO_ERRORS = QboEstimatesController::QBO_ERRORS
def new
@customer = Customer.find_by(id: params[:customer_id])
return render_404 unless @customer
@form = RedmineQboBilling::RefundForm.new(customer_id: @customer.id.to_s, estimate_id: params[:estimate_id].to_s,
txn_date: User.current.today.iso8601, method: 'check',
close_estimate: '1', cancel_issues: '1', email_customer: '1')
@form.parts_amount = estimate_parts(@form.estimate_id)
load_page
end
def create
@form = RedmineQboBilling::RefundForm.from_params(params.require(:refund).permit(*RedmineQboBilling::RefundForm::ATTRIBUTES))
@customer = Customer.find_by(id: @form.customer_id)
return render_404 unless @customer
return show_form unless @form.valid?
refund = RedmineQboBilling::RefundWriter.refund!(@form)
if refund.done?
flash[:notice] = l(:notice_refund_done, amount: RedmineQboBilling::RefundWriter.money(refund.refund_amount))
else
flash[:error] = refund.message
end
redirect_to qbo_refund_path(refund)
rescue RedmineQboBilling::RefundWriter::Error, *QBO_ERRORS => e
@form.errors.add(:base, qbo_message(e))
show_form
end
def show
@refund = QboRefund.find_by(id: params[:id])
return render_404 unless @refund
@customer = @refund.customer
end
# The refund as a PDF, shown in the browser to print or save
def pdf
refund = QboRefund.find_by(id: params[:id])
return render_404 unless refund
document = RedmineQboBilling::RefundPdf.new(refund)
send_data document.render, type: 'application/pdf', disposition: 'inline', filename: document.filename
end
# Emails the customer the refund's summary (again, or after fixing their email in QuickBooks)
def email
refund = QboRefund.find_by(id: params[:id])
return render_404 unless refund&.done?
warning = RedmineQboBilling::RefundWriter.email_customer(refund, refund.customer, QboRefundMailer)
if warning
flash[:error] = warning
else
flash[:notice] = l(:notice_refund_emailed, email: refund.emailed_to)
end
redirect_to qbo_refund_path(refund)
end
private
# The estimate's parts (its lines that aren't labor), before tax, for the restocking fee
def estimate_parts(estimate_id)
return '' if estimate_id.blank?
estimate = RedmineQboBilling::RefundGateway.new.estimate(estimate_id)
estimate ? format('%.2f', RedmineQboBilling::RefundWriter.parts_amount(estimate)) : ''
rescue *QBO_ERRORS => e
flash.now[:error] = qbo_message(e)
''
end
def load_page
@estimates = RedmineQboBilling::RefundWriter.estimate_choices(@customer)
@preview = RedmineQboBilling::RefundWriter.preview(@customer, parts: @form.parts_value || BigDecimal('0'))
@statuses = IssueStatus.sorted.to_a
rescue *QBO_ERRORS => e
@preview = nil
flash.now[:error] = qbo_message(e)
end
def show_form
load_page
render :new, status: :unprocessable_entity
end
def qbo_message(error)
detail = error.respond_to?(:detail) ? error.detail.to_s : ''
message = error.message.to_s
detail.present? && !message.include?(detail) ? "#{message}: #{detail}" : message
end
end
+40
View File
@@ -0,0 +1,40 @@
#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.
# Emails a customer the summary of their refund (SOP-OPS-014). It goes out like redmine_qbo_reminders' appointment
# reminders when that plugin is installed (its From, Reply-To and SMTP server, e.g. the shop's sales mailbox);
# otherwise through Redmine's own email settings, from Redmine's emission address. Not Redmine's Mailer, which only
# writes to Redmine users and adds Redmine's headers and footer.
class QboRefundMailer < ActionMailer::Base
layout false
self.raise_delivery_errors = true
class DeliveryOff < StandardError; end
def refund_summary(refund, email)
@refund = refund
@customer = refund.customer
reminders = defined?(RedmineQboReminders::Settings) ? RedmineQboReminders::Settings.current : nil
@shop_name = reminders&.[]('shop_name').to_s.presence || Setting.app_title
delivery = reminders ? reminders.delivery_options : {}
if delivery.empty? && !ActionMailer::Base.perform_deliveries
raise DeliveryOff, I18n.t(:text_refund_email_off)
end
options = { to: email, from: reminders&.from.presence || Setting.mail_from.to_s,
subject: I18n.t(:text_refund_email_subject, shop: @shop_name, amount: RedmineQboBilling::RefundWriter.money(refund.refund_amount)) }
options[:reply_to] = reminders.reply_to if reminders&.reply_to
message = mail(options.merge(delivery)) do |format|
format.text
end
message.perform_deliveries = true unless delivery.empty?
message
end
end
+54
View File
@@ -0,0 +1,54 @@
#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.
# A customer refund (SOP-OPS-014), as it was made: the restocking fee, the refund, and each step's outcome
class QboRefund < ApplicationRecord
METHODS = %w[check card].freeze
STATUSES = %w[done incomplete].freeze
belongs_to :customer
belongs_to :user, optional: true
validates :customer_id, presence: true
validates :method, inclusion: { in: METHODS }
validates :status, inclusion: { in: STATUSES }
scope :recent, -> { order(created_at: :desc, id: :desc) }
def done?
status == 'done'
end
def check?
method == 'check'
end
def method_name
I18n.t("label_refund_method_#{method}")
end
def canceled_issue_ids
Array(JSON.parse(self[:canceled_issue_ids].presence || '[]')).map(&:to_i)
rescue JSON::ParserError
[]
end
def canceled_issue_ids=(ids)
self[:canceled_issue_ids] = Array(ids).map(&:to_i).uniq.to_json
end
# The QuickBooks screen for the refund check or expense
def purchase_url
return nil if purchase_id.blank?
page = check? ? 'check' : 'expense'
"https://#{RedmineQbo.sandbox_mode? ? 'sandbox' : 'app'}.qbo.intuit.com/app/#{page}?txnId=#{purchase_id}"
end
end
+24
View File
@@ -23,6 +23,9 @@
<% if RedmineQboBilling.payment_receiver? %>
<%= link_to sprite_icon('add', l(:button_receive_payment)), new_qbo_payment_path(customer_id: @customer.id), class: 'icon icon-add' %>
<% end %>
<% if RedmineQboBilling.refunder? %>
<%= link_to sprite_icon('arrow-narrow-left', l(:label_refund)), new_qbo_refund_path(customer_id: @customer.id), class: 'icon icon-arrow-narrow-left' %>
<% end %>
<% if User.current.allowed_to?(:edit_customers, nil, global: true) %>
<%= link_to sprite_icon('edit', l(:button_edit)), edit_customer_path(@customer),
class: 'icon icon-edit', accesskey: accesskey(:edit) %>
@@ -65,6 +68,27 @@
<%= render partial: 'qbo_drafts/list', locals: { drafts: customer_drafts, show_customer: false } %>
<% end %>
<%# Refunds made from Redmine (SOP-OPS-014) %>
<% if RedmineQboBilling.refunder? %>
<% customer_refunds = QboRefund.where(customer_id: @customer.id).recent.limit(10).to_a %>
<% if customer_refunds.any? %>
<h4><%= l(:label_refunds) %>:</h4>
<table class="list">
<tbody>
<% customer_refunds.each do |refund| %>
<tr>
<td><%= link_to format_date(refund.txn_date), qbo_refund_path(refund) %></td>
<td><%= refund.estimate_id.present? ? link_to("E#{refund.estimate_number}", RedmineQboBilling.writer? ? edit_qbo_estimate_path(refund.estimate_id) : estimate_path(refund.estimate_id)) : '' %></td>
<td><%= refund.method_name %></td>
<td style="text-align: right"><%= RedmineQboBilling::RefundWriter.money(refund.refund_amount) %></td>
<td><%= refund.done? ? '' : l(:label_refund_incomplete) %></td>
</tr>
<% end %>
</tbody>
</table>
<% end %>
<% end %>
</div>
<div class="splitcontentleft">
+37
View File
@@ -66,3 +66,40 @@
<em class="info"><%= l(:text_default_tracker_info) %></em>
</p>
</fieldset>
<%# Refunds (SOP-OPS-014): the restocking fee, and where the refund check or card refund is recorded %>
<% refunds = RedmineQboBilling::RefundWriter %>
<% accounts = Account.where(active: true).order(:name).pluck(:name, :id) %>
<fieldset class="box tabular">
<legend><%= l(:label_refund_settings) %></legend>
<p>
<label for="settings_restocking_fee_rate"><%= l(:label_restocking_fee_rate) %></label>
<%= number_field_tag 'settings[restocking_fee_rate]', refunds.plain(refunds.fee_rate), id: 'settings_restocking_fee_rate',
min: 0, max: 100, step: 0.01, style: 'width: 6em' %>%
<em class="info"><%= l(:text_restocking_fee_rate) %></em>
</p>
<p>
<label for="settings_restocking_item_id"><%= l(:label_restocking_item) %></label>
<%= select_tag 'settings[restocking_item_id]', options_from_collection_for_select(Item.sellable.order(:name), :id, :name, @settings['restocking_item_id']),
include_blank: true, id: 'settings_restocking_item_id' %>
<em class="info"><%= l(:text_restocking_item) %></em>
</p>
<p>
<label for="settings_refund_check_account_id"><%= l(:label_refund_check_account) %></label>
<%= select_tag 'settings[refund_check_account_id]', options_for_select(accounts, @settings['refund_check_account_id'].to_s),
include_blank: l(:label_refund_first_bank_account), id: 'settings_refund_check_account_id' %>
<em class="info"><%= l(:text_refund_check_account) %></em>
</p>
<p>
<label for="settings_refund_card_account_id"><%= l(:label_refund_card_account) %></label>
<%= select_tag 'settings[refund_card_account_id]', options_for_select(accounts, @settings['refund_card_account_id'].to_s),
include_blank: l(:label_refund_first_bank_account), id: 'settings_refund_card_account_id' %>
<em class="info"><%= l(:text_refund_card_account) %></em>
</p>
<p>
<label for="settings_refund_canceled_status_id"><%= l(:label_refund_canceled_status) %></label>
<%= select_tag 'settings[refund_canceled_status_id]', options_from_collection_for_select(IssueStatus.sorted, :id, :name, @settings['refund_canceled_status_id'].to_s),
include_blank: refunds.canceled_status ? "#{refunds.canceled_status.name} (#{l(:label_default)})" : true, id: 'settings_refund_canceled_status_id' %>
<em class="info"><%= l(:text_refund_canceled_status) %></em>
</p>
</fieldset>
@@ -0,0 +1,15 @@
<% money = ->(amount) { RedmineQboBilling::RefundWriter.money(amount) } -%>
<%= t(:text_refund_email_greeting, name: @customer&.name.to_s) %>
<%= t(:text_refund_email_intro, shop: @shop_name, order: @refund.estimate_number.present? ? "E#{@refund.estimate_number}" : t(:label_refund_your_order)) %>
<% if @refund.fee_amount.to_d.positive? -%>
<%= t(:label_refund_parts) %>: <%= money.(@refund.parts_amount) %>
<%= t(:label_refund_fee_rate, rate: RedmineQboBilling::RefundWriter.plain(@refund.fee_rate)) %>: <%= money.(@refund.fee_amount) %>
<% end -%>
<%= t(:label_refund_amount) %>: <%= money.(@refund.refund_amount) %>
<%= @refund.check? ? t(:text_refund_email_check, number: @refund.check_number) : t(:text_refund_email_card) %>
<%= t(:text_refund_email_terms) %>
<%= @shop_name %>
+122
View File
@@ -0,0 +1,122 @@
<%# Refund for a canceled order or returned parts (SOP-OPS-014) %>
<% html_title l(:label_refund) %>
<% money = ->(amount) { RedmineQboBilling::RefundWriter.money(amount) } %>
<% preview = @preview %>
<h2>
<%= link_to l(:label_customers), customers_path %> &#187;
<%= link_to @customer.name, customer_path(@customer) %> &#187;
<%= l(:label_refund) %>
</h2>
<%= error_messages_for @form %>
<p class="warning"><%= l(:text_refund_final_sale) %></p>
<% if preview && preview.credits.empty? %>
<p class="nodata"><%= l(:text_refund_no_credit) %></p>
<% end %>
<%# Picking the canceled order's estimate reloads the page with its parts filled in %>
<%= form_tag new_qbo_refund_path, method: :get, id: 'qbo-refund-estimate' do %>
<%= hidden_field_tag 'customer_id', @customer.id, id: nil %>
<div class="box tabular">
<p>
<label for="qbo_refund_estimate"><%= l(:label_refund_estimate) %></label>
<%= select_tag 'estimate_id', options_for_select(@estimates, @form.estimate_id), include_blank: l(:label_refund_no_estimate),
id: 'qbo_refund_estimate', onchange: 'this.form.submit()' %>
<noscript><%= submit_tag l(:button_apply), name: nil %></noscript>
<em class="info"><%= l(:text_refund_estimate) %></em>
</p>
</div>
<% end %>
<%= form_tag qbo_refunds_path, method: :post, id: 'qbo-refund-form' do %>
<%= hidden_field_tag 'refund[customer_id]', @customer.id, id: nil %>
<%= hidden_field_tag 'refund[estimate_id]', @form.estimate_id, id: nil %>
<div class="box tabular">
<p>
<label for="qbo_refund_parts"><%= l(:label_refund_parts) %></label>
$<%= text_field_tag 'refund[parts_amount]', @form.parts_amount, id: 'qbo_refund_parts', size: 12, inputmode: 'decimal',
autocomplete: 'off', data: { rate: preview&.fee_rate.to_s } %>
<em class="info"><%= l(:text_refund_parts, rate: RedmineQboBilling::RefundWriter.plain(preview&.fee_rate || RedmineQboBilling::RefundWriter.fee_rate)) %></em>
</p>
<p>
<label><%= l(:label_refund_method) %><span class="required"> *</span></label>
<label class="inline"><%= radio_button_tag 'refund[method]', 'check', @form.method == 'check', id: 'qbo_refund_method_check' %> <%= l(:label_refund_method_check) %></label>
<label class="inline"><%= radio_button_tag 'refund[method]', 'card', @form.method == 'card', id: 'qbo_refund_method_card' %> <%= l(:label_refund_method_card) %></label>
<em class="info"><%= l(:text_refund_method) %></em>
</p>
<p id="qbo-refund-check-number">
<label for="qbo_refund_check_number"><%= l(:label_refund_check_number) %><span class="required"> *</span></label>
<%= text_field_tag 'refund[check_number]', @form.check_number, id: 'qbo_refund_check_number', size: 12, maxlength: 21 %>
</p>
<p>
<label for="qbo_refund_date"><%= l(:label_refund_date) %><span class="required"> *</span></label>
<%= date_field_tag 'refund[txn_date]', @form.txn_date, id: 'qbo_refund_date' %>
</p>
<p>
<label for="qbo_refund_reason"><%= l(:label_refund_reason) %><span class="required"> *</span></label>
<%= text_area_tag 'refund[reason]', @form.reason, id: 'qbo_refund_reason', rows: 3, cols: 60, maxlength: 2000 %>
<em class="info"><%= l(:text_refund_reason) %></em>
</p>
<p>
<label><%= l(:label_refund_also) %></label>
<% [[:close_estimate, :label_refund_close_estimate], [:cancel_issues, :label_refund_cancel_issues], [:email_customer, :label_refund_email_customer]].each do |flag, label| %>
<% needs_estimate = flag != :email_customer %>
<label class="block">
<%= hidden_field_tag "refund[#{flag}]", '0', id: nil %>
<%= check_box_tag "refund[#{flag}]", '1', @form.send(:"#{flag}?") && (!needs_estimate || @form.estimate_id.present?),
id: "qbo_refund_#{flag}", disabled: needs_estimate && @form.estimate_id.blank? %>
<%= l(label) %>
</label>
<% end %>
<% if @customer.email.blank? %><em class="info"><%= l(:text_refund_no_email) %></em><% end %>
</p>
</div>
<% if preview %>
<fieldset class="box" id="qbo-refund-preview">
<legend><%= l(:label_refund_summary) %></legend>
<table class="list">
<thead><tr><th><%= l(:label_refund_credit_from) %></th><th><%= l(:label_payment_reference) %></th><th><%= l(:label_memo) %></th><th><%= l(:label_amount) %></th></tr></thead>
<tbody>
<% preview.credits.each do |credit| %>
<tr>
<td><%= link_to format_date(credit.date), qbo_payment_path(credit.payment_id) %></td>
<td><%= credit.reference %></td>
<td><%= credit.memo %></td>
<td style="text-align: right"><%= money.(credit.amount) %></td>
</tr>
<% end %>
</tbody>
<tfoot>
<tr><td colspan="3"><%= l(:label_refund_credit) %></td><td style="text-align: right" id="qbo-refund-credit" data-credit="<%= preview.credit_total.to_s('F') %>"><%= money.(preview.credit_total) %></td></tr>
<tr><td colspan="3"><%= l(:label_refund_fee_rate, rate: RedmineQboBilling::RefundWriter.plain(preview.fee_rate)) %></td><td style="text-align: right" id="qbo-refund-fee">-<%= money.(preview.fee) %></td></tr>
<tr><td colspan="3"><strong><%= l(:label_refund_amount) %></strong></td><td style="text-align: right"><strong id="qbo-refund-amount"><%= money.(preview.refund) %></strong></td></tr>
</tfoot>
</table>
<p><em class="info"><%= l(:text_refund_summary) %></em></p>
</fieldset>
<% end %>
<p><%= submit_tag l(:button_refund), data: { confirm: l(:text_refund_confirm) }, disabled: preview.nil? || preview.credits.empty? %></p>
<% end %>
<%= javascript_tag do %>
$(function() {
var money = function(n) { return '$' + n.toFixed(2).replace(/\B(?=(\d{3})+(?!\d))/g, ','); };
function update() {
var parts = parseFloat(($('#qbo_refund_parts').val() || '0').replace(/[$,\s]/g, '')) || 0;
var rate = parseFloat($('#qbo_refund_parts').data('rate')) || 0;
var credit = parseFloat($('#qbo-refund-credit').data('credit')) || 0;
var fee = Math.round(parts * rate) / 100;
$('#qbo-refund-fee').text('-' + money(fee));
$('#qbo-refund-amount').text(money(Math.max(credit - fee, 0)));
}
function method() { $('#qbo-refund-check-number').toggle($('#qbo_refund_method_check').is(':checked')); }
$('#qbo_refund_parts').on('input', update);
$('input[name="refund[method]"]').on('change', method);
update(); method();
});
<% end %>
+64
View File
@@ -0,0 +1,64 @@
<%# A refund as it was made (SOP-OPS-014) %>
<% html_title l(:label_refund) %>
<% money = ->(amount) { RedmineQboBilling::RefundWriter.money(amount) } %>
<h2>
<%= link_to l(:label_customers), customers_path %> &#187;
<% if @customer %><%= link_to @customer.name, customer_path(@customer) %> &#187;<% end %>
<%= l(:label_refund) %> <%= format_date(@refund.txn_date) %>
</h2>
<div class="contextual">
<%= link_to sprite_icon('application-pdf', 'PDF'), pdf_qbo_refund_path(@refund), class: 'icon icon-pdf', target: :_blank %>
<% if @refund.fee_invoice_id.present? %>
<%= link_to sprite_icon('application-pdf', l(:label_refund_fee_invoice_pdf)), invoice_path(@refund.fee_invoice_id), class: 'icon icon-pdf', target: :_blank %>
<% end %>
</div>
<% if @refund.done? %>
<p class="<%= @refund.balance_after.to_d.zero? ? 'notice flash' : 'warning' %>">
<%= @refund.balance_after.nil? ? l(:text_refund_balance_unknown) : l(:text_refund_balance, balance: money.(@refund.balance_after)) %>
</p>
<% else %>
<p class="conflict"><%= l(:text_refund_incomplete) %></p>
<% end %>
<% if @refund.message.present? %>
<div class="warning"><%= simple_format(h(@refund.message)) %></div>
<% end %>
<div class="box tabular">
<p><label><%= l(:label_refund_estimate) %></label> <%= @refund.estimate_id.present? ? link_to("E#{@refund.estimate_number}", RedmineQboBilling.writer? ? edit_qbo_estimate_path(@refund.estimate_id) : estimate_path(@refund.estimate_id)) : l(:label_refund_no_estimate) %></p>
<p><label><%= l(:label_refund_reason) %></label> <%= @refund.reason %></p>
<p><label><%= l(:label_refund_credit) %></label> <%= money.(@refund.credit_amount) %></p>
<p><label><%= l(:label_refund_parts) %></label> <%= money.(@refund.parts_amount) %></p>
<p>
<label><%= l(:label_refund_fee_rate, rate: RedmineQboBilling::RefundWriter.plain(@refund.fee_rate)) %></label>
<%= money.(@refund.fee_amount) %>
<% if @refund.fee_invoice_id.present? %>
· <%= link_to l(:label_refund_fee_invoice, number: @refund.fee_invoice_number), RedmineQboBilling.invoice_writer? ? edit_qbo_invoice_path(@refund.fee_invoice_id) : invoice_path(@refund.fee_invoice_id) %>
<% end %>
</p>
<p>
<label><%= l(:label_refund_amount) %></label>
<%= money.(@refund.refund_amount) %> · <%= @refund.method_name %><%= " ##{@refund.check_number}" if @refund.check? %>
<% if @refund.purchase_url %>
· <%= link_to l(@refund.check? ? :label_refund_open_check : :label_refund_open_expense), @refund.purchase_url, target: '_blank', rel: 'noopener' %>
<% end %>
</p>
<% if @refund.estimate_number.present? %>
<p><label><%= l(:label_refund_close_estimate) %></label> <%= checked_image @refund.estimate_closed? %></p>
<% end %>
<% if @refund.canceled_issue_ids.any? %>
<p><label><%= l(:label_refund_cancel_issues) %></label>
<%= safe_join(Issue.where(id: @refund.canceled_issue_ids).map { |issue| link_to_issue(issue, project: false) }, ', ') %></p>
<% end %>
<p>
<label><%= l(:label_refund_email_customer) %></label> <%= @refund.emailed_to.presence || '—' %>
<% if @refund.done? %>
· <%= link_to sprite_icon('email', l(@refund.emailed_to.present? ? :button_refund_email_again : :button_refund_email)),
email_qbo_refund_path(@refund), method: :post, class: 'icon icon-email',
data: { confirm: l(:text_refund_email_confirm) } %>
<% end %>
</p>
<p><label><%= l(:field_author) %></label> <%= @refund.user ? link_to_user(@refund.user) : '' %> <%= format_time(@refund.created_at) %></p>
</div>
+102
View File
@@ -422,3 +422,105 @@ en:
label_activity_payment: "Payment from %{customer}: %{amount}"
text_activity_invoice_owed: "%{amount} owed"
text_activity_payment_unapplied: "%{amount} not applied to an invoice"
# ---- Refunds (SOP-OPS-014) ----
permission_issue_refunds: "Issue refunds"
label_refund: "Refund"
label_refunds: "Refunds"
label_refund_incomplete: "Incomplete"
label_refund_estimate: "Canceled order"
label_refund_no_estimate: "None (customer credit only)"
label_refund_your_order: "your order"
label_refund_parts: "Parts"
label_refund_method: "Refund by"
label_refund_method_check: "Company check"
label_refund_method_card: "Card (on the terminal)"
label_refund_check_number: "Check no."
label_refund_date: "Refund date"
label_refund_reason: "Reason"
label_refund_also: "Also"
label_refund_close_estimate: "Mark the estimate Rejected in QuickBooks"
label_refund_cancel_issues: "Cancel the order's work orders"
label_refund_email_customer: "Email the customer a summary"
label_refund_summary: "Refund"
label_refund_credit_from: "Credit from payment"
label_refund_credit: "Customer credit"
label_refund_fee_rate: "Restocking fee (%{rate}% of parts)"
label_refund_amount: "Refund"
label_refund_fee_invoice: "Invoice #%{number}"
label_refund_open_check: "Check in QuickBooks"
label_refund_open_expense: "Expense in QuickBooks"
label_refund_settings: "Refunds"
label_refund_balance_after: "Customer balance afterwards"
label_refund_recorded_by: "Recorded by"
label_refund_received_by: "Received by (customer signature)"
label_refund_fee_invoice_pdf: "Fee invoice PDF"
label_refund_pdf_fee: "Restocking fee: %{rate}% × %{parts} parts"
label_refund_pdf_work_orders: "Work orders canceled"
label_refund_pdf_estimate: "Estimate"
text_refund_pdf_estimate_rejected: "E%{number} marked Rejected in QuickBooks"
label_restocking_fee_rate: "Restocking fee"
label_restocking_item: "Restocking fee product/service"
label_refund_check_account: "Refund checks from"
label_refund_card_account: "Card refunds from"
label_refund_first_bank_account: "The first bank account"
label_refund_canceled_status: "Canceled work order status"
button_refund: "Refund"
button_refund_email: "Email the customer"
button_refund_email_again: "Email again"
notice_refund_emailed: "Refund summary emailed to %{email}."
notice_refund_done: "Refund of %{amount} recorded in QuickBooks."
error_refund_method: "Choose how the refund is paid: company check or card."
error_refund_check_number: "Enter the check number."
error_refund_reason: "Enter the reason for the refund."
error_refund_parts_amount: "Parts must be an amount of $0.00 or more."
error_refund_estimate_customer: "That estimate is for another customer."
error_refund_no_fee_item: "Pick the restocking fee product/service in the QuickBooks plugin settings (Billing » Refunds)."
error_refund_no_credit: "This customer has no credit (unapplied payments) to refund."
error_refund_fee_over_credit: "The restocking fee (%{fee}) isn't less than the customer's credit (%{credit}), so there's nothing to refund."
error_refund_no_ar_account: "QuickBooks has no Accounts Receivable account."
error_refund_no_bank_account: "QuickBooks has no bank account to record the refund from. Pick one in the plugin settings."
error_refund_fee_not_saved: "QuickBooks didn't save the restocking fee invoice."
error_refund_fee_unpaid: "The customer's credit didn't cover the restocking fee invoice (%{amount} still open)."
error_refund_nothing_left: "No credit is left to refund after the restocking fee."
error_refund_not_saved: "QuickBooks didn't save the refund."
error_refund_step_fee: "The restocking fee invoice couldn't be made or paid from the customer's credit: %{error}. Nothing was refunded. Finish or undo it in QuickBooks."
error_refund_step_refund: "The refund couldn't be recorded in QuickBooks: %{error}. The restocking fee invoice (if any) is made. Record the refund in QuickBooks (Check or Expense, category Accounts Receivable) and apply the customer's credit to it."
text_refund_final_sale: "Custom fabricated assemblies and discontinued or closeout items are final sale. Don't refund them without Shop Manager approval (SOP-OPS-014). No cash refunds: card payments are refunded on the terminal, everything else by company check."
text_refund_no_credit: "This customer has no credit (unapplied payments) to refund."
text_refund_estimate: "The order being canceled. Its parts fill in the restocking fee, and the refund refers to it."
text_refund_parts: "The parts returned or canceled, before tax. The restocking fee is %{rate}% of this; labor carries no fee. Enter 0 to refund without a fee."
text_refund_method: "The way the order was paid: card payments are refunded on the card terminal (a partial refund, of the amount below); cash and check payments by company check."
text_refund_reason: "Goes on the refund in QuickBooks and on the canceled work orders."
text_refund_summary: "The restocking fee invoice is paid from the customer's credit, and the rest is refunded. Refund exactly this amount on the terminal or check."
text_refund_email_confirm: "Email the customer this refund's summary?"
text_refund_confirm: "Make the restocking fee invoice and record the refund in QuickBooks?"
text_refund_no_email: "The customer has no email in QuickBooks."
text_refund_balance: "Done. The customer's QuickBooks balance is now %{balance}."
text_refund_balance_unknown: "Done, but the customer's QuickBooks balance couldn't be read. Check it's $0.00 in QuickBooks."
text_refund_incomplete: "This refund is incomplete. See below which step failed, and finish it in QuickBooks."
text_refund_fee_line: "Restocking fee: %{rate}% × %{parts} parts%{on} = %{fee}"
text_refund_line: "Refund for deposit on E%{number}"
text_refund_line_credit: "Refund of customer credit"
text_refund_line_card: "(card refund on the terminal)"
text_refund_private_note: "Refund made in Redmine (SOP-OPS-014). Reason: %{reason}"
text_refund_issue_note: "Order canceled and refunded: %{reason}. Restocking fee %{fee}, refunded %{refund} by %{method}."
text_refund_issues_not_canceled: "Some work orders couldn't be set to canceled: %{issues}"
text_refund_no_canceled_status: "The work orders weren't canceled: pick the canceled status in the plugin settings."
text_refund_estimate_not_closed: "The estimate couldn't be marked Rejected in QuickBooks: %{error}"
text_refund_email_failed: "The customer wasn't emailed: %{error}"
text_refund_email_off: "Redmine's email delivery is turned off."
text_refund_email_subject: "Your refund from %{shop}: %{amount}"
text_refund_email_greeting: "Hello %{name},"
text_refund_email_intro: "We've processed the refund for %{order}."
text_refund_email_check: "It's being paid by company check (no. %{number})."
text_refund_email_card: "It's been refunded to the card you paid with. It can take a few business days to show on your statement."
text_refund_email_terms: "As in our posted terms, returned and canceled parts carry a restocking fee. Labor that wasn't done isn't charged."
text_restocking_fee_rate: "Of the parts returned or canceled (SOP-OPS-014: 30%)."
text_restocking_item: "The QuickBooks product/service on the restocking fee invoice (e.g. \"Restocking Fee\"). It sets the income account the fee is booked to."
text_refund_check_account: "The bank account refund checks are written from."
text_refund_card_account: "The account card refunds come out of (where card payments are deposited)."
text_refund_canceled_status: "Work orders of a canceled order are set to this status, with the reason as a note."
+8
View File
@@ -71,6 +71,14 @@ end
# Estimate and invoice drafts, kept in Redmine until they're saved to QuickBooks (continued on the editors)
resources :qbo_drafts, only: [:index, :destroy]
# Customer refunds (SOP-OPS-014): /qbo_refunds/new?customer_id=
resources :qbo_refunds, only: [:new, :create, :show] do
member do
get :pdf
post :email
end
end
# Receive payment pages, and a customer's payments (/qbo_payments?customer_id=)
resources :qbo_payments, only: [:index, :new, :create, :show, :edit, :update] do
member do
+55
View File
@@ -0,0 +1,55 @@
#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.
# Customer refunds (SOP-OPS-014): the restocking fee invoice, the refund check or card refund, and what was
# done in QuickBooks and Redmine, so a refund can be looked up (and finished by hand if a step failed)
class CreateQboRefunds < ActiveRecord::Migration[7.0]
def up
return if table_exists?(:qbo_refunds)
create_table :qbo_refunds do |t|
t.bigint :customer_id, null: false
# The canceled order's estimate, if any
t.bigint :estimate_id
t.string :estimate_number
t.integer :user_id
t.date :txn_date
# check or card
t.string :method, null: false, limit: 10
t.string :check_number
t.text :reason
t.decimal :parts_amount, precision: 15, scale: 2, null: false, default: 0
t.decimal :fee_rate, precision: 6, scale: 2, null: false, default: 0
t.decimal :fee_amount, precision: 15, scale: 2, null: false, default: 0
# The customer's credit before the refund, and what was refunded
t.decimal :credit_amount, precision: 15, scale: 2, null: false, default: 0
t.decimal :refund_amount, precision: 15, scale: 2, null: false, default: 0
# The QuickBooks fee invoice and the refund check or expense
t.string :fee_invoice_id
t.string :fee_invoice_number
t.string :purchase_id
# The customer's QuickBooks balance afterwards
t.decimal :balance_after, precision: 15, scale: 2
t.boolean :estimate_closed, null: false, default: false
# The work orders set to canceled (JSON list of issue ids)
t.text :canceled_issue_ids
t.string :emailed_to
# done, or incomplete (a step failed: message says which)
t.string :status, null: false, default: 'incomplete', limit: 20
t.text :message
t.timestamps
end
add_index :qbo_refunds, :customer_id
end
def down
drop_table :qbo_refunds if table_exists?(:qbo_refunds)
end
end
+2
View File
@@ -54,6 +54,8 @@ Redmine::Plugin.register :redmine_qbo do
permission :view_payments, { qbo_payments: [:index, :show, :pdf] }, global: true
permission :receive_payments, { qbo_payments: [:index, :new, :create, :show, :edit, :update, :pdf, :open_invoices],
qbo_estimates: [:customer_info] }, global: true
# Refunds for canceled orders and returned parts (SOP-OPS-014): restocking fee, refund check or card refund
permission :issue_refunds, { qbo_refunds: [:new, :create, :show, :pdf, :email] }, global: true
permission :view_business_reports, { qbo_reports: [:index] }, global: true
# The product/service list, accounts and their syncs are admin-only (see ItemsController, AccountsController)
+5
View File
@@ -83,6 +83,11 @@ module RedmineQboBilling
user.allowed_to?(:receive_payments, nil, global: true)
end
# True when the user may refund customers' credit (SOP-OPS-014)
def self.refunder?(user = User.current)
user.allowed_to?(:issue_refunds, nil, global: true)
end
# True when the user may see customer payments (receiving them includes seeing them)
def self.payment_viewer?(user = User.current)
user.allowed_to?(:view_payments, nil, global: true) || payment_receiver?(user)
+59
View File
@@ -0,0 +1,59 @@
#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 RedmineQboBilling
# What the Refund page posts (SOP-OPS-014): the canceled order's estimate, the parts the restocking fee is
# worked out on, how the money goes back (card terminal or company check), and what else to do in
# QuickBooks and Redmine.
class RefundForm
include ActiveModel::Model
include ActiveModel::Validations
ATTRIBUTES = %i[customer_id estimate_id txn_date parts_amount method check_number reason
close_estimate cancel_issues email_customer].freeze
attr_accessor(*ATTRIBUTES)
validate :validate_refund
def self.from_params(params)
params = params.to_h.stringify_keys
new(ATTRIBUTES.to_h { |attr| [attr, params[attr.to_s].to_s.strip] })
end
def parts_value
parts_amount.blank? ? BigDecimal('0') : EstimateForm.decimal(parts_amount)
end
def txn_date_value
EstimateForm.date(txn_date)
end
def check?
method == 'check'
end
%i[close_estimate cancel_issues email_customer].each do |flag|
define_method(:"#{flag}?") { send(flag).to_s == '1' || send(flag) == true }
end
private
def validate_refund
errors.add(:base, I18n.t(:error_estimate_needs_customer)) if customer_id.blank?
errors.add(:base, I18n.t(:error_refund_method)) unless QboRefund::METHODS.include?(method)
errors.add(:base, I18n.t(:error_refund_check_number)) if check? && check_number.blank?
errors.add(:base, I18n.t(:error_refund_reason)) if reason.blank?
value = parts_value
errors.add(:base, I18n.t(:error_refund_parts_amount)) if value.nil? || value.negative?
errors.add(:base, I18n.t(:error_estimate_field_invalid, field: I18n.t(:label_refund_date))) if txn_date_value.nil?
end
end
end
+127
View File
@@ -0,0 +1,127 @@
#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 RedmineQboBilling
# The QuickBooks calls a refund makes (RefundWriter), kept apart so the steps can be tested without QuickBooks.
class RefundGateway
# The customer's payments with money not yet applied (deposits and other credit), oldest first
def unapplied_payments(customer_id)
payments = with_service('Payment') do |service|
service.all("SELECT * FROM Payment WHERE CustomerRef = '#{customer_id.to_i}'")
end
Array(payments).select { |p| BigDecimal(p.unapplied_amount.to_s.presence || '0').positive? }
.sort_by { |p| [p.txn_date || Date.new(1900), p.id.to_i] }
end
def estimate(id)
QboEstimateService.with_service { |service| service.fetch_by_id(id) }
end
def create_invoice(invoice)
with_service('Invoice') { |service| service.create(invoice) }
end
def invoice(id)
with_service('Invoice') { |service| service.fetch_by_id(id) }
end
# Applies amount of the payment's unapplied money to a transaction (an invoice, or the refund check or
# expense). QuickBooks replaces a payment's lines on a sparse update, so its lines are sent back with
# the new one (added to the line already linked to that transaction, if any). Returns the saved payment.
def apply_payment(payment, amount, txn_id, txn_type)
lines = Array(payment.line_items).map { |line| copy_line(line) }
same = lines.find do |line|
Array(line.linked_transactions).any? { |t| t.txn_id.to_s == txn_id.to_s && t.txn_type.to_s == txn_type }
end
if same
same.amount = BigDecimal(same.amount.to_s) + amount
else
lines << self.class.linked_line(amount, txn_id, txn_type)
end
update = Quickbooks::Model::Payment.new
update.id = payment.id
update.sync_token = payment.sync_token
update.customer_ref = payment.customer_ref
update.total = payment.total
update.line_items = lines
with_service('Payment') { |service| service.update(update, sparse: true) }
end
def create_purchase(purchase)
with_service('Purchase') { |service| service.create(purchase) }
end
# The first active account of a QuickBooks account type ('Accounts Receivable', 'Bank')
def account_id(type)
account = with_service('Account') do |service|
service.query("SELECT * FROM Account WHERE AccountType = '#{type}' AND Active = true").entries.first
end
account&.id&.to_s
end
def customer_balance(customer_id)
customer = with_service('Customer') { |service| service.fetch_by_id(customer_id) }
BigDecimal(customer&.balance.to_s.presence || '0')
end
# Marks the canceled order's estimate Rejected, so it can't be invoiced later
def reject_estimate(estimate)
update = EstimateWriter.status_update(estimate, 'Rejected')
QboEstimateService.with_service { |service| service.update(update, sparse: true) }
end
def sync_invoice(id)
InvoiceSyncService.new.sync_by_id(id)
rescue StandardError => e
Rails.logger.warn "[RedmineQboBilling] Could not cache invoice #{id} after a refund: #{e.message}"
end
def sync_payment(id)
PaymentSyncService.new.sync_by_id(id)
rescue StandardError => e
Rails.logger.warn "[RedmineQboBilling] Could not cache payment #{id} after a refund: #{e.message}"
end
def sync_estimate(id)
EstimateSyncService.new.sync_by_id(id)
rescue StandardError => e
Rails.logger.warn "[RedmineQboBilling] Could not cache estimate #{id} after a refund: #{e.message}"
end
def self.linked_line(amount, txn_id, txn_type)
line = Quickbooks::Model::Line.new
line.amount = amount
link = Quickbooks::Model::LinkedTransaction.new
link.txn_id = txn_id.to_s
link.txn_type = txn_type
line.linked_transactions = [link]
line
end
private
def copy_line(line)
copy = Quickbooks::Model::Line.new
copy.amount = BigDecimal(line.amount.to_s)
copy.linked_transactions = Array(line.linked_transactions).map do |t|
link = Quickbooks::Model::LinkedTransaction.new
link.txn_id = t.txn_id
link.txn_type = t.txn_type
link
end
copy
end
def with_service(entity, &block)
QboConnectionService.with_qbo_service(entity: entity, &block)
end
end
end
+123
View File
@@ -0,0 +1,123 @@
#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 RedmineQboBilling
# A refund as a PDF (SOP-OPS-014): what was refunded and how, from what Redmine recorded when it was made, so it
# can be printed or filed without opening QuickBooks (QuickBooks has no PDF of a check or an expense).
class RefundPdf
include Redmine::I18n
WIDTH = 190
def initialize(refund)
@refund = refund
end
def render
pdf = ::Redmine::Export::PDF::ITCPDF.new(current_language)
pdf.set_title(title)
pdf.alias_nb_pages
pdf.footer_date = format_date(User.current.today)
pdf.add_page
pdf.SetFontStyle('B', 14)
pdf.RDMMultiCell(WIDTH, 7, shop_name)
pdf.SetFontStyle('B', 12)
pdf.RDMMultiCell(WIDTH, 7, title)
pdf.ln(3)
details(pdf)
pdf.ln(4)
amounts(pdf)
pdf.ln(4)
notes(pdf)
signature(pdf) if @refund.check?
pdf.output
end
def title
"#{l(:label_refund)} · #{@refund.customer&.name} · #{format_date(@refund.txn_date)}"
end
def filename
"refund-#{@refund.txn_date}-#{@refund.customer&.name.to_s.parameterize.presence || @refund.customer_id}.pdf"
end
private
def details(pdf)
rows = [[l(:label_customer), @refund.customer&.name.to_s],
[l(:label_refund_date), format_date(@refund.txn_date)],
[l(:label_refund_estimate), @refund.estimate_number.present? ? "E#{@refund.estimate_number}" : l(:label_refund_no_estimate)],
[l(:label_refund_reason), @refund.reason.to_s]]
rows.each { |label, value| row(pdf, label, value) }
end
def amounts(pdf)
pdf.SetFontStyle('B', 10)
pdf.RDMCell(WIDTH, 6, l(:label_refund_summary), 'B', 1)
pdf.SetFontStyle('', 10)
fee = @refund.fee_amount.to_d
money_row(pdf, l(:label_refund_credit), @refund.credit_amount)
if fee.positive?
label = l(:label_refund_pdf_fee, rate: RefundWriter.plain(@refund.fee_rate), parts: RefundWriter.money(@refund.parts_amount))
label += " · #{l(:label_refund_fee_invoice, number: @refund.fee_invoice_number)}" if @refund.fee_invoice_number.present?
money_row(pdf, label, -fee)
end
pdf.SetFontStyle('B', 11)
money_row(pdf, "#{l(:label_refund_amount)} · #{method_text}", @refund.refund_amount, border: 'T')
pdf.SetFontStyle('', 10)
unless @refund.balance_after.nil?
money_row(pdf, l(:label_refund_balance_after), @refund.balance_after)
end
end
def notes(pdf)
pdf.SetFontStyle('', 9)
issues = Issue.where(id: @refund.canceled_issue_ids).to_a
row(pdf, l(:label_refund_pdf_work_orders), issues.map { |i| "#{i.tracker} ##{i.id}: #{i.subject}" }.join("\n")) if issues.any?
row(pdf, l(:label_refund_pdf_estimate), l(:text_refund_pdf_estimate_rejected, number: @refund.estimate_number)) if @refund.estimate_closed?
row(pdf, l(:label_refund_recorded_by), "#{@refund.user&.name} · #{format_time(@refund.created_at)}")
row(pdf, l(:label_refund_incomplete), @refund.message.to_s) unless @refund.done?
end
# For a refund check: the customer signs for it
def signature(pdf)
pdf.ln(14)
pdf.SetFontStyle('', 10)
pdf.RDMCell(110, 6, l(:label_refund_received_by), 'T', 0)
pdf.RDMCell(10, 6, '', 0, 0)
pdf.RDMCell(70, 6, l(:label_date), 'T', 1)
end
def method_text
@refund.check? ? "#{@refund.method_name} ##{@refund.check_number}" : @refund.method_name
end
def row(pdf, label, value)
pdf.SetFontStyle('B', 10)
pdf.RDMCell(50, 6, label.to_s, 0, 0)
pdf.SetFontStyle('', 10)
pdf.RDMMultiCell(WIDTH - 50, 6, value.to_s)
end
def money_row(pdf, label, amount, border: 0)
pdf.RDMCell(WIDTH - 40, 7, label.to_s, border, 0)
pdf.RDMCell(40, 7, RefundWriter.money(amount), border, 1, 'R')
end
def shop_name
reminders = defined?(RedmineQboReminders::Settings) ? RedmineQboReminders::Settings.current : nil
reminders&.[]('shop_name').to_s.presence || Setting.app_title
rescue StandardError
Setting.app_title
end
end
end
+329
View File
@@ -0,0 +1,329 @@
#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 RedmineQboBilling
# Customer refunds for canceled orders and returned parts (SOP-OPS-014), the way the SOP does them in QuickBooks:
#
# 1. A restocking fee invoice for 30% of the parts (labor carries no fee), its line showing the math, paid
# from the customer's credit (their deposit), oldest first.
# 2. The rest of the customer's credit is refunded: a company check, or a partial refund on the card terminal.
# 3. The refund is recorded in QuickBooks with the category Accounts Receivable, from the bank account in the
# settings, described "Refund for deposit on E1234": a Check for a check, an Expense for a card refund.
# 4. The credit left on the customer's payments is applied to that check or expense, so the deposit, the fee
# invoice and the refund reconcile and the customer's balance comes back to $0.00.
#
# Then, as asked on the page: the canceled order's estimate is marked Rejected in QuickBooks, its work orders are
# set to the canceled status with the reason as a note, and the customer is emailed a summary.
#
# Each refund is recorded (QboRefund). Steps 1 to 4 stop at the first failure, and the record says which step
# failed and what was already done, so it can be finished in QuickBooks. The later steps only add warnings.
module RefundWriter
class Error < StandardError; end
Credit = Struct.new(:payment_id, :date, :reference, :memo, :amount, keyword_init: true)
Preview = Struct.new(:credits, :credit_total, :parts_amount, :fee_rate, :fee, :refund, keyword_init: true)
CLOSED_ESTIMATE_STATUSES = %w[Closed Converted Rejected].freeze
CANCELED_STATUS_NAMES = %w[Canceled Cancelled].freeze
module_function
def settings
Setting.plugin_redmine_qbo || {}
rescue StandardError
{}
end
# The restocking fee rate in percent (plugin setting, SOP-OPS-014: 30)
def fee_rate
rate = BigDecimal(settings['restocking_fee_rate'].to_s.strip, exception: false)
rate.nil? || rate.negative? ? BigDecimal('30') : rate
end
# The product/service on the restocking fee invoice (plugin setting)
def fee_item
Item.find_by(id: settings['restocking_item_id']) if settings['restocking_item_id'].present?
end
def fee(parts, rate = fee_rate)
(parts.to_d * rate.to_d / 100).round(2, BigDecimal::ROUND_HALF_UP)
end
# The parts on an estimate: its lines that aren't labor (with the lines inside bundles), before tax
def parts_amount(estimate)
labor_ids = LaborItems.ids
parts_lines(Array(estimate&.line_items), labor_ids).sum(BigDecimal('0')) { |line| BigDecimal(line.amount.to_s.presence || '0') }
end
def parts_lines(lines, labor_ids)
lines.flat_map do |line|
if line.respond_to?(:group_line_detail) && line.group_line_detail
parts_lines(Array(line.group_line_detail.line_items), labor_ids)
elsif (ref = sales_detail(line)&.item_ref) && ref.value.present?
LaborItems.match?(ref, ids: labor_ids) ? [] : [line]
else
[]
end
end
end
# A sales line's detail: estimates and invoices name it SalesLineItemDetail (InvoiceLineItem), other
# transactions SalesItemLineDetail (Line)
def sales_detail(line)
if line.respond_to?(:sales_line_item_detail) then line.sales_line_item_detail
elsif line.respond_to?(:sales_item_line_detail) then line.sales_item_line_detail
end
end
# The customer's credit: their payments' unapplied money, oldest first
def credits(customer, gateway: RefundGateway.new)
gateway.unapplied_payments(customer.id).map do |payment|
Credit.new(payment_id: payment.id.to_s, date: payment.txn_date, reference: payment.payment_ref_number.to_s,
memo: payment.private_note.to_s, amount: BigDecimal(payment.unapplied_amount.to_s))
end
end
# The customer's estimates to pick the canceled order from, newest first: [[label, id], ...]
def estimate_choices(customer)
Estimate.where(customer_id: customer.id).order(txn_date: :desc, id: :desc).limit(50).map do |estimate|
total = estimate.respond_to?(:total_amount) && estimate.total_amount ? " · $#{format('%.2f', estimate.total_amount)}" : ''
["E#{estimate.doc_number} · #{estimate.txn_date}#{total}", estimate.id.to_s]
end
end
# What the page shows before the refund is made: the credit, the fee and what will be refunded
def preview(customer, parts:, gateway: RefundGateway.new)
list = credits(customer, gateway: gateway)
total = list.sum(BigDecimal('0'), &:amount)
rate = fee_rate
amount = fee(parts, rate)
Preview.new(credits: list, credit_total: total, parts_amount: parts.to_d, fee_rate: rate, fee: amount,
refund: [total - amount, BigDecimal('0')].max)
end
# "Restocking fee: 30% × $1,026.63 parts on E1068 = $308.00"
def fee_description(parts, rate, amount, estimate_number)
on = estimate_number.present? ? " on E#{estimate_number}" : ''
I18n.t(:text_refund_fee_line, rate: plain(rate), parts: money(parts), on: on, fee: money(amount))
end
# "Refund for deposit on E1068" (SOP-OPS-014 step 3)
def refund_description(estimate_number, card:)
text = estimate_number.present? ? I18n.t(:text_refund_line, number: estimate_number) : I18n.t(:text_refund_line_credit)
card ? "#{text} #{I18n.t(:text_refund_line_card)}" : text
end
# Makes the refund; returns the QboRefund (done, or incomplete with the step that failed in its message).
# Raises Error, before anything is made in QuickBooks, when the refund can't be made as asked.
def refund!(form, user: User.current, gateway: RefundGateway.new, mailer: QboRefundMailer)
customer = Customer.find_by(id: form.customer_id)
raise Error, I18n.t(:error_estimate_needs_customer) unless customer
estimate = load_estimate(form, customer, gateway)
rate = fee_rate
parts = form.parts_value
fee_amount = fee(parts, rate)
item = fee_item
raise Error, I18n.t(:error_refund_no_fee_item) if fee_amount.positive? && item.nil?
payments = gateway.unapplied_payments(customer.id)
credit = payments.sum(BigDecimal('0')) { |p| BigDecimal(p.unapplied_amount.to_s) }
raise Error, I18n.t(:error_refund_no_credit) unless credit.positive?
raise Error, I18n.t(:error_refund_fee_over_credit, fee: money(fee_amount), credit: money(credit)) if fee_amount >= credit
ar_account = gateway.account_id('Accounts Receivable')
raise Error, I18n.t(:error_refund_no_ar_account) unless ar_account
bank_account = settings[form.check? ? 'refund_check_account_id' : 'refund_card_account_id'].presence || gateway.account_id('Bank')
raise Error, I18n.t(:error_refund_no_bank_account) unless bank_account
record = QboRefund.create!(customer_id: customer.id, estimate_id: estimate&.id, estimate_number: estimate&.doc_number,
user: user, txn_date: form.txn_date_value, method: form.method,
check_number: form.check? ? form.check_number : nil, reason: form.reason,
parts_amount: parts, fee_rate: rate, fee_amount: fee_amount, credit_amount: credit,
status: 'incomplete')
warnings = []
if fee_amount.positive?
fee_paid = step(record, :fee) { charge_fee(record, customer, item, gateway) }
return record unless fee_paid
end
refunded = step(record, :refund) { record_refund(record, customer, form, ar_account, bank_account, gateway) }
return record unless refunded
begin
record.update!(balance_after: gateway.customer_balance(customer.id))
rescue StandardError
warnings << I18n.t(:text_refund_balance_unknown)
end
warnings << close_estimate(record, estimate, gateway) if form.close_estimate? && estimate
warnings << cancel_issues(record, estimate, form, user) if form.cancel_issues? && estimate
warnings << email_customer(record, customer, mailer) if form.email_customer?
record.update!(status: 'done', message: warnings.compact.join("\n").presence)
record
end
# The canceled order's estimate, which must be the customer's
def load_estimate(form, customer, gateway)
return nil if form.estimate_id.blank?
estimate = gateway.estimate(form.estimate_id)
raise Error, I18n.t(:notice_estimate_not_found) unless estimate
raise Error, I18n.t(:error_refund_estimate_customer) unless estimate.customer_ref&.value.to_s == customer.id.to_s
estimate
end
# Runs one of the steps that must all succeed; on failure records which step and why
def step(record, name)
yield
true
rescue StandardError => e
detail = e.respond_to?(:detail) && e.detail.present? ? "#{e.message}: #{e.detail}" : e.message
Rails.logger.error "[RedmineQboBilling] Refund #{record.id}, #{name}: #{detail}"
record.update!(message: I18n.t(:"error_refund_step_#{name}", error: detail))
false
end
# Step 1: the restocking fee invoice, paid from the customer's credit
def charge_fee(record, customer, item, gateway)
invoice = Quickbooks::Model::Invoice.new
invoice.customer_id = customer.id
invoice.txn_date = record.txn_date
invoice.private_note = I18n.t(:text_refund_private_note, reason: record.reason)
line = Quickbooks::Model::InvoiceLineItem.new
line.amount = record.fee_amount
line.description = fee_description(record.parts_amount, record.fee_rate, record.fee_amount, record.estimate_number)
line.sales_item! do |detail|
detail.item_id = item.id
detail.quantity = 1
detail.unit_price = record.fee_amount
end
invoice.line_items = [line]
saved = gateway.create_invoice(invoice)
raise Error, I18n.t(:error_refund_fee_not_saved) unless saved&.id
record.update!(fee_invoice_id: saved.id.to_s, fee_invoice_number: saved.doc_number.to_s)
# QuickBooks may already have applied the customer's credit to the new invoice ("Automatically apply credits")
owed = BigDecimal(gateway.invoice(saved.id).balance.to_s.presence || '0')
gateway.unapplied_payments(customer.id).each do |payment|
break unless owed.positive?
take = [owed, BigDecimal(payment.unapplied_amount.to_s)].min
next unless take.positive?
gateway.apply_payment(payment, take, saved.id, 'Invoice')
gateway.sync_payment(payment.id)
owed -= take
end
raise Error, I18n.t(:error_refund_fee_unpaid, amount: money(owed)) if owed.positive?
gateway.sync_invoice(saved.id)
end
# Steps 2 to 4: the refund check or expense for the rest of the credit, and the credit applied to it
def record_refund(record, customer, form, ar_account, bank_account, gateway)
payments = gateway.unapplied_payments(customer.id)
amount = payments.sum(BigDecimal('0')) { |p| BigDecimal(p.unapplied_amount.to_s) }
raise Error, I18n.t(:error_refund_nothing_left) unless amount.positive?
card = !form.check?
purchase = Quickbooks::Model::Purchase.new
purchase.payment_type = card ? 'Cash' : 'Check'
purchase.doc_number = record.check_number unless card
purchase.txn_date = record.txn_date
purchase.account_ref = Quickbooks::Model::BaseReference.new(bank_account.to_s)
payee = Quickbooks::Model::BaseReference.new(customer.id.to_s)
payee.type = 'Customer'
purchase.entity_ref = payee
purchase.private_note = I18n.t(:text_refund_private_note, reason: record.reason)
line = Quickbooks::Model::PurchaseLineItem.new
line.amount = amount
line.description = refund_description(record.estimate_number, card: card)
line.account_based_expense! do |detail|
detail.account_ref = Quickbooks::Model::BaseReference.new(ar_account.to_s)
detail.customer_ref = Quickbooks::Model::BaseReference.new(customer.id.to_s)
end
purchase.line_items = [line]
saved = gateway.create_purchase(purchase)
raise Error, I18n.t(:error_refund_not_saved) unless saved&.id
record.update!(purchase_id: saved.id.to_s, refund_amount: amount)
# The credit is applied to the check ("Check") or the expense ("Expense")
payments.each do |payment|
gateway.apply_payment(payment, BigDecimal(payment.unapplied_amount.to_s), saved.id, card ? 'Expense' : 'Check')
gateway.sync_payment(payment.id)
end
end
# Marks the canceled order's estimate Rejected; returns a warning, or nil
def close_estimate(record, estimate, gateway)
return nil if CLOSED_ESTIMATE_STATUSES.include?(estimate.txn_status.to_s)
gateway.reject_estimate(estimate)
gateway.sync_estimate(estimate.id)
record.update!(estimate_closed: true)
nil
rescue StandardError => e
I18n.t(:text_refund_estimate_not_closed, error: e.message)
end
# Sets the estimate's open work orders to the canceled status, with the reason as a note (Work Orders §5)
def cancel_issues(record, estimate, form, user)
status = canceled_status
return I18n.t(:text_refund_no_canceled_status) unless status
ids = Issue.where(estimate_id: estimate.id).pluck(:id) + QboEstimateLineIssue.where(estimate_id: estimate.id).pluck(:issue_id)
note = I18n.t(:text_refund_issue_note, reason: form.reason, fee: money(record.fee_amount),
refund: money(record.refund_amount), method: record.method_name)
failed = []
canceled = Issue.where(id: ids.uniq).includes(:status).reject(&:closed?).filter_map do |issue|
issue.init_journal(user, note)
issue.status = status
if issue.save
issue.id
else
failed << "##{issue.id} (#{issue.errors.full_messages.join(', ')})"
nil
end
end
record.update!(canceled_issue_ids: canceled)
failed.any? ? I18n.t(:text_refund_issues_not_canceled, issues: failed.join('; ')) : nil
end
# The work order status for canceled orders (plugin setting, else a closed status named Canceled)
def canceled_status
id = settings['refund_canceled_status_id']
(IssueStatus.find_by(id: id) if id.present?) ||
IssueStatus.where(is_closed: true).detect { |s| CANCELED_STATUS_NAMES.include?(s.name.to_s.strip) }
end
# Emails the customer a summary; returns a warning, or nil
def email_customer(record, customer, mailer)
email = customer.email.to_s.strip
return I18n.t(:text_refund_no_email) if email.blank?
mailer.refund_summary(record, email).deliver_now
record.update!(emailed_to: email)
nil
rescue StandardError => e
I18n.t(:text_refund_email_failed, error: e.message)
end
def money(amount)
whole, cents = format('%.2f', amount.to_d.abs).split('.')
"#{'-' if amount.to_d.negative?}$#{whole.reverse.scan(/\d{1,3}/).join(',').reverse}.#{cents}"
end
def plain(number)
number = number.to_d
number == number.to_i ? number.to_i.to_s : number.to_s('F')
end
end
end
+101
View File
@@ -0,0 +1,101 @@
#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.
require File.expand_path('../test_helper', __dir__)
class QboRefundsTest < Redmine::IntegrationTest
include QboRefundTestHelper
def setup
@customer = create_customer
Customer.any_instance.stubs(:email).returns('jane@example.com')
RedmineQboBilling::RefundWriter.stubs(:fee_item).returns(fee_item)
@gateway = FakeGateway.new(payments: [deposit(50, 500)], estimate: estimate)
RedmineQboBilling::RefundGateway.stubs(:new).returns(@gateway)
RedmineQboBilling::RefundWriter.stubs(:estimate_choices).returns([['E1068 · 2026-10-06', '598']])
QboRefundMailer.stubs(:refund_summary).returns(stub(deliver_now: true))
end
def test_needs_the_permission
log_user('jsmith', 'jsmith')
get "/qbo_refunds/new?customer_id=#{CUSTOMER_ID}"
assert_response :forbidden
Role.find(1).add_permission!(:issue_refunds)
get "/qbo_refunds/new?customer_id=#{CUSTOMER_ID}"
assert_response :success
end
def test_refund_page_fills_in_the_estimates_parts
log_user('admin', 'admin')
get "/qbo_refunds/new?customer_id=#{CUSTOMER_ID}&estimate_id=598"
assert_response :success
assert_select 'input[name=?][value=?]', 'refund[parts_amount]', '307.99'
assert_select '#qbo-refund-credit', text: '$500.00'
assert_select '#qbo-refund-fee', text: '-$92.40'
assert_select '#qbo-refund-amount', text: '$407.60'
assert_select 'input[name=?][value=check][checked]', 'refund[method]'
end
def test_refund
log_user('admin', 'admin')
post '/qbo_refunds', params: { refund: { customer_id: CUSTOMER_ID, estimate_id: '598', parts_amount: '307.99',
method: 'check', check_number: '5001', txn_date: '2026-11-16',
reason: 'Canceled', close_estimate: '1', cancel_issues: '0', email_customer: '1' } }
refund = QboRefund.last
assert_redirected_to "/qbo_refunds/#{refund.id}"
assert refund.done?, refund.message
assert_equal BigDecimal('407.60'), refund.refund_amount
follow_redirect!
assert_select 'p', text: /\$407\.60 · Company check #5001/
assert_select 'a[href*="app/check?txnId="]'
assert_select 'a[href=?]', "/qbo_invoices/#{refund.fee_invoice_id}/edit"
assert_select 'a[href=?]', '/qbo_estimates/598/edit'
assert_select 'a[href*="app/invoice?txnId="]', count: 0
get "/customers/#{CUSTOMER_ID}"
assert_select 'a[href=?]', "/qbo_refunds/#{refund.id}"
end
def test_form_errors
log_user('admin', 'admin')
post '/qbo_refunds', params: { refund: { customer_id: CUSTOMER_ID, parts_amount: '10', method: 'check',
check_number: '', txn_date: '2026-11-16', reason: '' } }
assert_response :unprocessable_entity
assert_select '#errorExplanation', text: /check number/
assert_select '#errorExplanation', text: /reason/
assert_equal 0, QboRefund.count
end
def test_email_again
log_user('admin', 'admin')
refund = QboRefund.create!(customer_id: CUSTOMER_ID, method: 'check', check_number: '5001', status: 'done',
refund_amount: 100, txn_date: Date.new(2026, 11, 16))
post "/qbo_refunds/#{refund.id}/email"
assert_redirected_to "/qbo_refunds/#{refund.id}"
assert_equal 'jane@example.com', refund.reload.emailed_to
end
def test_pdf
log_user('admin', 'admin')
refund = QboRefund.create!(customer_id: CUSTOMER_ID, method: 'check', check_number: '5001', status: 'done',
estimate_number: '1068', reason: 'Canceled', parts_amount: 307.99, fee_rate: 30,
fee_amount: 92.40, fee_invoice_number: '1502', credit_amount: 500, refund_amount: 407.60,
balance_after: 0, txn_date: Date.new(2026, 11, 16), user_id: 1)
get "/qbo_refunds/#{refund.id}/pdf"
assert_response :success
assert_equal 'application/pdf', response.media_type
assert response.body.start_with?('%PDF')
assert_match(/refund-2026-11-16-jane-customer\.pdf/, response.headers['Content-Disposition'])
get "/qbo_refunds/#{refund.id}"
assert_select 'a[href=?]', "/qbo_refunds/#{refund.id}/pdf"
end
end
+169
View File
@@ -0,0 +1,169 @@
#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.
require File.expand_path('../../../test/test_helper', __dir__)
module QboRefundTestHelper
CUSTOMER_ID = 9101
# Stands in for QuickBooks: the customer's payments, and what the refund made
class FakeGateway
attr_reader :payments, :invoices, :purchases, :applied, :rejected
attr_accessor :auto_apply, :fail_on, :estimate_record, :balance
def initialize(payments: [], estimate: nil)
@payments = payments
@estimate_record = estimate
@invoices = []
@purchases = []
@applied = []
@rejected = []
@auto_apply = false
@balance = BigDecimal('0')
end
def unapplied_payments(_customer_id)
payments.select { |p| p.unapplied_amount.to_d.positive? }.sort_by { |p| [p.txn_date, p.id.to_i] }
end
def estimate(id)
estimate_record if estimate_record && estimate_record.id.to_s == id.to_s
end
def create_invoice(invoice)
raise Quickbooks::IntuitRequestException, 'QuickBooks is down' if fail_on == :invoice
invoice.id = (700 + invoices.size).to_s
invoice.doc_number = (1500 + invoices.size).to_s
invoice.total = invoice.line_items.sum(BigDecimal('0')) { |l| l.amount.to_d }
invoice.balance = invoice.total
invoices << invoice
# QuickBooks' "Automatically apply credits"
if auto_apply
unapplied_payments(nil).each do |p|
take = [invoice.balance, p.unapplied_amount.to_d].min
next unless take.positive?
apply_payment(p, take, invoice.id, 'Invoice')
end
end
invoice
end
def invoice(id)
invoices.find { |i| i.id.to_s == id.to_s }
end
def apply_payment(payment, amount, txn_id, txn_type)
raise Quickbooks::IntuitRequestException, 'Link refused' if fail_on == :link
payment.unapplied_amount = payment.unapplied_amount.to_d - amount
invoice(txn_id).balance = invoice(txn_id).balance.to_d - amount if txn_type == 'Invoice'
applied << [payment.id, amount, txn_id.to_s, txn_type]
payment
end
def create_purchase(purchase)
raise Quickbooks::IntuitRequestException, 'QuickBooks is down' if fail_on == :purchase
purchase.id = (800 + purchases.size).to_s
purchases << purchase
purchase
end
def account_id(type)
{ 'Accounts Receivable' => '84', 'Bank' => '35' }[type]
end
def customer_balance(_customer_id)
balance
end
def reject_estimate(estimate)
rejected << estimate.id.to_s
end
def sync_invoice(_id); end
def sync_payment(_id); end
def sync_estimate(_id); end
end
class FakeMailer
Delivery = Struct.new(:refund, :email) do
def deliver_now
FakeMailer.sent << [refund.id, email]
end
end
def self.sent
@sent ||= []
end
def self.refund_summary(refund, email)
Delivery.new(refund, email)
end
end
def self.included(base)
base.fixtures :projects, :users, :email_addresses, :members, :member_roles, :roles, :issues, :trackers,
:projects_trackers, :issue_statuses, :enabled_modules, :enumerations, :workflows
base.setup do
QboRefund.delete_all
Customer.where(id: CUSTOMER_ID).delete_all
FakeMailer.sent.clear
end
end
def create_customer
customer = Customer.new(id: CUSTOMER_ID, name: 'Jane Customer')
customer.skip_qbo_push = true
customer.save!
customer
end
def deposit(id, amount, date: Date.new(2026, 11, 2))
payment = Quickbooks::Model::Payment.new
payment.id = id.to_s
payment.txn_date = date
payment.total = BigDecimal(amount.to_s)
payment.unapplied_amount = BigDecimal(amount.to_s)
payment.customer_ref = Quickbooks::Model::BaseReference.new(CUSTOMER_ID.to_s)
payment
end
def item_line(item_id, name, amount)
line = Quickbooks::Model::InvoiceLineItem.new
line.amount = BigDecimal(amount.to_s)
line.sales_item! { |d| d.item_ref = Quickbooks::Model::BaseReference.new(item_id.to_s, name: name) }
line
end
# E1068: $1,900 labor and $307.99 of parts
def estimate(id: 598, status: 'Accepted', customer_id: CUSTOMER_ID)
estimate = Quickbooks::Model::Estimate.new
estimate.id = id.to_s
estimate.doc_number = '1068'
estimate.txn_status = status
estimate.customer_ref = Quickbooks::Model::BaseReference.new(customer_id.to_s)
estimate.line_items = [item_line(1, 'Labor', 1900), item_line(2, 'TF HD JK Ball Joints', '307.99')]
estimate
end
def fee_item
Struct.new(:id, :name).new('55', 'Restocking Fee')
end
def refund_form(attributes = {})
RedmineQboBilling::RefundForm.new({ customer_id: CUSTOMER_ID.to_s, estimate_id: '598', txn_date: '2026-11-16',
parts_amount: '307.99', method: 'check', check_number: '5001',
reason: 'Customer canceled the order', close_estimate: '1',
cancel_issues: '1', email_customer: '1' }.merge(attributes))
end
end
+177
View File
@@ -0,0 +1,177 @@
#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.
require File.expand_path('../test_helper', __dir__)
class RefundWriterTest < ActiveSupport::TestCase
include QboRefundTestHelper
Writer = RedmineQboBilling::RefundWriter
def setup
User.current = User.find(1)
@customer = create_customer
Customer.any_instance.stubs(:email).returns('jane@example.com')
Writer.stubs(:fee_item).returns(fee_item)
@gateway = FakeGateway.new(payments: [deposit(50, 300), deposit(51, '307.99', date: Date.new(2026, 11, 5))], estimate: estimate)
end
def refund(form = refund_form, gateway: @gateway)
Writer.refund!(form, user: User.find(1), gateway: gateway, mailer: FakeMailer)
end
def test_fee
assert_equal BigDecimal('92.40'), Writer.fee(BigDecimal('307.99'), 30)
assert_equal BigDecimal('0'), Writer.fee(0, 30)
end
def test_parts_amount_leaves_out_labor
assert_equal BigDecimal('307.99'), Writer.parts_amount(estimate)
end
def test_parts_inside_bundles
bundle = Quickbooks::Model::InvoiceLineItem.new
bundle.amount = BigDecimal('500')
bundle.group_line_detail!
bundle.group_line_detail.line_items = [item_line(1, 'Labor', 380), item_line(3, 'Brake Pads', 120)]
subtotal = Quickbooks::Model::InvoiceLineItem.new
subtotal.amount = BigDecimal('9999')
subtotal.detail_type = 'SubTotalLineDetail'
subtotal.sub_total_line_detail = Quickbooks::Model::SubTotalLineDetail.new
e = estimate
e.line_items = e.line_items + [bundle, subtotal]
assert_equal BigDecimal('427.99'), Writer.parts_amount(e)
end
def test_refund_by_check
record = refund
assert record.done?, record.message
# $92.40 fee (30% of $307.99) out of $607.99 credit: $515.59 refunded
assert_equal BigDecimal('92.40'), record.fee_amount
assert_equal BigDecimal('607.99'), record.credit_amount
assert_equal BigDecimal('515.59'), record.refund_amount
invoice = @gateway.invoices.first
line = invoice.line_items.first
assert_equal 'Restocking fee: 30% × $307.99 parts on E1068 = $92.40', line.description
assert_equal '55', line.sales_line_item_detail.item_ref.value
assert_equal BigDecimal('0'), invoice.balance
purchase = @gateway.purchases.first
assert_equal 'Check', purchase.payment_type
assert_equal '5001', purchase.doc_number
assert_equal '35', purchase.account_ref.value
assert_equal 'Customer', purchase.entity_ref.type
assert_equal CUSTOMER_ID.to_s, purchase.entity_ref.value
expense = purchase.line_items.first
assert_equal 'Refund for deposit on E1068', expense.description
assert_equal '84', expense.account_based_expense_line_detail.account_ref.value
assert_equal BigDecimal('515.59'), expense.amount
# Oldest deposit pays the fee first; what's left of both goes on the check
assert_equal [['50', BigDecimal('92.40'), invoice.id, 'Invoice'],
['50', BigDecimal('207.60'), purchase.id, 'Check'],
['51', BigDecimal('307.99'), purchase.id, 'Check']], @gateway.applied
assert @gateway.payments.all? { |p| p.unapplied_amount.zero? }
assert_equal BigDecimal('0'), record.balance_after
assert_equal ['598'], @gateway.rejected
assert record.estimate_closed?
assert_equal [[record.id, 'jane@example.com']], FakeMailer.sent
assert_equal 'jane@example.com', record.emailed_to
end
def test_card_refund_is_an_expense
record = refund(refund_form(method: 'card', check_number: ''))
assert record.done?, record.message
purchase = @gateway.purchases.first
assert_equal 'Cash', purchase.payment_type
assert_nil purchase.doc_number
assert_equal 'Refund for deposit on E1068 (card refund on the terminal)', purchase.line_items.first.description
assert_equal %w[Invoice Expense Expense], @gateway.applied.map(&:last)
assert_nil record.check_number
end
def test_credit_quickbooks_already_applied_to_the_fee
@gateway.auto_apply = true
record = refund
assert record.done?, record.message
assert_equal BigDecimal('515.59'), record.refund_amount
# The fee was paid once, by QuickBooks
assert_equal 1, @gateway.applied.count { |a| a.last == 'Invoice' }
end
def test_no_fee_refunds_everything
record = refund(refund_form(parts_amount: '0', estimate_id: ''))
assert record.done?, record.message
assert_empty @gateway.invoices
assert_equal BigDecimal('607.99'), record.refund_amount
assert_equal 'Refund of customer credit', @gateway.purchases.first.line_items.first.description
assert_empty @gateway.rejected
end
def test_checks_before_making_anything
assert_raises(Writer::Error) { refund(refund_form, gateway: FakeGateway.new(estimate: estimate)) }
assert_raises(Writer::Error) { refund(refund_form(parts_amount: '5000')) }
assert_raises(Writer::Error) { refund(refund_form, gateway: FakeGateway.new(payments: [deposit(50, 300)], estimate: estimate(customer_id: 1))) }
Writer.stubs(:fee_item).returns(nil)
assert_raises(Writer::Error) { refund }
assert_equal 0, QboRefund.count
assert_empty @gateway.invoices
end
def test_records_the_step_that_failed
@gateway.fail_on = :purchase
record = refund
assert_not record.done?
assert_match(/refund couldn't be recorded/i, record.message)
assert_equal 1, @gateway.invoices.size
assert record.fee_invoice_id.present?
assert_nil record.purchase_id
assert_empty FakeMailer.sent
assert_empty @gateway.rejected
end
def test_cancels_the_work_orders
issue = Issue.find(1)
issue.update_columns(estimate_id: 598) if Issue.column_names.include?('estimate_id')
canceled = IssueStatus.find(5) # Closed (fixtures)
Writer.stubs(:canceled_status).returns(canceled)
record = refund
assert record.done?, record.message
assert_includes record.canceled_issue_ids, 1
issue.reload
assert_equal canceled, issue.status
assert_match(/Order canceled and refunded: Customer canceled the order/, issue.journals.last.notes)
end
def test_warnings_dont_undo_the_refund
Customer.any_instance.stubs(:email).returns('')
Writer.stubs(:canceled_status).returns(nil)
record = refund
assert record.done?
assert_match(/no email/i, record.message)
assert_match(/canceled status/i, record.message)
end
def test_the_email
record = refund
ActionMailer::Base.deliveries.clear
message = QboRefundMailer.refund_summary(record, 'jane@example.com')
message.deliver_now
assert_equal ['jane@example.com'], message.to
assert_match(/Your refund from .*: \$515\.59/, message.subject)
body = message.body.to_s
assert_includes body, 'Hello Jane Customer,'
assert_includes body, "We've processed the refund for E1068."
assert_includes body, 'Parts: $307.99'
assert_includes body, 'Restocking fee (30% of parts): $92.40'
assert_includes body, 'Refund: $515.59'
assert_includes body, 'company check (no. 5001)'
end
end