mirror of
https://github.com/rickbarrette/redmine_qbo.git
synced 2026-11-19 10:40:36 -05:00
Compare commits
45
Commits
2026.11.4
...
2026.11.22
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
40eb6205c4 | ||
|
|
0c5bac855e | ||
|
|
663639b8fd | ||
|
|
ec4e5f681d | ||
|
|
a72b0fa73b | ||
|
|
5b6c1ed2c2 | ||
|
|
4f6f81c87a | ||
|
|
9fa199aa98 | ||
|
|
16f9441568 | ||
|
|
5c48646041 | ||
|
|
90adb96d54 | ||
|
|
8a947483db | ||
|
|
42461e7899 | ||
|
|
461fa79bc5 | ||
|
|
2fb21c34bb | ||
|
|
1c71e3a4c9 | ||
|
|
89f4797bbe | ||
|
|
3bbceacda4 | ||
|
|
d75dee2866 | ||
|
|
c8e2d2d92e | ||
|
|
a1fb88e77c | ||
|
|
0a7b2e34b8 | ||
|
|
895733f534 | ||
|
|
fa1b4eed06 | ||
|
|
95e76a41fd | ||
|
|
92b2a18eb6 | ||
|
|
084df36061 | ||
|
|
3b51625df4 | ||
|
|
7cfc8a370e | ||
|
|
d2cdd798cd | ||
|
|
159420fac1 | ||
|
|
dbee228cdf | ||
|
|
ec00684edd | ||
|
|
839ac976e6 | ||
|
|
dc72b11766 | ||
|
|
778111825b | ||
|
|
4ba96e2dfd | ||
|
|
88160a985d | ||
|
|
e2a871b1e8 | ||
|
|
489edd97fa | ||
|
|
64e4a149ab | ||
|
|
6a638fe7bb | ||
|
|
51159d5034 | ||
|
|
8f2cef2bc8 | ||
|
|
bd29ec2978 |
No files matched your search
@@ -3,7 +3,6 @@ source 'https://rubygems.org'
|
||||
gem 'quickbooks-ruby'
|
||||
gem 'oauth2'
|
||||
gem 'roxml'
|
||||
gem 'will_paginate'
|
||||
gem 'rexml'
|
||||
gem 'combine_pdf'
|
||||
|
||||
|
||||
@@ -69,8 +69,10 @@ This ensures Time Activities are recorded under the correct employee in QuickBoo
|
||||
The plugin provides basic Customer management:
|
||||
|
||||
* Create Customers directly from Redmine
|
||||
|
||||
* Browse every Customer on the **Customers** page: a Redmine list with phone numbers, issue counts and last update, sortable by column and paged with Redmine's own pagination (and its per-page choices)
|
||||
|
||||
* Search Customers by **name or phone number**
|
||||
* Search Customers by **name or phone number**: the best matches come first (click a column to sort them instead), and a single match opens that Customer
|
||||
|
||||
* View and edit Customer information
|
||||
|
||||
@@ -95,13 +97,13 @@ Customer records are automatically updated in the local database when changes oc
|
||||
|
||||
### Estimates, Invoices and Payments
|
||||
|
||||
Estimates and invoices keep their number, date, customer, total and **man-hours** (the quantities of the labor products/services, including lines inside bundles). Payments keep their customer, date, amount and unapplied amount. These cached figures feed the business report.
|
||||
Estimates and invoices keep their number, date, customer, total, sales tax and **man-hours** (the quantities of the labor products/services, including lines inside bundles). Payments keep their customer, date, amount and unapplied amount. These cached figures feed the business report.
|
||||
|
||||
---
|
||||
|
||||
## Billing: Estimates, Invoices and Payments
|
||||
|
||||
* **New estimate** from the customer page: Create Estimate opens the Redmine editor. The customer page no longer links to QuickBooks' estimate or payment screens; the customer's name still opens their QuickBooks account page as a fallback.
|
||||
* **New estimate** from the customer page: Create Estimate opens the Redmine editor. The customer page no longer links to QuickBooks' estimate or payment screens; **Open in QuickBooks** opens their QuickBooks account page as a fallback.
|
||||
* **Edit** any estimate from the Edit link next to it on the customer page or the issue page.
|
||||
* **Keyboard entry**: in a line's product box, Tab picks the product the text points to (an exact name, the only match, or the only name starting with it, e.g. "lab" → Labor) and fills the line. Tabbing into the description, quantity or rate selects it, so typing replaces it. The quantity, rate and amount boxes take simple math (e.g. `33*1.3`, `(120+15)/2`; `+ - * /`, `x` for times, parentheses), worked out when you leave the box; math in the rate or amount is rounded to the nearest penny, and an amount sets the rate from the quantity. Typing `sub`, `subtotal` or `=` in a product box, then Tab or Enter, adds a subtotal there (an empty line becomes the subtotal; a line with a description keeps it and gets the subtotal after it) and moves on to the next line.
|
||||
* **Duplicate** an estimate to start a similar one: same customer, lines, subtotals, custom fields and messages, dated today, with the current user as sales person.
|
||||
@@ -119,14 +121,14 @@ Estimates and invoices keep their number, date, customer, total and **man-hours*
|
||||
|
||||
* **Create invoice** on an estimate's page makes an invoice from it (customer, lines, subtotals, custom fields), like QuickBooks' "Create invoice". **Create invoice** on the customer page starts a blank one, and the Edit link next to each invoice on the customer page opens it.
|
||||
* **Import time & estimates** lists the customer's billable QuickBooks time (the time activities redmine_qbo makes from an issue's time entries) and their open estimates (e.g. the ones redmine_qbo_lineitems makes for parts that weren't quoted).
|
||||
* Tick the time to bill and, under **Replace these lines**, the lines it replaces (e.g. the estimate's labor lines). Only lines with one of the **labor products/services** from the plugin settings are offered there. The time goes where the first ticked line was and the ticked lines are removed, so the invoice reads in the same order.
|
||||
* Tick the time to bill and, under **Replace these lines**, the lines it replaces (e.g. the estimate's labor lines). Only lines with one of the **labor products/services** from the plugin settings are offered there. Each time entry takes the place of one ticked line: the one whose description is its issue's subject (issues created from an estimate are named after the line, so "Install #134: Install Lift Kit" replaces the "Install Lift Kit" line), then any others in order. Extra time goes after the last replaced line and extra ticked lines are removed, so the invoice keeps the estimate's order and subtotals.
|
||||
* Ticked estimates go right after the time for the same issue: a redmine_qbo_lineitems estimate starting "Added from: Install #116: …" lands after the time for #116, without that note line, since the time line already names the issue. Estimates with no matching time keep the note and go at the end.
|
||||
* **Undo import** puts the lines back until the invoice is saved.
|
||||
* **An estimate is billed once**: an estimate that's on an invoice (linked to one, or closed) or was rejected can't be made into an invoice or imported, and its page shows the invoice it's billed on. This is checked against QuickBooks again when the invoice is saved, so an estimate invoiced meanwhile (in another tab, by someone else, or in QuickBooks) stops the save.
|
||||
* Time lines are linked to their time activities, so QuickBooks marks the time as billed. Estimates the invoice was made from, or imported into it, are linked and closed when it's saved.
|
||||
* **Custom fields from the work orders**: the issues behind an invoice are the ones its time lines and lineitems estimates name. Plugins can fill custom fields from them when they're imported, and block a save (e.g. redmine_qbo_vehicles fills the VIN and mileage and allows one vehicle per invoice). On its own, redmine_qbo leaves the boxes as typed.
|
||||
* **Sales person**: an invoice credits the sales person on the estimate it was made from (the first linked estimate that names one); if none does, the user who writes the invoice.
|
||||
* Invoices show their status, worked out from the balance and due date like QuickBooks' invoice list: **Paid**, **Partially paid**, **Overdue**, **Open** or **Voided** (a zero total), on the customer page's invoice list and the invoice page.
|
||||
* Invoices show their status, worked out from the balance and due date like QuickBooks' invoice list: **Paid**, **Partially paid**, **Overdue**, **Open** or **Voided** (a zero total), on the customer page's invoice list and the invoice page. A paid invoice shows the day it was paid in full (e.g. **Paid 11/03/2026**): the later of its date and the last payment or credit memo applied to it.
|
||||
* Invoices with a payment applied open read-only. The due date is left to QuickBooks (from the customer's terms) unless one is picked. The "default message shown on invoices" fills in the message.
|
||||
|
||||
### Payments
|
||||
@@ -138,15 +140,32 @@ 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 month, quarter or year, or custom dates):
|
||||
**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):
|
||||
|
||||
* **Sales**: estimates written, invoices written and payments received (totals and counts), invoiced vs. estimated, collected vs. invoiced, and what's still owed on those invoices.
|
||||
* **Sales**: estimates written, invoices written, invoices paid in full (on the day each was paid in full) and payments received (totals and counts), invoiced vs. estimated, collected vs. invoiced, and what's still owed on those invoices. Estimates and invoices are without sales tax (QuickBooks' tax on each is cached with it); payments are as received, so collected vs. invoiced compares them with the invoices' totals with tax.
|
||||
* **Sales tax**: **tax invoiced**, the sales tax on invoices dated in the period, paid or not (accrual), and **tax collected**, the sales tax on invoices paid in full in the period, counted on the day each was paid in full (cash), each with how many invoices carried tax, a line chart and a month-by-month table. A partly paid invoice's tax counts as collected once it's paid in full. Only invoices are counted: sales receipts, refund receipts and credit memos aren't kept in Redmine, so file sales tax from QuickBooks' *Sales Tax Liability* report.
|
||||
* **Hours**: estimated hours on estimates, issues' estimated time, invoiced hours on invoices and time spent, with spent vs. estimated, and the **cost performance index** (CPI = invoiced hours ÷ spent hours): green at 1.00 or more, yellow below 1, red below 0.80. Each month shows its CPI too.
|
||||
* **By month**: every figure month by month, with totals.
|
||||
* **Charts**: above each set of bars, a line chart of the same figures in the same colors (Chart.js 4.5.1, MIT licensed, bundled with the plugin in assets/javascripts so it doesn't clash with other plugins' copies such as redmine_indicator's Chart.js 2), with a point per day for a week, per week for up to about three months, and per month beyond. Hovering a point shows its figures. **Compare with last year** adds last year's lines, dashed and faded, without reloading: days and weeks go back 52 weeks so weekdays line up, months go back to the same month. Clicking a figure in the legend hides it (and its last-year line); clicking *last year* stops comparing. Today's line stops at today.
|
||||
* **By month**: every sales and hours figure month by month, with totals (the sales tax has its own table).
|
||||
* **Projects**: pick one or more open projects (Ctrl/Cmd-click; closed and archived projects aren't listed) to count only their issues' estimated time and spent time, in the totals, charts and months; none picked counts every project. Estimates, invoices and payments have no project in QuickBooks, so they always cover the whole business (as do the CPI's invoiced hours). **Remember these projects** saves the choice in your Redmine preferences, and the report opens with it until you save another (saving none goes back to every project).
|
||||
|
||||
Estimates, invoices and payments count by their QuickBooks date. Issues' estimated time counts issues created in the period, leaving out parents so subtasks aren't counted twice. Spent time counts time logged in the period. While estimates, invoices or payments are syncing, the report says so (with how many have been read) and refreshes every 30 seconds; the settings page's Synchronization table shows the same per type. Estimates and invoices synced before these figures were added have no total or hours until a full sync (the report says how many); run one again after changing the labor products/services.
|
||||
Estimates, invoices and payments count by their QuickBooks date; invoices paid in full and tax collected by the day each invoice was paid in full. Issues' estimated time counts issues created in the period, leaving out parents so subtasks aren't counted twice. Spent time counts time logged in the period. While estimates, invoices or payments are syncing, the report says so (with how many have been read) and refreshes every 30 seconds; the settings page's Synchronization table shows the same per type. Estimates and invoices synced before these figures were added have no total, hours or sales tax, and paid invoices no paid-in-full day, until a full sync (the report says how many); run one again after changing the labor products/services.
|
||||
|
||||
### QuickBooks custom fields
|
||||
|
||||
@@ -188,11 +207,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
|
||||
@@ -214,7 +235,7 @@ Available hooks:
|
||||
|
||||
|Type|Hook|Note
|
||||
|--|--|--|
|
||||
View Hook|:view_customers_show_contextual, { customer: @customer } | Used to add action links to the customer page's top-right action area (return links styled like Redmine's, e.g. `link_to sprite_icon('add', 'Label'), path, class: 'icon icon-add'`). Replaces `customer_actions_top` / `customer_actions_bottom`
|
||||
View Hook|:view_customers_show_contextual, { customer: @customer } | Used to add action links to the customer page's action area, under the title (return links styled like Redmine's, e.g. `link_to sprite_icon('add', 'Label'), path, class: 'icon icon-add'`). Replaces `customer_actions_top` / `customer_actions_bottom`
|
||||
View Hook|:pdf_left, { issue: issue } | Used to add text to left side of PDF
|
||||
View Hook|:pdf_right, { issue: issue } | Used to add text to right side of PDF
|
||||
View Hook|:show_customer_view_right, { customer: customer } | Used to show partials on right side of customer view
|
||||
@@ -231,6 +252,7 @@ Hook|:qbo_billing_field_options, { customer: } | Return `{ field_id => [{ value:
|
||||
View|:view_qbo_estimate_form_bottom, { form:, document: } | Add your plugin's script to the estimate/invoice editor. It can use `window.qboEditor` (`field(id)`, `fieldNamed(/name/)`, `setFieldOptions(id, options)`) and listen for `qbo:customer-changed` and `qbo:imported` on the form (redmine_qbo_vehicles fills the VIN and mileage)
|
||||
View|checkboxes with `data-new-issue-param="issue[field]"` on the customer page | Ticking one adds `issue[field]=value` to the New issue link, one per field (redmine_qbo's estimates, redmine_qbo_vehicles' vehicles)
|
||||
View Hook|:view_qbo_estimate_contextual, { estimate_id:, customer_id:, custom_fields:, doc_number: } | Adds links to an estimate page's action area (e.g. redmine_qbo_calendar's Add appointment); `custom_fields` is `{ field_id => value }`
|
||||
View Hook|:view_qbo_invoice_contextual, { invoice_id:, customer_id:, doc_number: } | Adds links to an invoice page's action area (e.g. redmine_qbo_labels' Print label)
|
||||
|
||||
Other plugins create estimates with `RedmineQboBilling::EstimateWriter.create_estimate(customer:, lines:, private_note:, custom_fields:, user:)`; `custom_fields` is `{ field_id => value }`, and each line is a hash of `description`, `item_id`, `quantity`, `rate` and `taxable`.
|
||||
|
||||
|
||||
@@ -0,0 +1,75 @@
|
||||
#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.
|
||||
|
||||
# Drafts on the new estimate and new invoice editors (see QboDraft). "Save draft" keeps what's filled in, even
|
||||
# if it isn't complete, and reopens it (new?draft_id=). Saving to QuickBooks deletes the draft.
|
||||
module QboDraftHandling
|
||||
extend ActiveSupport::Concern
|
||||
|
||||
private
|
||||
|
||||
# The draft named by draft_id (in the URL, or the editor's hidden field), if the user may open it
|
||||
def find_draft(document)
|
||||
@draft = (QboDraft.visible.for_document(document).find_by(id: params[:draft_id]) if params[:draft_id].present?)
|
||||
end
|
||||
|
||||
# The editor form filled in from a draft, with the details the editor shows but doesn't post
|
||||
def form_from_draft(draft)
|
||||
form = draft.form
|
||||
customer = Customer.find_by(id: form.customer_id) if form.customer_id.present?
|
||||
if customer
|
||||
form.billing_address = RedmineQboBilling::EstimateWriter.customer_address(customer)
|
||||
form.customer_name = customer.name if form.customer_name.blank?
|
||||
end
|
||||
# Invoices keep the sales person shown on the editor (e.g. from an estimate); estimates are always the user's
|
||||
form.sales_person = (draft.invoice? && draft.fields['sales_person'].presence) || User.current.name
|
||||
form.lines = form.lines.reject(&:blank?)
|
||||
form.lines += Array.new([2 - form.lines.size, 1].max) { RedmineQboBilling::EstimateForm::Line.new(quantity: '', taxable: true) }
|
||||
form
|
||||
end
|
||||
|
||||
# Saves what's on the editor as a draft (no checks: a draft can be missing anything) and reopens it
|
||||
def save_draft(document, fields)
|
||||
draft = @draft || QboDraft.new(document: document)
|
||||
fields = fields.to_h.stringify_keys
|
||||
draft.fields = fields
|
||||
draft.customer_id = (Customer.where(id: fields['customer_id']).pick(:id) if fields['customer_id'].present?)
|
||||
draft.user = User.current
|
||||
draft.save!
|
||||
flash[:notice] = l(:notice_qbo_draft_saved)
|
||||
redirect_to draft_editor_path(draft)
|
||||
end
|
||||
|
||||
# Saved to QuickBooks: the draft isn't needed any more
|
||||
def discard_draft
|
||||
@draft&.destroy
|
||||
@draft = nil
|
||||
end
|
||||
|
||||
# A new document for a customer who already has drafts of it: the editor points them out
|
||||
def load_customer_drafts(document, customer_id)
|
||||
@customer_drafts =
|
||||
if @draft.nil? && customer_id.present?
|
||||
QboDraft.visible.for_document(document).where(customer_id: customer_id).newest_first.to_a
|
||||
else
|
||||
[]
|
||||
end
|
||||
end
|
||||
|
||||
# A draft_id that's gone (e.g. finished or deleted by someone else): say so and list the drafts
|
||||
def draft_missing
|
||||
flash[:error] = l(:error_qbo_draft_not_found)
|
||||
redirect_to qbo_drafts_path
|
||||
end
|
||||
|
||||
def draft_editor_path(draft)
|
||||
draft.invoice? ? new_qbo_invoice_path(draft_id: draft.id) : new_qbo_estimate_path(draft_id: draft.id)
|
||||
end
|
||||
end
|
||||
@@ -117,13 +117,33 @@ class CustomersController < ApplicationController
|
||||
@filtered_invoices = Invoice.all.where(customer_id: params[:selected_customer])
|
||||
end
|
||||
|
||||
# Most matches a search lists (best first)
|
||||
SEARCH_LIMIT = 200
|
||||
|
||||
# Every customer, sortable and paged like Redmine's lists; a search narrows it to the best matches (a single
|
||||
# match opens that customer). Sorting a search's results by a column replaces the best-first order.
|
||||
def index
|
||||
if params[:search]
|
||||
@customers = CustomerSearchService.call(name: params[:search], limit: 200).paginate(page: params[:page])
|
||||
if only_one_non_zero?(@customers)
|
||||
redirect_to @customers.first
|
||||
end
|
||||
sort_init 'name', 'asc'
|
||||
sort_update 'name' => "#{Customer.table_name}.name",
|
||||
'phone' => "#{Customer.table_name}.phone_number",
|
||||
'mobile' => "#{Customer.table_name}.mobile_phone_number",
|
||||
'updated' => "#{Customer.table_name}.updated_at"
|
||||
|
||||
@search = params[:search].to_s.strip
|
||||
if @search.present?
|
||||
scope = CustomerSearchService.call(name: @search, limit: SEARCH_LIMIT)
|
||||
@best_first = params[:sort].blank?
|
||||
else
|
||||
scope = Customer.all
|
||||
end
|
||||
scope = scope.reorder(sort_clause).order(:id) unless @best_first
|
||||
|
||||
@customer_count = scope.count
|
||||
return redirect_to(scope.first) if @search.present? && @customer_count == 1
|
||||
|
||||
@customer_pages = Paginator.new @customer_count, per_page_option, params['page']
|
||||
@customers = scope.limit(@customer_pages.per_page).offset(@customer_pages.offset).to_a
|
||||
@issue_counts = Issue.where(customer_id: @customers.map(&:id)).group(:customer_id).count
|
||||
end
|
||||
|
||||
def load_issue_data
|
||||
@@ -157,17 +177,6 @@ class CustomersController < ApplicationController
|
||||
end
|
||||
end
|
||||
|
||||
def only_one_non_zero?(array)
|
||||
found_non_zero = false
|
||||
array.each do |val|
|
||||
if val != 0
|
||||
return false if found_non_zero
|
||||
found_non_zero = true
|
||||
end
|
||||
end
|
||||
found_non_zero
|
||||
end
|
||||
|
||||
def share
|
||||
issue = Issue.visible.find(params[:id])
|
||||
token = issue.share_token
|
||||
|
||||
@@ -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.
|
||||
|
||||
# Estimate and invoice drafts (QboDraft): all of them, and deleting one. Drafts are continued on the new
|
||||
# estimate/invoice editor (new?draft_id=). Users see the drafts of the documents they may write.
|
||||
class QboDraftsController < ApplicationController
|
||||
|
||||
before_action :authorize_global
|
||||
|
||||
def index
|
||||
@drafts = QboDraft.visible.includes(:customer, :user).newest_first.to_a
|
||||
end
|
||||
|
||||
def destroy
|
||||
draft = QboDraft.visible.find_by(id: params[:id])
|
||||
if draft
|
||||
draft.destroy
|
||||
flash[:notice] = l(:notice_qbo_draft_deleted)
|
||||
else
|
||||
flash[:error] = l(:error_qbo_draft_not_found)
|
||||
end
|
||||
redirect_back_or_default qbo_drafts_path
|
||||
end
|
||||
end
|
||||
@@ -10,6 +10,7 @@
|
||||
|
||||
# Writes, edits and emails QuickBooks estimates from Redmine, on a page laid out like QuickBooks' estimate screen.
|
||||
class QboEstimatesController < ApplicationController
|
||||
include QboDraftHandling
|
||||
|
||||
before_action :require_admin, only: :refresh_company
|
||||
before_action :authorize_global, except: :refresh_company
|
||||
@@ -25,26 +26,34 @@ class QboEstimatesController < ApplicationController
|
||||
# redmine_qbo raises plain errors when QuickBooks isn't connected or the token can't be refreshed
|
||||
RuntimeError].freeze
|
||||
|
||||
# A blank estimate, or a copy of another one (?duplicate=<estimate id>)
|
||||
# A blank estimate, a copy of another one (?duplicate=<estimate id>), or a draft (?draft_id=, see QboDraft)
|
||||
def new
|
||||
if params[:duplicate].present?
|
||||
if params[:draft_id].present?
|
||||
return draft_missing unless find_draft('estimate')
|
||||
@form = form_from_draft(@draft)
|
||||
elsif params[:duplicate].present?
|
||||
@form = RedmineQboBilling::EstimateWriter.duplicate_form(params[:duplicate], user: User.current)
|
||||
else
|
||||
customer = Customer.find_by(id: params[:customer_id]) if params[:customer_id].present?
|
||||
@form = RedmineQboBilling::EstimateWriter.new_form(customer: customer, user: User.current)
|
||||
end
|
||||
load_customer_drafts('estimate', @form.customer_id)
|
||||
rescue *QBO_ERRORS => e
|
||||
flash[:error] = qbo_message(e)
|
||||
redirect_back_or_default home_path
|
||||
end
|
||||
|
||||
def create
|
||||
find_draft('estimate')
|
||||
return save_draft('estimate', estimate_params) if params[:save_draft].present?
|
||||
|
||||
@form = RedmineQboBilling::EstimateForm.from_params(estimate_params)
|
||||
# Shown again if the save fails; the sales person is always the user creating the estimate
|
||||
@form.sales_person = User.current.name
|
||||
return show_invalid(:new) unless @form.valid?
|
||||
|
||||
saved = RedmineQboBilling::EstimateWriter.save(@form, user: User.current)
|
||||
discard_draft
|
||||
finish_save(saved, l(:notice_estimate_saved_in_quickbooks, number: saved.doc_number))
|
||||
rescue *QBO_ERRORS => e
|
||||
show_error(e, :new)
|
||||
@@ -92,7 +101,8 @@ class QboEstimatesController < ApplicationController
|
||||
def create_issues
|
||||
@rows = params[:lines].respond_to?(:to_unsafe_h) ? params[:lines].to_unsafe_h : {}
|
||||
@custom_field_values = submitted_custom_field_values
|
||||
created = @builder.create_issues(project: @target_project, rows: @rows, custom_field_values: @custom_field_values)
|
||||
# A parent was entered but can't be used: create nothing rather than top-level issues
|
||||
created = @parent_issue_error ? [] : @builder.create_issues(project: @target_project, rows: @rows, custom_field_values: @custom_field_values)
|
||||
|
||||
if created.any?
|
||||
Redmine::Hook.call_hook(:qbo_billing_issues_created, { estimate: @estimate, issues: created, params: params })
|
||||
@@ -116,13 +126,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)
|
||||
@@ -159,31 +175,97 @@ class QboEstimatesController < ApplicationController
|
||||
end
|
||||
return render_404 unless @estimate
|
||||
|
||||
# Values plugins' fields posted with the form (e.g. redmine_qbo_vehicles' vehicle) override their defaults
|
||||
@defaults = issue_defaults.merge(submitted_plugin_fields)
|
||||
@builder = RedmineQboBilling::EstimateIssueBuilder.new(@estimate, defaults: @defaults)
|
||||
load_parent_issue
|
||||
|
||||
@defaults = build_defaults
|
||||
@return_path = @defaults[:return_path].presence || edit_qbo_estimate_path(@estimate.id)
|
||||
@return_label = @defaults[:return_label].presence || "#{l(:label_estimate)} ##{@estimate.doc_number}"
|
||||
@available_projects = Project.allowed_to(User.current, :add_issues).sorted.to_a
|
||||
|
||||
# A project chosen on the page wins, then the one from another plugin (e.g. the appointment's), then the
|
||||
# default project from the settings, then the first project the user can add issues to
|
||||
# A project chosen on the page wins, then the parent issue's, then the one from another plugin (e.g. the
|
||||
# appointment's), then the default project from the settings, then the first project the user can add issues to
|
||||
chosen = @available_projects.detect { |p| p.id == params[:project_id].to_i } if params[:project_id].present?
|
||||
from_parent = @parent_issue.project if @parent_issue && @available_projects.include?(@parent_issue.project)
|
||||
from_hook = @defaults[:project] if @available_projects.include?(@defaults[:project])
|
||||
default_project = @available_projects.detect { |p| p.id == RedmineQboBilling::EstimateIssueBuilder.default_project_id }
|
||||
@target_project = chosen || from_hook || default_project || @available_projects.first
|
||||
@target_project = chosen || from_parent || from_hook || default_project || @available_projects.first
|
||||
return deny_access unless @target_project
|
||||
|
||||
# Subtasks need the "Manage subtasks" permission in the project they're created in
|
||||
@can_add_subtasks = User.current.allowed_to?(:manage_subtasks, @target_project)
|
||||
if @parent_issue && !@can_add_subtasks
|
||||
@parent_issue_error = l(:error_estimate_parent_not_allowed, project: @target_project.name)
|
||||
@parent_issue = nil
|
||||
@defaults = build_defaults
|
||||
end
|
||||
@builder = RedmineQboBilling::EstimateIssueBuilder.new(@estimate, defaults: @defaults, parent: @parent_issue)
|
||||
|
||||
@trackers = Issue.allowed_target_trackers(@target_project, User.current).to_a
|
||||
@default_tracker = @trackers.detect { |t| t.id == RedmineQboBilling::EstimateIssueBuilder.default_tracker_id } || @trackers.first
|
||||
@templates = RedmineQboBilling::IssueTemplateSupport.templates_for(@target_project)
|
||||
@field_set = RedmineQboBilling::IssueFieldSet.new(project: @target_project, trackers: @trackers)
|
||||
# With a parent issue, the shared fields start out with the parent's values
|
||||
@field_set = RedmineQboBilling::IssueFieldSet.new(project: @target_project, trackers: @trackers,
|
||||
values: parent_custom_field_values)
|
||||
@rows ||= {}
|
||||
rescue *QBO_ERRORS => e
|
||||
flash[:error] = qbo_message(e)
|
||||
redirect_back_or_default home_path
|
||||
end
|
||||
|
||||
# The optional parent issue (parent_issue_id, "#123" or "123"): the new issues become its subtasks.
|
||||
# Only an issue the user can see; an unknown one is reported and nothing is created.
|
||||
def load_parent_issue
|
||||
@parent_issue_id = params[:parent_issue_id].to_s.delete('#').strip
|
||||
return if @parent_issue_id.blank?
|
||||
|
||||
@parent_issue = Issue.visible.find_by(id: @parent_issue_id.to_i) if @parent_issue_id.match?(/\A\d+\z/)
|
||||
@parent_issue_error = l(:error_estimate_parent_not_found, id: @parent_issue_id) unless @parent_issue
|
||||
end
|
||||
|
||||
# What the new issues start from:
|
||||
# - dates: another plugin's (e.g. the appointment's), else the parent issue's
|
||||
# - vehicle: the parent issue's, else another plugin's (e.g. the appointment's)
|
||||
# Values posted with the form (the dates, plugins' fields such as redmine_qbo_vehicles' vehicle) win.
|
||||
def build_defaults
|
||||
parent_dates = {}
|
||||
parent_vehicle = {}
|
||||
if @parent_issue
|
||||
parent_dates = { start_date: @parent_issue.start_date, due_date: @parent_issue.due_date }.compact
|
||||
if @parent_issue.respond_to?(:vehicle_id) && @parent_issue.vehicle_id.present?
|
||||
parent_vehicle = { vehicle_id: @parent_issue.vehicle_id.to_s }
|
||||
end
|
||||
end
|
||||
|
||||
parent_dates.merge(issue_defaults.compact).merge(parent_vehicle).merge(submitted_plugin_fields).merge(submitted_dates)
|
||||
end
|
||||
|
||||
# The Start date / Due date entered on the page, only when the form was posted. A blank one means no date.
|
||||
def submitted_dates
|
||||
return {} unless request.post? && params[:issue_dates].respond_to?(:to_unsafe_h)
|
||||
|
||||
values = params[:issue_dates].to_unsafe_h
|
||||
%w[start_date due_date].each_with_object({}) do |key, dates|
|
||||
dates[key.to_sym] = parse_date(values[key]) if values.key?(key)
|
||||
end
|
||||
end
|
||||
|
||||
def parse_date(value)
|
||||
Date.iso8601(value.to_s.strip) if value.present?
|
||||
rescue ArgumentError
|
||||
nil
|
||||
end
|
||||
|
||||
# The parent issue's custom field values the user can see, to start the shared fields from: { id => value }
|
||||
def parent_custom_field_values
|
||||
return {} unless @parent_issue
|
||||
|
||||
@parent_issue.visible_custom_field_values.each_with_object({}) do |custom_value, values|
|
||||
next if Array(custom_value.value).all?(&:blank?)
|
||||
|
||||
values[custom_value.custom_field_id.to_s] = custom_value.value
|
||||
end
|
||||
end
|
||||
|
||||
# The first non-empty hash a plugin returns for :qbo_billing_issue_defaults
|
||||
def issue_defaults
|
||||
results = Redmine::Hook.call_hook(:qbo_billing_issue_defaults, { estimate: @estimate, params: params })
|
||||
|
||||
@@ -11,6 +11,7 @@
|
||||
# Writes, edits and emails QuickBooks invoices from Redmine, with the same editor as estimates, plus importing
|
||||
# billable time and open estimates. The customer and product searches are QboEstimatesController's.
|
||||
class QboInvoicesController < ApplicationController
|
||||
include QboDraftHandling
|
||||
|
||||
before_action :authorize_global
|
||||
before_action :require_sender_for_save_and_send, only: [:create, :update]
|
||||
@@ -18,8 +19,15 @@ class QboInvoicesController < ApplicationController
|
||||
|
||||
QBO_ERRORS = QboEstimatesController::QBO_ERRORS
|
||||
|
||||
# A blank invoice, or one made from an estimate (?estimate_id=<estimate id>)
|
||||
# A blank invoice, one made from an estimate (?estimate_id=<estimate id>), or a draft (?draft_id=, see
|
||||
# QboDraft). A draft stays in Redmine, so QuickBooks can't apply a deposit to it while it's being written.
|
||||
def new
|
||||
if params[:draft_id].present?
|
||||
return draft_missing unless find_draft('invoice')
|
||||
@form = form_from_draft(@draft)
|
||||
return
|
||||
end
|
||||
|
||||
@form =
|
||||
if params[:estimate_id].present?
|
||||
RedmineQboBilling::InvoiceWriter.from_estimate(params[:estimate_id], user: User.current)
|
||||
@@ -27,25 +35,33 @@ class QboInvoicesController < ApplicationController
|
||||
customer = Customer.find_by(id: params[:customer_id]) if params[:customer_id].present?
|
||||
RedmineQboBilling::InvoiceWriter.new_form(customer: customer, user: User.current)
|
||||
end
|
||||
load_customer_drafts('invoice', @form.customer_id)
|
||||
rescue *QBO_ERRORS => e
|
||||
flash[:error] = qbo_message(e)
|
||||
redirect_back_or_default home_path
|
||||
end
|
||||
|
||||
def create
|
||||
find_draft('invoice')
|
||||
# The sales person shown on the editor is kept with the draft
|
||||
return save_draft('invoice', invoice_params.to_h.merge('sales_person' => params.dig(:estimate, :sales_person).to_s)) if params[:save_draft].present?
|
||||
|
||||
@form = RedmineQboBilling::EstimateForm.from_params(invoice_params, document: 'invoice')
|
||||
# Display only (e.g. the estimate's sales person); InvoiceWriter.save works out what's saved
|
||||
@form.sales_person = params.dig(:estimate, :sales_person).presence || User.current.name
|
||||
return show_invalid(:new) unless @form.valid?
|
||||
|
||||
saved = RedmineQboBilling::InvoiceWriter.save(@form, user: User.current)
|
||||
discard_draft
|
||||
finish_save(saved, l(:notice_invoice_saved_in_quickbooks, number: saved.doc_number))
|
||||
rescue *QBO_ERRORS => e
|
||||
show_error(e, :new)
|
||||
end
|
||||
|
||||
# ?unlock=1 opens a paid invoice for editing anyway (after the editor's confirmation)
|
||||
def edit
|
||||
@form = RedmineQboBilling::InvoiceWriter.load(params[:id])
|
||||
unlock_form if unlock?
|
||||
rescue *QBO_ERRORS => e
|
||||
flash[:error] = qbo_message(e)
|
||||
redirect_back_or_default home_path
|
||||
@@ -54,9 +70,10 @@ class QboInvoicesController < ApplicationController
|
||||
def update
|
||||
@form = RedmineQboBilling::EstimateForm.from_params(invoice_params, id: params[:id], document: 'invoice')
|
||||
@form.sales_person = params.dig(:estimate, :sales_person).to_s
|
||||
unlock_form if unlock?
|
||||
return show_invalid(:edit) unless @form.valid?
|
||||
|
||||
saved = RedmineQboBilling::InvoiceWriter.save(@form, user: User.current)
|
||||
saved = RedmineQboBilling::InvoiceWriter.save(@form, user: User.current, unlock: unlock?)
|
||||
finish_save(saved, l(:notice_invoice_saved_in_quickbooks, number: saved.doc_number))
|
||||
rescue RedmineQboBilling::InvoiceWriter::Conflict => e
|
||||
@conflict = true
|
||||
@@ -99,6 +116,21 @@ class QboInvoicesController < ApplicationController
|
||||
)
|
||||
end
|
||||
|
||||
def unlock?
|
||||
params[:unlock].to_s == '1'
|
||||
end
|
||||
|
||||
# Shows a paid invoice editable, with the amount paid on it (posted back with the form when saving), for
|
||||
# users allowed to edit it (paid off or partly paid). InvoiceWriter.save checks again against QuickBooks.
|
||||
def unlock_form
|
||||
@form.amount_paid ||= RedmineQboBilling::EstimateForm.decimal(params.dig(:estimate, :amount_paid))
|
||||
return unless @form.locked == :paid || @form.locked.nil?
|
||||
return unless RedmineQboBilling.paid_invoice_editor?(@form.fully_paid?)
|
||||
|
||||
@form.locked = nil
|
||||
@form.unlocked = true
|
||||
end
|
||||
|
||||
def save_and_send?
|
||||
params[:save_and_send].present?
|
||||
end
|
||||
|
||||
@@ -9,8 +9,8 @@
|
||||
#THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
||||
|
||||
# Receives customer payments in QuickBooks: payment type and amount, applied to open invoices oldest first, or
|
||||
# saved as a deposit. A saved payment can be printed (QuickBooks' payment PDF). A customer's payments are
|
||||
# listed on their payments page.
|
||||
# saved as a deposit. A saved payment can be edited and printed (QuickBooks' payment PDF). A customer's
|
||||
# payments are listed on their payments page.
|
||||
class QboPaymentsController < ApplicationController
|
||||
|
||||
before_action :authorize_global, except: :sync
|
||||
@@ -56,6 +56,31 @@ class QboPaymentsController < ApplicationController
|
||||
show_form
|
||||
end
|
||||
|
||||
def edit
|
||||
@form = RedmineQboBilling::PaymentWriter.load_form(params[:id])
|
||||
load_choices
|
||||
rescue *QBO_ERRORS => e
|
||||
flash[:error] = qbo_message(e)
|
||||
redirect_back_or_default home_path
|
||||
end
|
||||
|
||||
def update
|
||||
@form = RedmineQboBilling::PaymentForm.from_params(payment_params, id: params[:id])
|
||||
return show_form unless @form.valid?
|
||||
|
||||
payment = RedmineQboBilling::PaymentWriter.save(@form)
|
||||
flash[:notice] = l(:notice_payment_updated, amount: view_context.number_to_currency(payment.total))
|
||||
redirect_to qbo_payment_path(payment.id)
|
||||
rescue RedmineQboBilling::PaymentWriter::Conflict => e
|
||||
@conflict = true
|
||||
@form.errors.add(:base, qbo_message(e))
|
||||
show_form
|
||||
rescue *QBO_ERRORS => e
|
||||
logger.warn "[RedmineQboBilling] #{e.class}: #{qbo_message(e)}"
|
||||
@form.errors.add(:base, qbo_message(e))
|
||||
show_form
|
||||
end
|
||||
|
||||
def show
|
||||
@payment = RedmineQboBilling::PaymentWriter.load(params[:id])
|
||||
@customer = Customer.find_by(id: @payment.customer_ref&.value)
|
||||
@@ -86,13 +111,15 @@ class QboPaymentsController < ApplicationController
|
||||
private
|
||||
|
||||
def payment_params
|
||||
params.require(:payment).permit(*RedmineQboBilling::PaymentForm::ATTRIBUTES, invoice_ids: [])
|
||||
params.require(:payment).permit(*RedmineQboBilling::PaymentForm::ATTRIBUTES, :sync_token, invoice_ids: [])
|
||||
end
|
||||
|
||||
def load_choices
|
||||
@payment_methods = RedmineQboBilling::PaymentWriter.payment_methods
|
||||
customer = Customer.find_by(id: @form.customer_id) if @form.customer_id.present?
|
||||
@open_invoices = customer ? RedmineQboBilling::PaymentWriter.open_invoices(customer) : []
|
||||
# Editing: the invoices this payment pays count as open (by what it paid on them)
|
||||
payment = RedmineQboBilling::PaymentWriter.load(@form.id) if @form.persisted?
|
||||
@open_invoices = customer ? RedmineQboBilling::PaymentWriter.open_invoices(customer, payment: payment) : []
|
||||
rescue *QBO_ERRORS => e
|
||||
@open_invoices = []
|
||||
flash.now[:error] = qbo_message(e)
|
||||
@@ -100,7 +127,7 @@ class QboPaymentsController < ApplicationController
|
||||
|
||||
def show_form
|
||||
load_choices
|
||||
render :new, status: :unprocessable_entity
|
||||
render(@form.persisted? ? :edit : :new, status: :unprocessable_entity)
|
||||
end
|
||||
|
||||
def qbo_message(error)
|
||||
|
||||
@@ -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
|
||||
@@ -15,10 +15,48 @@ class QboReportsController < ApplicationController
|
||||
|
||||
before_action :authorize_global
|
||||
|
||||
# The user's preference holding the projects the report opens with
|
||||
PROJECTS_PREF = :qbo_report_project_ids
|
||||
|
||||
def index
|
||||
# Projects for the issues and spent time: the projects picker can choose some of the open ones
|
||||
@projects = Project.visible.active.to_a
|
||||
@project_ids = report_project_ids
|
||||
@report = RedmineQboBilling::BusinessReport.new(period: params[:period].presence || 'this_year',
|
||||
from: params[:from], to: params[:to], today: User.current.today)
|
||||
from: params[:from], to: params[:to], today: User.current.today,
|
||||
week_start: RedmineQboBilling::BusinessReport.week_start_from_setting(Setting.start_of_week),
|
||||
project_ids: @project_ids)
|
||||
# Last year's lines on the charts
|
||||
@compare = params[:compare] == '1'
|
||||
# Syncs still running for what the report counts: its figures are incomplete until they finish
|
||||
@syncing = QboSyncStatus.by_entity(%w[Estimate Invoice Payment]).values.sort_by(&:entity)
|
||||
end
|
||||
|
||||
private
|
||||
|
||||
# The form's projects (none picked is every project), or the user's saved ones when the address has none.
|
||||
# "Remember these projects" saves the form's choice. Only open projects the user can see are kept.
|
||||
def report_project_ids
|
||||
visible = @projects.map(&:id)
|
||||
if params.key?(:project_ids)
|
||||
ids = Array(params[:project_ids]).map(&:to_i) & visible
|
||||
save_project_ids(ids) if params[:save_projects] == '1'
|
||||
else
|
||||
ids = saved_project_ids & visible
|
||||
end
|
||||
@saved_project_ids = saved_project_ids & visible
|
||||
ids
|
||||
end
|
||||
|
||||
def saved_project_ids
|
||||
return [] unless User.current.logged?
|
||||
Array(User.current.pref[PROJECTS_PREF]).map(&:to_i)
|
||||
end
|
||||
|
||||
def save_project_ids(ids)
|
||||
return unless User.current.logged?
|
||||
pref = User.current.pref
|
||||
pref[PROJECTS_PREF] = ids
|
||||
pref.save
|
||||
end
|
||||
end
|
||||
@@ -10,12 +10,13 @@
|
||||
|
||||
class QboSyncDispatcher
|
||||
|
||||
# Payments before invoices: an invoice's paid-in-full day is worked out from the local payments' dates
|
||||
SYNC_JOBS = [
|
||||
Customer,
|
||||
Estimate,
|
||||
Payment,
|
||||
Invoice,
|
||||
Employee,
|
||||
Payment
|
||||
Employee
|
||||
].freeze
|
||||
|
||||
# Dispatches all synchronization jobs to perform a full sync of QuickBooks entities with the local database.
|
||||
|
||||
@@ -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
|
||||
@@ -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
|
||||
@@ -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
|
||||
|
||||
@@ -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)
|
||||
|
||||
@@ -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
@@ -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
|
||||
|
||||
@@ -0,0 +1,74 @@
|
||||
#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 new estimate or invoice saved part way, in Redmine only. Nothing is in QuickBooks until it's saved from
|
||||
# the editor, so QuickBooks can't apply a deposit to an invoice that's still being written. Drafts are shared:
|
||||
# anyone with Write estimates (or Write invoices) can continue or delete any estimate (or invoice) draft.
|
||||
class QboDraft < ApplicationRecord
|
||||
DOCUMENTS = %w[estimate invoice].freeze
|
||||
|
||||
belongs_to :customer, optional: true
|
||||
# Who saved it last
|
||||
belongs_to :user, optional: true
|
||||
|
||||
validates :document, inclusion: { in: DOCUMENTS }
|
||||
|
||||
scope :newest_first, -> { order(updated_at: :desc, id: :desc) }
|
||||
scope :for_document, ->(document) { where(document: document.to_s) }
|
||||
|
||||
# The drafts a user may open: estimate drafts need Write estimates, invoice drafts Write invoices
|
||||
scope :visible, lambda { |user = User.current|
|
||||
documents = []
|
||||
documents << 'estimate' if RedmineQboBilling.writer?(user)
|
||||
documents << 'invoice' if RedmineQboBilling.invoice_writer?(user)
|
||||
where(document: documents)
|
||||
}
|
||||
|
||||
def self.writable_document?(document, user = User.current)
|
||||
case document.to_s
|
||||
when 'estimate' then RedmineQboBilling.writer?(user)
|
||||
when 'invoice' then RedmineQboBilling.invoice_writer?(user)
|
||||
else false
|
||||
end
|
||||
end
|
||||
|
||||
# The editor's fields as posted (estimate[...])
|
||||
def fields
|
||||
parsed = JSON.parse(data.presence || '{}')
|
||||
parsed.is_a?(Hash) ? parsed : {}
|
||||
rescue JSON::ParserError
|
||||
{}
|
||||
end
|
||||
|
||||
def fields=(hash)
|
||||
self.data = hash.to_h.to_json
|
||||
end
|
||||
|
||||
# The editor form, filled in as it was saved
|
||||
def form
|
||||
RedmineQboBilling::EstimateForm.from_params(fields, document: document)
|
||||
end
|
||||
|
||||
def invoice?
|
||||
document == 'invoice'
|
||||
end
|
||||
|
||||
def customer_name
|
||||
customer&.name.presence || fields['customer_name'].presence
|
||||
end
|
||||
|
||||
def subtotal
|
||||
form.subtotal
|
||||
end
|
||||
|
||||
def line_count
|
||||
form.filled_lines.count { |line| !line.subtotal? }
|
||||
end
|
||||
end
|
||||
@@ -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
|
||||
@@ -30,6 +30,8 @@ class EstimateSyncService < SyncServiceBase
|
||||
map_attribute :txn_status
|
||||
# Man-hours: quantities of the labor products/services (plugin settings)
|
||||
map_attribute(:hours) { |remote| RedmineQboBilling::ManHours.hours(remote) }
|
||||
# Sales tax, so the business report can compare estimates and invoices without it
|
||||
map_attribute(:tax_amount) { |remote| RedmineQboBilling::InvoicePaidOn.tax(remote) }
|
||||
map_belongs_to :customer
|
||||
|
||||
end
|
||||
@@ -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 = []
|
||||
|
||||
@@ -27,6 +27,9 @@ class InvoiceSyncService < SyncServiceBase
|
||||
# Man-hours: quantities of the labor products/services (plugin settings)
|
||||
map_attribute(:hours) { |remote| RedmineQboBilling::ManHours.hours(remote) }
|
||||
map_attribute :qbo_updated_at, "meta_data.last_updated_time"
|
||||
# Sales tax, and the day it was paid in full (nil while open), for reports such as monthly paid sales
|
||||
map_attribute(:tax_amount) { |remote| RedmineQboBilling::InvoicePaidOn.tax(remote) }
|
||||
map_attribute(:paid_on) { |remote| RedmineQboBilling::InvoicePaidOn.paid_on(remote) }
|
||||
map_belongs_to :customer
|
||||
|
||||
end
|
||||
@@ -1,24 +1,71 @@
|
||||
<h2><%=t(:field_customers)%> <span style="float:right"> <%= render partial: 'customers/search' %> </span> </h2>
|
||||
<% if @customers.present? %>
|
||||
<br/>
|
||||
<% @customers.each do |c| %>
|
||||
<div class="row">
|
||||
<div class="span6 columns">
|
||||
<%= link_to c, customer_path(c.id) %>
|
||||
</div>
|
||||
</div>
|
||||
<% html_title l(:label_customers) %>
|
||||
<% phone = ->(digits) { digits.present? ? number_to_phone(digits.gsub(/\D/, '').to_i, area_code: true) : '' } %>
|
||||
|
||||
<div class="contextual">
|
||||
<% if User.current.allowed_to?(:add_customers, nil, global: true) %>
|
||||
<%= link_to sprite_icon('add', l(:label_new_customer)), new_customer_path, class: 'icon icon-add' %>
|
||||
<% end %>
|
||||
<%# Estimate and invoice drafts, for users who may write either %>
|
||||
<% if RedmineQboBilling.writer? || RedmineQboBilling.invoice_writer? %>
|
||||
<% draft_count = QboDraft.visible.count %>
|
||||
<%= link_to sprite_icon('document', "#{l(:label_qbo_drafts)} (#{draft_count})"), qbo_drafts_path, class: 'icon icon-document' %>
|
||||
<% end %>
|
||||
<% if User.current.admin? %>
|
||||
<%= link_to sprite_icon('reload', l(:label_sync)), qbo_sync_path, class: 'icon icon-reload' %>
|
||||
<% end %>
|
||||
|
||||
<p><%=t(:label_matching)%> <%= @customers.count %> <%=t(:field_customers)%> </p>
|
||||
|
||||
<div class="actions">
|
||||
<%= will_paginate @customers %>
|
||||
</div>
|
||||
|
||||
<% else %>
|
||||
<p><%=t(:label_no_customers)%> <%= params[:search] %>.</p>
|
||||
<h2><%= l(:label_customers) %></h2>
|
||||
|
||||
<%= form_tag(customers_path, method: :get, id: 'customer-search-form') do %>
|
||||
<p class="qbo-customer-search">
|
||||
<%= text_field_tag :search, @search, class: 'customer-name', size: 40, placeholder: t(:label_search_customers),
|
||||
autocomplete: 'off', data: { autocomplete_url: '/customers/autocomplete' } %>
|
||||
<%= submit_tag l(:label_search), name: nil %>
|
||||
<% if @search.present? %>
|
||||
<%= link_to sprite_icon('reload', l(:button_clear)), customers_path, class: 'icon icon-reload' %>
|
||||
<% end %>
|
||||
</p>
|
||||
<% end %>
|
||||
|
||||
<div>
|
||||
<%= render partial: 'qbo/stats' %>
|
||||
</div>
|
||||
<% if @customers.empty? %>
|
||||
<p class="nodata"><%= @search.present? ? l(:label_no_customers, search: @search) : l(:label_no_data) %></p>
|
||||
<% else %>
|
||||
<% if @best_first %>
|
||||
<p class="info"><%= l(:text_customers_best_match, count: @customer_count) %></p>
|
||||
<% end %>
|
||||
<div class="autoscroll">
|
||||
<table class="list customers odd-even">
|
||||
<thead>
|
||||
<tr>
|
||||
<%= sort_header_tag('name', caption: l(:field_name)) %>
|
||||
<%= sort_header_tag('phone', caption: l(:label_primary_phone)) %>
|
||||
<%= sort_header_tag('mobile', caption: l(:label_mobile_phone)) %>
|
||||
<th><%= l(:label_issue_plural) %></th>
|
||||
<%= sort_header_tag('updated', caption: l(:field_updated_on), default_order: 'desc') %>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<% @customers.each do |customer| %>
|
||||
<tr class="<%= cycle('odd', 'even') %>">
|
||||
<td class="name"><%= link_to customer.name, customer_path(customer.id) %></td>
|
||||
<td class="phone"><%= phone.call(customer.phone_number) %></td>
|
||||
<td class="phone"><%= phone.call(customer.mobile_phone_number) %></td>
|
||||
<td class="issues"><%= @issue_counts[customer.id] || 0 %></td>
|
||||
<td class="updated_on"><%= format_time(customer.updated_at) if customer.updated_at %></td>
|
||||
</tr>
|
||||
<% end %>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
<span class="pagination"><%= pagination_links_full @customer_pages, @customer_count %></span>
|
||||
<% end %>
|
||||
|
||||
<p class="qbo-customer-stats"><%= render partial: 'qbo/stats' %></p>
|
||||
|
||||
<style>
|
||||
table.customers td.name { text-align: left; }
|
||||
table.customers td.phone, table.customers td.updated_on { white-space: nowrap; }
|
||||
table.customers td.issues { width: 1%; text-align: center; }
|
||||
.qbo-customer-search input { vertical-align: middle; }
|
||||
</style>
|
||||
@@ -1,11 +1,16 @@
|
||||
<div class="contextual">
|
||||
<% html_title @customer.to_s %>
|
||||
|
||||
<h2><%= link_to l(:label_customers), customers_path %> » <%= @customer.to_s %></h2>
|
||||
|
||||
<%# Under the title rather than beside it, so a long name and the many actions don't crowd each other %>
|
||||
<div class="contextual qbo-under-title">
|
||||
<%# New issue for this customer; picks up what's ticked on this page (an estimate, other plugins' items) %>
|
||||
<%= link_to sprite_icon('add', l(:label_new_issue)), new_issue_path(issue: { customer_id: @customer.id }),
|
||||
id: 'dynamic-new-issue-link', class: 'icon icon-add', target: :_blank %>
|
||||
<%# Plugins add their customer actions here (e.g. redmine_qbo_calendar's Add appointment) %>
|
||||
<%= call_hook :view_customers_show_contextual, { customer: @customer } %>
|
||||
<%# Estimates, invoices and payments are handled here, each shown to users with its permission. The customer's
|
||||
name below links to their QuickBooks account page as a fallback. %>
|
||||
<%# Estimates, invoices and payments are handled here, each shown to users with its permission; Open in
|
||||
QuickBooks goes to their QuickBooks account page for anything else. %>
|
||||
<% if RedmineQboBilling.writer? %>
|
||||
<%= render partial: 'qbo_estimates/customer_link', locals: { customer: @customer } %>
|
||||
<% end %>
|
||||
@@ -18,13 +23,17 @@
|
||||
<% 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) %>
|
||||
<% end %>
|
||||
<%= link_to sprite_icon('link', l(:button_open_in_quickbooks)),
|
||||
"https://#{RedmineQbo.sandbox_mode? ? 'sandbox' : 'app'}.qbo.intuit.com/app/customerdetail?nameId=#{@customer.id}",
|
||||
class: 'icon icon-link', target: :_blank, rel: 'noopener' %>
|
||||
</div>
|
||||
|
||||
<h2><%=t(:field_customer)%> #<%= @customer.id %> - <%= link_to @customer.to_s, "https://#{RedmineQbo.sandbox_mode? ? "sandbox" : "app"}.qbo.intuit.com/app/customerdetail?nameId=#{@customer.id}", target: :_blank %> </h2>
|
||||
<div class="issue">
|
||||
|
||||
<div class="splitcontent">
|
||||
@@ -52,6 +61,34 @@
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<%# Estimate and invoice drafts, kept in Redmine until they're saved to QuickBooks %>
|
||||
<% customer_drafts = QboDraft.visible.where(customer_id: @customer.id).includes(:user).newest_first.to_a %>
|
||||
<% if customer_drafts.any? %>
|
||||
<h4><%= l(:label_qbo_drafts) %>:</h4>
|
||||
<%= 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">
|
||||
|
||||
@@ -18,7 +18,7 @@
|
||||
<b><%= link_to "##{invoice.doc_number}", invoice_path(invoice), target: :_blank %></b> <%= invoice.txn_date %>
|
||||
<%# Paid / partially paid / overdue / open / voided, from the cached balance and due date %>
|
||||
<% if (status = invoice.status) %>
|
||||
<span class="qbo-estimate-status qbo-invoice-status-<%= status %>"><%= RedmineQboBilling::InvoiceStatus.label(status) %></span>
|
||||
<span class="qbo-estimate-status qbo-invoice-status-<%= status %>"><%= RedmineQboBilling::InvoiceStatus.label(status, paid_on: invoice.paid_on) %></span>
|
||||
<% end %>
|
||||
<%= render partial: 'qbo_invoices/invoice_actions', locals: { invoice: invoice } if RedmineQboBilling.invoice_writer? %>
|
||||
</div>
|
||||
|
||||
@@ -10,6 +10,12 @@
|
||||
<div class="value">
|
||||
<%= estimate_link %>
|
||||
<%= render partial: 'qbo_estimates/estimate_actions', locals: { estimate: issue.estimate } if issue.estimate && RedmineQboBilling.writer? %>
|
||||
<%# Create the estimate's remaining labor lines as subtasks of this issue %>
|
||||
<% if issue.estimate && User.current.allowed_to?(:create_estimate_issues, nil, global: true) && User.current.allowed_to?(:manage_subtasks, issue.project) %>
|
||||
<%= link_to sprite_icon('add', l(:button_create_estimate_subtasks)),
|
||||
issues_preview_qbo_estimate_path(issue.estimate.id, parent_issue_id: issue.id),
|
||||
class: 'icon-only icon-add', title: l(:button_create_estimate_subtasks) %>
|
||||
<% end %>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
@@ -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 %>
|
||||
@@ -36,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,18 @@
|
||||
<%# On the new estimate/invoice editor: the draft being continued, or the customer's other drafts of this
|
||||
document so a second one isn't started by accident %>
|
||||
<% draft = local_assigns[:draft] %>
|
||||
<% drafts = local_assigns[:drafts] || [] %>
|
||||
<% if draft %>
|
||||
<div class="flash notice qbo-draft-notice">
|
||||
<%= l(:text_qbo_editing_draft, user: h(draft.user&.name || l(:label_user_anonymous)), age: time_tag(draft.updated_at)).html_safe %>
|
||||
</div>
|
||||
<% elsif drafts.any? %>
|
||||
<div class="warning qbo-estimate-notice qbo-draft-notice">
|
||||
<%= l(drafts.first.invoice? ? :text_qbo_customer_has_invoice_drafts : :text_qbo_customer_has_estimate_drafts, count: drafts.size) %>
|
||||
<% drafts.each do |other| %>
|
||||
<%= link_to l(:text_qbo_draft_link, user: other.user&.name || l(:label_user_anonymous),
|
||||
subtotal: number_to_currency(other.subtotal), date: format_time(other.updated_at)),
|
||||
other.invoice? ? new_qbo_invoice_path(draft_id: other.id) : new_qbo_estimate_path(draft_id: other.id) %>
|
||||
<% end %>
|
||||
</div>
|
||||
<% end %>
|
||||
@@ -0,0 +1,40 @@
|
||||
<%# Estimate and invoice drafts (QboDraft) with Continue and Delete. show_customer: false on a customer's page. %>
|
||||
<% show_customer = local_assigns.fetch(:show_customer, true) %>
|
||||
<table class="list qbo-drafts">
|
||||
<thead>
|
||||
<tr>
|
||||
<th><%= l(:label_qbo_draft_document) %></th>
|
||||
<% if show_customer %><th><%= l(:field_customer) %></th><% end %>
|
||||
<th class="qbo-draft-number"><%= l(:label_qbo_draft_lines) %></th>
|
||||
<th class="qbo-draft-number"><%= l(:label_subtotal) %></th>
|
||||
<th><%= l(:label_qbo_draft_saved_by) %></th>
|
||||
<th></th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<% drafts.each do |draft| %>
|
||||
<tr>
|
||||
<td><%= link_to l(draft.invoice? ? :label_qbo_invoice_draft : :label_qbo_estimate_draft),
|
||||
draft.invoice? ? new_qbo_invoice_path(draft_id: draft.id) : new_qbo_estimate_path(draft_id: draft.id) %></td>
|
||||
<% if show_customer %>
|
||||
<td><%= draft.customer ? link_to(draft.customer.name, customer_path(draft.customer)) : (draft.customer_name || '–') %></td>
|
||||
<% end %>
|
||||
<td class="qbo-draft-number"><%= draft.line_count %></td>
|
||||
<td class="qbo-draft-number"><%= number_to_currency(draft.subtotal) %></td>
|
||||
<td><%= l(:text_qbo_draft_saved_by, user: h(draft.user&.name || l(:label_user_anonymous)), age: time_tag(draft.updated_at)).html_safe %></td>
|
||||
<td class="buttons">
|
||||
<%= link_to sprite_icon('edit', l(:button_qbo_continue_draft)),
|
||||
draft.invoice? ? new_qbo_invoice_path(draft_id: draft.id) : new_qbo_estimate_path(draft_id: draft.id),
|
||||
class: 'icon icon-edit' %>
|
||||
<%= link_to sprite_icon('del', l(:button_delete)), qbo_draft_path(draft), method: :delete,
|
||||
data: { confirm: l(:text_are_you_sure) }, class: 'icon icon-del' %>
|
||||
</td>
|
||||
</tr>
|
||||
<% end %>
|
||||
</tbody>
|
||||
</table>
|
||||
<style>
|
||||
table.qbo-drafts td, table.qbo-drafts th { text-align: left; }
|
||||
table.qbo-drafts .qbo-draft-number { text-align: right; white-space: nowrap; }
|
||||
table.qbo-drafts td.buttons { white-space: nowrap; }
|
||||
</style>
|
||||
@@ -0,0 +1,11 @@
|
||||
<% html_title l(:label_qbo_drafts) %>
|
||||
|
||||
<h2><%= link_to l(:label_customers), customers_path %> » <%= l(:label_qbo_drafts) %></h2>
|
||||
|
||||
<p class="info"><%= l(:text_qbo_drafts_info) %></p>
|
||||
|
||||
<% if @drafts.any? %>
|
||||
<%= render partial: 'qbo_drafts/list', locals: { drafts: @drafts } %>
|
||||
<% else %>
|
||||
<p class="nodata"><%= l(:label_no_data) %></p>
|
||||
<% end %>
|
||||
@@ -10,6 +10,11 @@
|
||||
settings_read = company.settings.present?
|
||||
# The same editor writes estimates and invoices
|
||||
invoice = form.invoice?
|
||||
# The discount box, unless QuickBooks has discounts turned off or the document is read-only (shown anyway
|
||||
# for a document that has one)
|
||||
show_discount = form.discount? || (company.discounts_allowed? && !form.locked)
|
||||
# The draft being continued (QboDraft), if any; new documents can be saved as drafts
|
||||
draft = local_assigns[:draft]
|
||||
sender = invoice ? RedmineQboBilling.invoice_sender? : RedmineQboBilling.sender?
|
||||
cancel_path = customer ? customer_path(customer) : home_path
|
||||
form_url =
|
||||
@@ -38,6 +43,7 @@
|
||||
warn_unsaved: User.current.pref.warn_on_leaving_unsaved != '0'
|
||||
}) do %>
|
||||
<%= hidden_field_tag 'estimate[sync_token]', form.sync_token, id: nil %>
|
||||
<%= hidden_field_tag 'draft_id', draft.id, id: nil if draft %>
|
||||
<%= hidden_field_tag 'estimate[total_tax]', form.total_tax, id: nil %>
|
||||
<%= hidden_field_tag 'estimate[discount]', form.discount, id: nil %>
|
||||
<%= hidden_field_tag 'estimate[email_status]', form.email_status, id: nil %>
|
||||
@@ -46,6 +52,11 @@
|
||||
<%= hidden_field_tag 'estimate[sales_person]', form.sales_person, id: nil if form.persisted? || form.invoice? %>
|
||||
<% if invoice %>
|
||||
<%= hidden_field_tag 'estimate[balance]', form.balance, id: nil %>
|
||||
<%# A paid invoice opened for editing (Unlock) stays unlocked if the page is shown again %>
|
||||
<% if form.unlocked %>
|
||||
<%= hidden_field_tag 'unlock', '1', id: nil %>
|
||||
<%= hidden_field_tag 'estimate[amount_paid]', form.amount_paid, id: nil %>
|
||||
<% end %>
|
||||
<%# Estimates whose lines are on this invoice; the Import panel adds more %>
|
||||
<span id="qbo-linked-estimates">
|
||||
<% form.linked_estimate_ids.each do |estimate_id| %>
|
||||
@@ -259,10 +270,18 @@
|
||||
<th><%= l(:label_taxable_subtotal) %></th>
|
||||
<td id="qbo-estimate-taxable-subtotal"></td>
|
||||
</tr>
|
||||
<% if form.discount.to_f != 0 %>
|
||||
<tr>
|
||||
<th><%= l(:label_discount_from_quickbooks) %></th>
|
||||
<td>-<%= number_to_currency(form.discount) %></td>
|
||||
<% if show_discount %>
|
||||
<%# A percent of the subtotal or a dollar amount; QuickBooks' discount line %>
|
||||
<tr class="qbo-estimate-discount">
|
||||
<th>
|
||||
<label for="qbo_estimate_discount_value"><%= l(:label_discount_from_quickbooks) %></label>
|
||||
<%= text_field_tag 'estimate[discount_value]', form.discount_value, id: 'qbo_estimate_discount_value',
|
||||
size: 6, inputmode: 'decimal', autocomplete: 'off', placeholder: '0' %>
|
||||
<%= select_tag 'estimate[discount_type]',
|
||||
options_for_select([[l(:label_discount_percent), 'percent'], [l(:label_discount_amount), 'amount']], form.discount_type),
|
||||
id: 'qbo_estimate_discount_type', 'aria-label': l(:label_discount_type) %>
|
||||
</th>
|
||||
<td id="qbo-estimate-discount"><%= "-#{number_to_currency(form.discount_amount)}" if form.discount? %></td>
|
||||
</tr>
|
||||
<% end %>
|
||||
<tr>
|
||||
@@ -279,14 +298,26 @@
|
||||
</fieldset>
|
||||
|
||||
<%# Action bar, like the bar along the bottom of QuickBooks' estimate screen %>
|
||||
<div class="qbo-estimate-actions">
|
||||
<div class="qbo-estimate-actions" data-saving-text="<%= l(:text_qbo_saving) %>">
|
||||
<%= link_to l(:button_cancel), cancel_path, class: 'qbo-button qbo-button-dark', id: 'qbo-estimate-cancel' %>
|
||||
<% unless form.locked %>
|
||||
<span class="qbo-estimate-actions-save">
|
||||
<%# Shown while a save is on its way to QuickBooks (qbo_estimates/_script) %>
|
||||
<span class="qbo-saving-status" role="status" aria-live="polite" hidden></span>
|
||||
<% unless form.persisted? %>
|
||||
<%# Kept in Redmine only, however incomplete (QboDraftHandling) %>
|
||||
<% if draft %>
|
||||
<%= link_to l(:button_qbo_delete_draft), qbo_draft_path(draft), method: :delete,
|
||||
data: { confirm: l(:text_are_you_sure) }, class: 'qbo-button qbo-button-dark', id: 'qbo-delete-draft' %>
|
||||
<% end %>
|
||||
<%= submit_tag l(:button_qbo_save_draft), name: 'save_draft', class: 'qbo-button qbo-button-dark',
|
||||
id: 'qbo-save-draft', formnovalidate: true, data: { saving_text: l(:text_qbo_saving_draft) } %>
|
||||
<% end %>
|
||||
<%= submit_tag l(:button_save), name: 'save', class: 'qbo-button qbo-button-dark' %>
|
||||
<% if sender %>
|
||||
<%= submit_tag l(:button_save_and_send), name: 'save_and_send', class: 'qbo-button qbo-button-primary',
|
||||
id: 'qbo-estimate-save-and-send', data: { needs_email_text: l(:text_estimate_send_needs_email) } %>
|
||||
id: 'qbo-estimate-save-and-send',
|
||||
data: { needs_email_text: l(:text_estimate_send_needs_email), saving_text: l(:text_qbo_saving_and_sending) } %>
|
||||
<% end %>
|
||||
</span>
|
||||
<% end %>
|
||||
|
||||
@@ -20,7 +20,8 @@
|
||||
due_date: RedmineQboBilling::EstimateForm.date(form.due_date),
|
||||
today: User.current.today) %>
|
||||
<% if status %>
|
||||
<span class="qbo-estimate-status qbo-invoice-status-<%= status %>"><%= RedmineQboBilling::InvoiceStatus.label(status) %></span>
|
||||
<% paid_on = Invoice.where(id: form.id).pick(:paid_on) if status == :paid && form.id.present? %>
|
||||
<span class="qbo-estimate-status qbo-invoice-status-<%= status %>"><%= RedmineQboBilling::InvoiceStatus.label(status, paid_on: paid_on) %></span>
|
||||
<% end %>
|
||||
<% elsif !invoice && form.txn_status.present? %>
|
||||
<span class="qbo-estimate-status qbo-estimate-status-<%= form.txn_status.downcase %>"><%= form.txn_status %></span>
|
||||
@@ -68,7 +69,17 @@
|
||||
</ul>
|
||||
</div>
|
||||
<% elsif form.locked == :paid %>
|
||||
<p class="warning"><%= l(:error_invoice_paid) %></p>
|
||||
<p class="warning">
|
||||
<%= l(:error_invoice_paid) %>
|
||||
<%# Opened for editing anyway after a confirmation (e.g. a discount after a deposit) %>
|
||||
<% if RedmineQboBilling.paid_invoice_editor?(form.fully_paid?) %>
|
||||
<%= link_to sprite_icon('unlock', l(:button_unlock_invoice)), edit_qbo_invoice_path(form.id, unlock: 1),
|
||||
class: 'icon icon-unlock', id: 'qbo-unlock-invoice',
|
||||
data: { confirm: l(:text_unlock_invoice_confirmation) } %>
|
||||
<% end %>
|
||||
</p>
|
||||
<% elsif form.unlocked && form.amount_paid.to_d > 0 %>
|
||||
<p class="warning"><%= l(:text_invoice_unlocked, paid: number_to_currency(form.amount_paid)) %></p>
|
||||
<% elsif form.locked == :bundles %>
|
||||
<p class="warning"><%= l(invoice ? :error_invoice_has_bundles : :error_estimate_has_bundles) %></p>
|
||||
<% end %>
|
||||
|
||||
@@ -36,8 +36,10 @@ $(function () {
|
||||
var money = new Intl.NumberFormat(<%= raw (current_language.to_s.presence || 'en').to_json %>, { style: 'currency', currency: 'USD' });
|
||||
var savedSubtotal = $form.data('savedSubtotal') === '' ? null : parseFloat($form.data('savedSubtotal'));
|
||||
var savedTax = $form.data('savedTax') === '' ? null : parseFloat($form.data('savedTax'));
|
||||
// Discounts are kept from QuickBooks as they are; QuickBooks works out a percent discount again on save
|
||||
var discount = $form.data('discount') === '' ? 0 : parseFloat($form.data('discount'));
|
||||
// The discount QuickBooks took off when the document was last saved (the tax shown is for that discount)
|
||||
var savedDiscount = $form.data('discount') === '' ? 0 : parseFloat($form.data('discount'));
|
||||
var $discountValue = $('#qbo_estimate_discount_value');
|
||||
var $discountType = $('#qbo_estimate_discount_type');
|
||||
var locked = $form.find('.qbo-estimate-sheet').prop('disabled');
|
||||
// Row keys must be digits: Rails' strong parameters only keep a hash of rows when every key is a number
|
||||
var nextKey = Date.now();
|
||||
@@ -131,6 +133,13 @@ $(function () {
|
||||
return round(qty * rate, 2);
|
||||
}
|
||||
|
||||
// The discount in dollars: a percent of the subtotal or an amount, like QuickBooks works it out
|
||||
function discountAmount(subtotal) {
|
||||
var value = parseNumber(String($discountValue.val() || '').replace(/%/g, ''));
|
||||
if (!$discountValue.length || value === null || isNaN(value) || value <= 0) return 0;
|
||||
return $discountType.val() === 'percent' ? round(subtotal * value / 100, 2) : round(value, 2);
|
||||
}
|
||||
|
||||
function recalc() {
|
||||
var subtotal = 0, taxable = 0, section = 0;
|
||||
rows().each(function () {
|
||||
@@ -154,8 +163,11 @@ $(function () {
|
||||
|
||||
// QuickBooks works out the sales tax when the estimate is saved; show the saved tax until the lines change
|
||||
var $tax = $('#qbo-estimate-tax');
|
||||
var discount = discountAmount(subtotal);
|
||||
$('#qbo-estimate-discount').text(discount > 0 ? '-' + money.format(discount) : '');
|
||||
var total = round(subtotal - discount, 2);
|
||||
if (savedTax !== null && savedSubtotal !== null && Math.abs(subtotal - savedSubtotal) < 0.005) {
|
||||
if (savedTax !== null && savedSubtotal !== null && Math.abs(subtotal - savedSubtotal) < 0.005 &&
|
||||
Math.abs(discount - savedDiscount) < 0.005) {
|
||||
$tax.text(money.format(savedTax)).removeClass('qbo-pending');
|
||||
total = round(total + savedTax, 2);
|
||||
} else {
|
||||
@@ -415,10 +427,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 +466,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 || '';
|
||||
@@ -548,6 +570,24 @@ $(function () {
|
||||
return ids;
|
||||
};
|
||||
|
||||
// Pairs imported time with the invoice lines ticked under "Replace these lines": first by description,
|
||||
// since issues created from an estimate take the line's description as their subject and the time names
|
||||
// it ("Install #134: Install Lift Kit" <-> "Install Lift Kit"); what's left is paired in order.
|
||||
// Returns { pairs: [{ time, line }], extraTimes: [...], extraLines: [...] }.
|
||||
var pairTimeWithLines = function (times, lines) {
|
||||
var norm = function (text) { return String(text || '').split('\n')[0].toLowerCase().replace(/\s+/g, ' ').trim(); };
|
||||
var subject = function (activity) { return norm(String(activity.description || '').replace(/^[^\n]*?#\d+:\s*/, '')); };
|
||||
var lineText = function (line) { return norm($(line).find('.qbo-line-description-input').val()); };
|
||||
var freeTimes = times.slice(), freeLines = [], pairs = [];
|
||||
lines.forEach(function (line) {
|
||||
var text = lineText(line);
|
||||
var i = text ? freeTimes.findIndex(function (t) { return subject(t) === text; }) : -1;
|
||||
if (i >= 0) { pairs.push({ time: freeTimes[i], line: line }); freeTimes.splice(i, 1); } else { freeLines.push(line); }
|
||||
});
|
||||
while (freeTimes.length && freeLines.length) pairs.push({ time: freeTimes.shift(), line: freeLines.shift() });
|
||||
return { pairs: pairs, extraTimes: freeTimes, extraLines: freeLines };
|
||||
};
|
||||
|
||||
// Rows go after the last filled line, above the spare empty rows
|
||||
var insertAfterFilled = function ($rows) {
|
||||
var $filled = rows().filter(function () { return !rowIsBlank($(this)); });
|
||||
@@ -642,15 +682,24 @@ $(function () {
|
||||
// Kept so the import can be undone before saving (clones keep what was typed)
|
||||
undoState = { rows: rows().clone(), linked: $('#qbo-linked-estimates').children().clone() };
|
||||
|
||||
// Time goes where the first ticked line was; the ticked lines are removed
|
||||
// Each time entry replaces one ticked line, in that line's place (see pairTimeWithLines). Time left over
|
||||
// goes after the last replaced line; ticked lines left over are removed (ticked means replace).
|
||||
if (times.length) {
|
||||
var $timeRows = $(times.map(function (activity) {
|
||||
return makeRow($.extend({}, activity, { time_activity_id: activity.id }))[0];
|
||||
}));
|
||||
var $replaced = $('#qbo-import-replace input:checked').map(function () { return $(this).data('row')[0]; });
|
||||
var $anchor = rows().filter(function () { return $replaced.index(this) >= 0; }).first();
|
||||
if ($anchor.length) { $anchor.before($timeRows); } else { insertAfterFilled($timeRows); }
|
||||
$replaced.remove();
|
||||
var ticked = $('#qbo-import-replace input:checked').map(function () { return $(this).data('row')[0]; }).get();
|
||||
ticked = rows().get().filter(function (row) { return ticked.indexOf(row) >= 0; }); // table order
|
||||
var pairing = pairTimeWithLines(times, ticked);
|
||||
var timeRow = function (activity) { return makeRow($.extend({}, activity, { time_activity_id: activity.id })); };
|
||||
var $last = $();
|
||||
pairing.pairs.forEach(function (pair) {
|
||||
var $row = timeRow(pair.time);
|
||||
$(pair.line).replaceWith($row);
|
||||
if (!$last.length || $row.index() > $last.index()) $last = $row;
|
||||
});
|
||||
pairing.extraLines.forEach(function (line) { $(line).remove(); });
|
||||
if (pairing.extraTimes.length) {
|
||||
var $extra = $(pairing.extraTimes.map(function (activity) { return timeRow(activity)[0]; }));
|
||||
if ($last.length) { $last.after($extra); } else { insertAfterFilled($extra); }
|
||||
}
|
||||
}
|
||||
|
||||
// Each estimate's lines go right after the time for the same issue (e.g. lineitems' "Added from:
|
||||
@@ -706,6 +755,16 @@ $(function () {
|
||||
});
|
||||
}
|
||||
|
||||
$discountValue.on('input', function () { dirty = true; recalc(); });
|
||||
$discountType.on('change', function () { dirty = true; recalc(); });
|
||||
// Math typed in the discount box (e.g. 1500-1250) is worked out, to the cent
|
||||
function tidyDiscount() {
|
||||
var text = String($discountValue.val() || '').replace(/[$,\s%]/g, '');
|
||||
var value = parseNumber(text);
|
||||
if (value !== null && !isNaN(value) && isMath(text)) $discountValue.val(plain(round(value, 2), 2));
|
||||
}
|
||||
$discountValue.on('blur', function () { tidyDiscount(); recalc(); });
|
||||
|
||||
// ---- saving ----
|
||||
$form.on('input change', '.qbo-estimate-top input, .qbo-estimate-details input, .qbo-estimate-notes textarea', function () { dirty = true; });
|
||||
|
||||
@@ -714,7 +773,11 @@ $(function () {
|
||||
if (event.key === 'Enter' && !$(this).closest('.ui-autocomplete').length) event.preventDefault();
|
||||
});
|
||||
|
||||
// Set once a save is on its way, so more clicks don't save (or send) it twice
|
||||
var saving = false;
|
||||
|
||||
$form.on('submit', function (event) {
|
||||
if (saving) { event.preventDefault(); return; }
|
||||
var submitter = event.originalEvent && event.originalEvent.submitter;
|
||||
if (submitter && submitter.id === 'qbo-estimate-save-and-send' && !$email.val().trim()) {
|
||||
event.preventDefault();
|
||||
@@ -724,7 +787,39 @@ $(function () {
|
||||
}
|
||||
// Math still in a box is worked out before saving
|
||||
rows().each(function () { tidyNumbers($(this)); });
|
||||
tidyDiscount();
|
||||
dirty = false;
|
||||
|
||||
// After every submit handler has run (and the form's values are already taken, so disabling the buttons
|
||||
// doesn't drop which one was clicked): unless one stopped the save, show it's saving and lock the buttons
|
||||
setTimeout(function () {
|
||||
var stopped = event.originalEvent ? event.originalEvent.defaultPrevented : event.isDefaultPrevented();
|
||||
if (stopped) return;
|
||||
saving = true;
|
||||
showSaving(submitter);
|
||||
}, 0);
|
||||
});
|
||||
|
||||
function showSaving(submitter) {
|
||||
var $bar = $form.find('.qbo-estimate-actions');
|
||||
var $clicked = submitter ? $(submitter) : $bar.find('input[type=submit][name=save]');
|
||||
var text = $clicked.data('savingText') || $bar.data('savingText');
|
||||
|
||||
$bar.addClass('qbo-saving');
|
||||
$bar.find('input[type=submit]').prop('disabled', true);
|
||||
$bar.find('a.qbo-button').addClass('qbo-button-disabled').attr('aria-disabled', 'true');
|
||||
$bar.find('.qbo-saving-status').text(text).prop('hidden', false);
|
||||
}
|
||||
|
||||
// Coming back with the browser's Back button can show the page as it was left, still "saving"
|
||||
window.addEventListener('pageshow', function (event) {
|
||||
if (!event.persisted || !saving) return;
|
||||
saving = false;
|
||||
var $bar = $form.find('.qbo-estimate-actions');
|
||||
$bar.removeClass('qbo-saving');
|
||||
$bar.find('input[type=submit]').prop('disabled', false);
|
||||
$bar.find('a.qbo-button').removeClass('qbo-button-disabled').removeAttr('aria-disabled');
|
||||
$bar.find('.qbo-saving-status').prop('hidden', true);
|
||||
});
|
||||
|
||||
window.addEventListener('beforeunload', function (event) {
|
||||
|
||||
@@ -2,7 +2,12 @@
|
||||
<style>
|
||||
.qbo-estimate { --qbo-border: #babec5; --qbo-muted: #6b6c72; --qbo-green: #2ca01c; --qbo-green-dark: #108000; --qbo-bar: #393a3d; }
|
||||
.qbo-estimate-sheet { border: 1px solid #e3e5e8; border-radius: 4px; background: #fff; padding: 20px 24px 24px; margin: 0 0 0; min-width: 0; }
|
||||
.qbo-estimate-sheet[disabled] { opacity: .75; }
|
||||
.qbo-estimate-sheet[disabled] { opacity: .85; }
|
||||
/* A locked document is still read here: browsers grey out disabled boxes' text (Safari nearly to nothing,
|
||||
through -webkit-text-fill-color), so it's drawn in the normal text color */
|
||||
.qbo-estimate-sheet[disabled] :is(input, textarea, select) { color: #393a3d; -webkit-text-fill-color: #393a3d; opacity: 1; }
|
||||
/* ...but not hints in empty boxes, which would read as if they were filled in */
|
||||
.qbo-estimate-sheet[disabled] :is(input, textarea)::placeholder { color: transparent; -webkit-text-fill-color: transparent; }
|
||||
.qbo-estimate-sheet[disabled] .qbo-estimate-line-buttons, .qbo-estimate-sheet[disabled] .qbo-line-handle svg,
|
||||
.qbo-estimate-sheet[disabled] .qbo-line-remove-button { display: none; }
|
||||
.qbo-estimate-top { display: flex; justify-content: space-between; align-items: flex-start; gap: 24px; }
|
||||
@@ -95,6 +100,9 @@
|
||||
.qbo-estimate-totals { border-collapse: collapse; min-width: 300px; align-self: flex-start; font-variant-numeric: tabular-nums; }
|
||||
.qbo-estimate-totals th { text-align: right; font-weight: normal; color: #393a3d; padding: 6px 16px 6px 0; }
|
||||
.qbo-estimate-totals td { text-align: right; padding: 6px 0; min-width: 110px; }
|
||||
.qbo-estimate-discount th { white-space: nowrap; }
|
||||
.qbo-estimate-discount input { width: 5em; text-align: right; margin-left: 6px; }
|
||||
.qbo-estimate-discount select { width: auto; }
|
||||
.qbo-estimate-totals #qbo-estimate-tax.qbo-pending { color: var(--qbo-muted); font-style: italic; font-size: .9em; }
|
||||
.qbo-estimate-totals .qbo-estimate-total th, .qbo-estimate-totals .qbo-estimate-total td { font-weight: 700; font-size: 1.15em; border-top: 1px solid #d4d7dc; padding-top: 10px; }
|
||||
|
||||
@@ -111,6 +119,17 @@
|
||||
.qbo-estimate .qbo-button-primary { background: var(--qbo-green); border-color: var(--qbo-green); color: #fff; }
|
||||
.qbo-estimate .qbo-button-primary:hover { background: var(--qbo-green-dark); border-color: var(--qbo-green-dark); color: #fff; }
|
||||
|
||||
/* While saving: the buttons are locked and a spinner says what's happening */
|
||||
.qbo-estimate .qbo-saving .qbo-button[disabled],
|
||||
.qbo-estimate .qbo-saving .qbo-button-disabled { opacity: .6; cursor: progress; pointer-events: none; }
|
||||
.qbo-estimate .qbo-saving-status { display: inline-flex; align-items: center; gap: 8px; color: #fff; font-weight: 600; margin-right: 8px; }
|
||||
.qbo-estimate .qbo-saving-status[hidden] { display: none; }
|
||||
.qbo-estimate .qbo-saving-status::before { content: ""; width: 16px; height: 16px; border-radius: 50%; box-sizing: border-box;
|
||||
border: 2px solid rgba(255,255,255,.35); border-top-color: #fff; animation: qbo-saving-spin .8s linear infinite; }
|
||||
@keyframes qbo-saving-spin { to { transform: rotate(360deg); } }
|
||||
@media (prefers-reduced-motion: reduce) { .qbo-estimate .qbo-saving-status::before { animation-duration: 2.4s; } }
|
||||
.qbo-estimate .qbo-saving { cursor: progress; }
|
||||
|
||||
/* Warnings with a list (linked issues, invoices): the text, then one item per line */
|
||||
div.warning.qbo-estimate-notice { text-align: left; }
|
||||
div.warning.qbo-estimate-notice ul { margin: 6px 0 0; padding-left: 22px; }
|
||||
|
||||
@@ -14,26 +14,58 @@
|
||||
</span>
|
||||
</h2>
|
||||
|
||||
<%# Target project: changing it reloads the page with that project's trackers and templates %>
|
||||
<% if @available_projects.size > 1 %>
|
||||
<%= form_tag issues_preview_qbo_estimate_path(@estimate.id), method: :get, id: 'estimate-issues-project-form' do %>
|
||||
<% carry.each do |key, value| %><%= hidden_field_tag key, value, id: nil %><% end %>
|
||||
<p>
|
||||
<label for="project_id"><strong><%= l(:field_project) %>:</strong></label>
|
||||
<%# Target project and parent task: changing either reloads the page (the project's trackers and templates;
|
||||
the parent's project, vehicle and custom field values) %>
|
||||
<%= form_tag issues_preview_qbo_estimate_path(@estimate.id), method: :get, id: 'estimate-issues-project-form' do %>
|
||||
<% carry.each do |key, value| %><%= hidden_field_tag key, value, id: nil %><% end %>
|
||||
<p>
|
||||
<label for="project_id"><strong><%= l(:field_project) %>:</strong></label>
|
||||
<% if @available_projects.size > 1 %>
|
||||
<%= select_tag :project_id,
|
||||
options_from_collection_for_select(@available_projects, :id, :name, @target_project.id),
|
||||
onchange: 'this.form.submit();' %>
|
||||
<noscript><%= submit_tag l(:button_apply), name: nil %></noscript>
|
||||
<% else %>
|
||||
<%= link_to_project @target_project %>
|
||||
<%= hidden_field_tag :project_id, @target_project.id, id: nil %>
|
||||
<% end %>
|
||||
</p>
|
||||
<% if @can_add_subtasks || @parent_issue_id.present? %>
|
||||
<p class="estimate-issues-parent">
|
||||
<label for="parent_issue_id"><strong><%= l(:field_parent_issue) %>:</strong></label>
|
||||
<%= text_field_tag :parent_issue_id, @parent_issue&.id || @parent_issue_id, size: 10,
|
||||
placeholder: l(:label_estimate_parent_placeholder) %>
|
||||
<% if @parent_issue %>
|
||||
<%= link_to_issue(@parent_issue, truncate: 60) %>
|
||||
<%= link_to sprite_icon('del', l(:button_clear)),
|
||||
issues_preview_qbo_estimate_path(@estimate.id, carry.merge(project_id: @target_project.id)),
|
||||
class: 'icon-only icon-del', title: l(:button_clear) %>
|
||||
<br><em class="info"><%= l(:text_estimate_parent_info) %></em>
|
||||
<% end %>
|
||||
</p>
|
||||
<% end %>
|
||||
<% else %>
|
||||
<p><strong><%= l(:field_project) %>:</strong> <%= link_to_project @target_project %></p>
|
||||
<noscript><p><%= submit_tag l(:button_apply), name: nil %></p></noscript>
|
||||
<% end %>
|
||||
|
||||
<% if @builder.errors.any? %>
|
||||
<% if @can_add_subtasks || @parent_issue_id.present? %>
|
||||
<%= javascript_tag do %>
|
||||
(function () {
|
||||
var field = document.getElementById('parent_issue_id');
|
||||
if (!field) return;
|
||||
var submitted = false;
|
||||
function reload() { if (!submitted) { submitted = true; field.form.submit(); } }
|
||||
observeAutocompleteField('parent_issue_id',
|
||||
<%= raw auto_complete_issues_path(project_id: @target_project, scope: Setting.cross_project_subtasks, status: 'o').to_json %>,
|
||||
{ select: function (event, ui) { field.value = ui.item.value; reload(); } });
|
||||
field.addEventListener('change', reload);
|
||||
})();
|
||||
<% end %>
|
||||
<% end %>
|
||||
|
||||
<% errors = [@parent_issue_error, *@builder.errors].compact %>
|
||||
<% if errors.any? %>
|
||||
<div id="errorExplanation">
|
||||
<ul>
|
||||
<% @builder.errors.each do |message| %>
|
||||
<% errors.each do |message| %>
|
||||
<li><%= message %></li>
|
||||
<% end %>
|
||||
</ul>
|
||||
@@ -63,6 +95,7 @@
|
||||
id: 'estimate-issues-form',
|
||||
data: { templates: template_data.to_json } do %>
|
||||
<%= hidden_field_tag :project_id, @target_project.id %>
|
||||
<%= hidden_field_tag :parent_issue_id, @parent_issue&.id || @parent_issue_id, id: nil %>
|
||||
<% carry.each do |key, value| %><%= hidden_field_tag key, value, id: nil %><% end %>
|
||||
|
||||
<table class="list estimate-issues-preview">
|
||||
@@ -136,6 +169,21 @@
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
<%# Dates for every issue: from the appointment the page was opened from, else the parent task; blank means none %>
|
||||
<fieldset class="box tabular estimate-issue-dates">
|
||||
<legend><%= l(:label_estimate_issue_dates) %></legend>
|
||||
<p>
|
||||
<label for="estimate_issue_start_date"><%= l(:field_start_date) %></label>
|
||||
<%= date_field_tag 'issue_dates[start_date]', @defaults[:start_date], id: 'estimate_issue_start_date', size: 10 %>
|
||||
<%= calendar_for('estimate_issue_start_date') %>
|
||||
</p>
|
||||
<p>
|
||||
<label for="estimate_issue_due_date"><%= l(:field_due_date) %></label>
|
||||
<%= date_field_tag 'issue_dates[due_date]', @defaults[:due_date], id: 'estimate_issue_due_date', size: 10 %>
|
||||
<%= calendar_for('estimate_issue_due_date') %>
|
||||
</p>
|
||||
</fieldset>
|
||||
|
||||
<%# Fields entered once and applied to every issue: plugins' own (e.g. redmine_qbo_vehicles' vehicle, posted as
|
||||
issue_plugin_fields[...]) and the custom fields for the chosen trackers %>
|
||||
<% plugin_fields = call_hook(:view_qbo_estimate_issues_form, { estimate: @estimate, defaults: @defaults, project: @target_project }) %>
|
||||
@@ -234,6 +282,8 @@
|
||||
|
||||
var visibleCount = 0;
|
||||
fieldBox.querySelectorAll('.estimate-issue-field').forEach(function (field) {
|
||||
// Plugins' fields (e.g. the vehicle) apply to every tracker
|
||||
if (!field.hasAttribute('data-tracker-ids')) { visibleCount++; return; }
|
||||
var used = idList(field.dataset.trackerIds).some(function (id) { return trackerIds.indexOf(id) >= 0; });
|
||||
var required = idList(field.dataset.requiredTrackerIds).some(function (id) { return trackerIds.indexOf(id) >= 0; });
|
||||
field.style.display = used ? '' : 'none';
|
||||
|
||||
@@ -1,4 +1,5 @@
|
||||
<% html_title l(:label_new_estimate) %>
|
||||
|
||||
<%= render partial: 'qbo_estimates/header', locals: { form: @form } %>
|
||||
<%= render partial: 'qbo_estimates/form', locals: { form: @form } %>
|
||||
<%= render partial: 'qbo_drafts/editor_notice', locals: { draft: @draft, drafts: @customer_drafts } %>
|
||||
<%= render partial: 'qbo_estimates/form', locals: { form: @form, draft: @draft } %>
|
||||
@@ -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,6 +1,8 @@
|
||||
<% html_title "#{l(:label_invoice)} ##{@form.doc_number}" %>
|
||||
|
||||
<div class="contextual">
|
||||
<%# Plugins add invoice actions here (e.g. redmine_qbo_labels' Print label) %>
|
||||
<%= call_hook :view_qbo_invoice_contextual, { invoice_id: @form.id, customer_id: @form.customer_id, doc_number: @form.doc_number } %>
|
||||
<% if RedmineQboBilling.payment_receiver? && @form.balance.to_d > 0 %>
|
||||
<%= link_to sprite_icon('add', l(:button_receive_payment)), new_qbo_payment_path(customer_id: @form.customer_id), class: 'icon icon-add' %>
|
||||
<% end %>
|
||||
|
||||
@@ -1,4 +1,6 @@
|
||||
<% html_title l(:label_new_invoice) %>
|
||||
|
||||
<%= render partial: 'qbo_estimates/header', locals: { form: @form } %>
|
||||
<%= render partial: 'qbo_estimates/form', locals: { form: @form } %>
|
||||
<%= render partial: 'qbo_drafts/editor_notice', locals: { draft: @draft, drafts: @customer_drafts } %>
|
||||
<%= 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, draft: @draft } %>
|
||||
@@ -0,0 +1,2 @@
|
||||
<%# A saved payment, on the same page as Receive payment %>
|
||||
<%= render template: 'qbo_payments/new' %>
|
||||
@@ -56,6 +56,9 @@
|
||||
<td class="amount"><%= number_to_currency(payment.total) %></td>
|
||||
<td class="amount"><%= unapplied > 0 ? number_to_currency(unapplied) : '' %></td>
|
||||
<td class="buttons">
|
||||
<% if RedmineQboBilling.payment_receiver? %>
|
||||
<%= link_to sprite_icon('edit', l(:button_edit)), edit_qbo_payment_path(payment.id), class: 'icon icon-edit' %>
|
||||
<% end %>
|
||||
<%= link_to sprite_icon('application-pdf', l(:button_print_payment)), pdf_qbo_payment_path(payment.id),
|
||||
class: 'icon icon-pdf', target: :_blank %>
|
||||
</td>
|
||||
|
||||
@@ -1,22 +1,44 @@
|
||||
<% html_title l(:button_receive_payment) %>
|
||||
<%# Receive payment, and Edit payment (edit.html.erb) for a saved one %>
|
||||
<% editing = @form.persisted? %>
|
||||
<% title = editing ? l(:label_edit_payment) : l(:button_receive_payment) %>
|
||||
<% html_title title %>
|
||||
<% customer = Customer.find_by(id: @form.customer_id) if @form.customer_id.present? %>
|
||||
|
||||
<h2>
|
||||
<%= link_to l(:label_customers), customers_path %> »
|
||||
<% if customer %><%= link_to customer.name, customer_path(customer) %> »<% end %>
|
||||
<%= l(:button_receive_payment) %>
|
||||
<% if editing %>
|
||||
<%= link_to l(:label_payments), qbo_payments_path(customer_id: @form.customer_id) %> »
|
||||
<% end %>
|
||||
<%= title %>
|
||||
</h2>
|
||||
|
||||
<%= error_messages_for @form %>
|
||||
|
||||
<%= form_tag qbo_payments_path, id: 'qbo-payment-form',
|
||||
<% if @conflict %>
|
||||
<p class="warning">
|
||||
<%= l(:text_payment_reload) %>
|
||||
<%= link_to l(:button_reload_payment), edit_qbo_payment_path(@form.id) %>
|
||||
</p>
|
||||
<% end %>
|
||||
<% if @form.locked %>
|
||||
<p class="warning"><%= @form.locked %></p>
|
||||
<% end %>
|
||||
|
||||
<%= form_tag (editing ? qbo_payment_path(@form.id) : qbo_payments_path), method: (editing ? :patch : :post), id: 'qbo-payment-form',
|
||||
data: { open_invoices_url: open_invoices_qbo_payments_path, none_text: l(:label_no_open_invoices) } do %>
|
||||
<%= hidden_field_tag 'payment[sync_token]', @form.sync_token, id: nil if editing %>
|
||||
<div class="box tabular">
|
||||
<p>
|
||||
<label for="qbo_payment_customer_name"><%= l(:label_customer) %><span class="required"> *</span></label>
|
||||
<%= text_field_tag 'payment[customer_name]', @form.customer_name, id: 'qbo_payment_customer_name', class: 'customer-name',
|
||||
autocomplete: 'off', size: 40, placeholder: l(:label_choose_a_customer),
|
||||
data: { autocomplete_url: '/customers/autocomplete' } %>
|
||||
<%# A saved payment keeps its customer %>
|
||||
<% if editing %>
|
||||
<%= text_field_tag 'payment[customer_name]', @form.customer_name, id: 'qbo_payment_customer_name', size: 40, readonly: true, tabindex: -1 %>
|
||||
<% else %>
|
||||
<%= text_field_tag 'payment[customer_name]', @form.customer_name, id: 'qbo_payment_customer_name', class: 'customer-name',
|
||||
autocomplete: 'off', size: 40, placeholder: l(:label_choose_a_customer),
|
||||
data: { autocomplete_url: '/customers/autocomplete' } %>
|
||||
<% end %>
|
||||
<%= hidden_field_tag 'payment[customer_id]', @form.customer_id, id: 'customer_id' %>
|
||||
</p>
|
||||
<p>
|
||||
@@ -94,8 +116,8 @@
|
||||
</fieldset>
|
||||
|
||||
<p>
|
||||
<%= submit_tag l(:button_save_payment) %>
|
||||
<%= link_to l(:button_cancel), customer ? customer_path(customer) : home_path %>
|
||||
<%= submit_tag l(:button_save_payment) unless @form.locked %>
|
||||
<%= link_to l(:button_cancel), editing ? qbo_payment_path(@form.id) : (customer ? customer_path(customer) : home_path) %>
|
||||
</p>
|
||||
<% end %>
|
||||
|
||||
|
||||
@@ -2,6 +2,9 @@
|
||||
<% method_name = RedmineQboBilling::PaymentWriter.payment_method_name(@payment) %>
|
||||
|
||||
<div class="contextual">
|
||||
<% if RedmineQboBilling.payment_receiver? %>
|
||||
<%= link_to sprite_icon('edit', l(:button_edit)), edit_qbo_payment_path(@payment.id), class: 'icon icon-edit' %>
|
||||
<% end %>
|
||||
<%= link_to sprite_icon('application-pdf', l(:button_print_payment)), pdf_qbo_payment_path(@payment.id), class: 'icon icon-pdf', target: :_blank %>
|
||||
<% if @customer && RedmineQboBilling.payment_receiver? %>
|
||||
<%= link_to sprite_icon('add', l(:button_receive_payment)), new_qbo_payment_path(customer_id: @customer.id), class: 'icon icon-add' %>
|
||||
|
||||
@@ -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 %>
|
||||
@@ -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 %> »
|
||||
<%= link_to @customer.name, customer_path(@customer) %> »
|
||||
<%= 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 %>
|
||||
@@ -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 %> »
|
||||
<% if @customer %><%= link_to @customer.name, customer_path(@customer) %> »<% 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>
|
||||
@@ -2,11 +2,54 @@
|
||||
<% money = @report.money %>
|
||||
<% hours = @report.hours %>
|
||||
<% ratios = @report.ratios %>
|
||||
<% max_money = [money[:estimates][:total], money[:invoices][:total], money[:payments][:total]].max.to_f %>
|
||||
<% max_money = [money[:estimates][:total], money[:invoices][:total], money[:paid][:total], money[:payments][:total]].max.to_f %>
|
||||
<% max_hours = hours.values.max.to_f %>
|
||||
<% bar = ->(value, max) { max > 0 ? (value.to_f / max * 100).round(1) : 0 } %>
|
||||
<% fmt_hours = ->(h) { format('%.1f', h.to_f) } %>
|
||||
<% pct = ->(v) { v.nil? ? '–' : "#{v}%" } %>
|
||||
<%# Line charts: a label and a tooltip title per point, from the chart's granularity %>
|
||||
<% chart = @report.chart %>
|
||||
<% months_abbr = ::I18n.t('date.abbr_month_names') %>
|
||||
<% days_abbr = ::I18n.t('date.abbr_day_names') %>
|
||||
<% one_year = @report.from.year == @report.to.year %>
|
||||
<% point_label = lambda do |date|
|
||||
case chart[:granularity]
|
||||
when :day then "#{days_abbr[date.wday]} #{date.day}"
|
||||
when :week then "#{months_abbr[date.month]} #{date.day}"
|
||||
else one_year ? months_abbr[date.month] : "#{months_abbr[date.month]} #{date.year}"
|
||||
end
|
||||
end %>
|
||||
<% point_title = lambda do |first, last|
|
||||
case chart[:granularity]
|
||||
when :day then format_date(first)
|
||||
when :week then "#{format_date(first)} – #{format_date(last)}"
|
||||
else "#{::I18n.t('date.month_names')[first.month]} #{first.year}"
|
||||
end
|
||||
end %>
|
||||
<% previous_ends = chart[:previous_points].each_with_index.map { |p, i| Date.parse(p) + (Date.parse(chart[:ends][i]) - Date.parse(chart[:points][i])) } %>
|
||||
<% chart_points = {
|
||||
labels: chart[:points].map { |p| point_label.call(Date.parse(p)) },
|
||||
titles: chart[:points].each_with_index.map { |p, i| point_title.call(Date.parse(p), Date.parse(chart[:ends][i])) },
|
||||
previous_titles: chart[:previous_points].each_with_index.map { |p, i| point_title.call(Date.parse(p), previous_ends[i]) },
|
||||
last_year: l(:label_report_last_year)
|
||||
} %>
|
||||
<% chart_series = lambda do |keys|
|
||||
keys.map do |key, label, color|
|
||||
{ label: label, color: color, current: chart[:current][key], previous: chart[:previous][key] }
|
||||
end
|
||||
end %>
|
||||
<% sales_series = chart_series.call([[:estimates, l(:label_report_estimates_written), '#628db6'],
|
||||
[:invoices, l(:label_report_invoices_written), '#e8a33d'],
|
||||
[:paid, l(:label_report_invoices_paid), '#c0504d'],
|
||||
[:payments, l(:label_report_payments_received), '#5aa05a']]) %>
|
||||
<% taxes = @report.taxes %>
|
||||
<% max_tax = taxes.values.map { |t| t[:total] }.max.to_f %>
|
||||
<% tax_series = chart_series.call([[:tax_invoiced, l(:label_report_tax_invoiced), '#e8a33d'],
|
||||
[:tax_collected, l(:label_report_tax_collected), '#c0504d']]) %>
|
||||
<% hours_series = chart_series.call([[:estimate_hours, l(:label_report_estimate_hours), '#628db6'],
|
||||
[:issue_hours, l(:label_report_issue_hours), '#9b7fc0'],
|
||||
[:invoice_hours, l(:label_report_invoice_hours), '#e8a33d'],
|
||||
[:spent_hours, l(:label_report_spent_hours), '#5aa05a']]) %>
|
||||
|
||||
<h2><%= l(:label_business_report) %></h2>
|
||||
|
||||
@@ -22,10 +65,40 @@
|
||||
<%= date_field_tag 'to', @report.to.iso8601, id: 'qbo-report-to' %>
|
||||
</span>
|
||||
<%= submit_tag l(:button_apply), name: nil %>
|
||||
<label class="qbo-report-compare">
|
||||
<%= check_box_tag 'compare', '1', @compare, id: 'qbo-report-compare' %>
|
||||
<%= l(:label_report_compare_last_year) %>
|
||||
</label>
|
||||
<%# Projects for the issues and spent time; the blank value sends project_ids when none are picked (every project) %>
|
||||
<div class="qbo-report-projects">
|
||||
<label for="qbo-report-project-ids"><%= l(:label_project_plural) %></label>
|
||||
<%= hidden_field_tag 'project_ids[]', '', id: nil %>
|
||||
<%= select_tag 'project_ids[]',
|
||||
project_tree_options_for_select(@projects, selected: @projects.select { |p| @project_ids.include?(p.id) }),
|
||||
multiple: true, size: [[@projects.size, 3].max, 8].min, id: 'qbo-report-project-ids' %>
|
||||
<span class="qbo-report-projects-options">
|
||||
<em class="info"><%= l(:text_report_projects) %></em>
|
||||
<label>
|
||||
<%= check_box_tag 'save_projects', '1', false, id: 'qbo-report-save-projects' %>
|
||||
<%= l(:label_report_remember_projects) %>
|
||||
</label>
|
||||
<% if @saved_project_ids.any? %>
|
||||
<em class="info"><%= l(:text_report_saved_projects, projects: @projects.select { |p| @saved_project_ids.include?(p.id) }.map(&:name).join(', ')) %></em>
|
||||
<% end %>
|
||||
</span>
|
||||
</div>
|
||||
</fieldset>
|
||||
<% end %>
|
||||
|
||||
<p class="qbo-report-range"><%= format_date(@report.from) %> – <%= format_date(@report.to) %></p>
|
||||
<p class="qbo-report-range">
|
||||
<%= format_date(@report.from) %> – <%= format_date(@report.to) %>
|
||||
<% if @report.projects_filtered? %>
|
||||
· <%= l(:label_project_plural) %>: <%= @projects.select { |p| @project_ids.include?(p.id) }.map(&:name).join(', ') %>
|
||||
<% end %>
|
||||
</p>
|
||||
<% if @report.projects_filtered? %>
|
||||
<p class="info qbo-report-projects-note"><%= l(:text_report_projects_filtered) %></p>
|
||||
<% end %>
|
||||
|
||||
<% if Array(@syncing).any? %>
|
||||
<% sync_labels = { 'Estimate' => l(:label_estimates), 'Invoice' => l(:label_invoices), 'Payment' => l(:label_payments) } %>
|
||||
@@ -58,10 +131,13 @@
|
||||
<div class="splitcontent">
|
||||
<div class="splitcontentleft">
|
||||
<h3><%= l(:label_report_money) %></h3>
|
||||
<div class="qbo-report-chart">
|
||||
<canvas id="qbo-chart-sales" data-kind="money" data-series="<%= sales_series.to_json %>"></canvas>
|
||||
</div>
|
||||
<table class="list qbo-report">
|
||||
<tbody>
|
||||
<% [[:estimates, l(:label_report_estimates_written)], [:invoices, l(:label_report_invoices_written)],
|
||||
[:payments, l(:label_report_payments_received)]].each do |key, label| %>
|
||||
[:paid, l(:label_report_invoices_paid)], [:payments, l(:label_report_payments_received)]].each do |key, label| %>
|
||||
<tr>
|
||||
<td class="name"><%= label %> <span class="count">(<%= money[key][:count] %>)</span></td>
|
||||
<td class="bar"><div class="qbo-bar qbo-bar-<%= key %>" style="width: <%= bar.call(money[key][:total], max_money) %>%"></div></td>
|
||||
@@ -75,10 +151,14 @@
|
||||
<%= l(:label_report_collected_of_invoiced) %>: <strong><%= pct.call(ratios[:collected_of_invoiced]) %></strong><br />
|
||||
<%= l(:label_report_open_balance) %>: <strong><%= number_to_currency(money[:invoices][:balance]) %></strong>
|
||||
</p>
|
||||
<p><em class="info"><%= l(:text_report_without_tax) %></em></p>
|
||||
</div>
|
||||
|
||||
<div class="splitcontentright">
|
||||
<h3><%= l(:label_report_hours) %></h3>
|
||||
<div class="qbo-report-chart">
|
||||
<canvas id="qbo-chart-hours" data-kind="hours" data-series="<%= hours_series.to_json %>"></canvas>
|
||||
</div>
|
||||
<table class="list qbo-report">
|
||||
<tbody>
|
||||
<% [[:estimate_hours, l(:label_report_estimate_hours)], [:issue_hours, l(:label_report_issue_hours)],
|
||||
@@ -114,6 +194,7 @@
|
||||
<th class="month"><%= l(:label_month) %></th>
|
||||
<th><%= l(:label_report_estimates_written) %></th>
|
||||
<th><%= l(:label_report_invoices_written) %></th>
|
||||
<th><%= l(:label_report_invoices_paid) %></th>
|
||||
<th><%= l(:label_report_payments_received) %></th>
|
||||
<th class="hours-start"><%= l(:label_report_estimate_hours) %></th>
|
||||
<th><%= l(:label_report_issue_hours) %></th>
|
||||
@@ -128,6 +209,7 @@
|
||||
<td class="month"><%= ::I18n.t('date.abbr_month_names')[row[:month].month] %> <%= row[:month].year %></td>
|
||||
<td><%= number_to_currency(row[:estimates]) %></td>
|
||||
<td><%= number_to_currency(row[:invoices]) %></td>
|
||||
<td><%= number_to_currency(row[:paid]) %></td>
|
||||
<td><%= number_to_currency(row[:payments]) %></td>
|
||||
<td class="hours-start"><%= fmt_hours.call(row[:estimate_hours]) %></td>
|
||||
<td><%= fmt_hours.call(row[:issue_hours]) %></td>
|
||||
@@ -142,6 +224,7 @@
|
||||
<td class="month"><strong><%= l(:label_total) %></strong></td>
|
||||
<td><strong><%= number_to_currency(money[:estimates][:total]) %></strong></td>
|
||||
<td><strong><%= number_to_currency(money[:invoices][:total]) %></strong></td>
|
||||
<td><strong><%= number_to_currency(money[:paid][:total]) %></strong></td>
|
||||
<td><strong><%= number_to_currency(money[:payments][:total]) %></strong></td>
|
||||
<td class="hours-start"><strong><%= fmt_hours.call(hours[:estimate_hours]) %></strong></td>
|
||||
<td><strong><%= fmt_hours.call(hours[:issue_hours]) %></strong></td>
|
||||
@@ -152,6 +235,54 @@
|
||||
</tfoot>
|
||||
</table>
|
||||
</div>
|
||||
<h3><%= l(:label_report_taxes) %></h3>
|
||||
<div class="splitcontent">
|
||||
<div class="splitcontentleft">
|
||||
<div class="qbo-report-chart">
|
||||
<canvas id="qbo-chart-taxes" data-kind="money" data-series="<%= tax_series.to_json %>"></canvas>
|
||||
</div>
|
||||
<table class="list qbo-report">
|
||||
<tbody>
|
||||
<% [[:tax_invoiced, l(:label_report_tax_invoiced)], [:tax_collected, l(:label_report_tax_collected)]].each do |key, label| %>
|
||||
<tr>
|
||||
<td class="name"><%= label %> <span class="count">(<%= l(:label_report_taxed_invoices, count: taxes[key][:count]) %>)</span></td>
|
||||
<td class="bar"><div class="qbo-bar qbo-bar-<%= key %>" style="width: <%= bar.call(taxes[key][:total], max_tax) %>%"></div></td>
|
||||
<td class="value"><%= number_to_currency(taxes[key][:total]) %></td>
|
||||
</tr>
|
||||
<% end %>
|
||||
</tbody>
|
||||
</table>
|
||||
<p><em class="info"><%= l(:text_report_taxes) %></em></p>
|
||||
</div>
|
||||
<div class="splitcontentright">
|
||||
<table class="list qbo-report-months qbo-report-tax-months">
|
||||
<thead>
|
||||
<tr>
|
||||
<th class="month"><%= l(:label_month) %></th>
|
||||
<th><%= l(:label_report_tax_invoiced) %></th>
|
||||
<th><%= l(:label_report_tax_collected) %></th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<% @report.months.each do |row| %>
|
||||
<tr>
|
||||
<td class="month"><%= ::I18n.t('date.abbr_month_names')[row[:month].month] %> <%= row[:month].year %></td>
|
||||
<td><%= number_to_currency(row[:tax_invoiced]) %></td>
|
||||
<td><%= number_to_currency(row[:tax_collected]) %></td>
|
||||
</tr>
|
||||
<% end %>
|
||||
</tbody>
|
||||
<tfoot>
|
||||
<tr class="total">
|
||||
<td class="month"><strong><%= l(:label_total) %></strong></td>
|
||||
<td><strong><%= number_to_currency(taxes[:tax_invoiced][:total]) %></strong></td>
|
||||
<td><strong><%= number_to_currency(taxes[:tax_collected][:total]) %></strong></td>
|
||||
</tr>
|
||||
</tfoot>
|
||||
</table>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<p class="info"><%= l(:text_report_notes) %></p>
|
||||
|
||||
<style>
|
||||
@@ -163,6 +294,8 @@
|
||||
.qbo-bar { height: 14px; border-radius: 2px; min-width: 1px; background: #628db6; }
|
||||
.qbo-bar-invoices, .qbo-bar-invoice_hours { background: #e8a33d; }
|
||||
.qbo-bar-payments, .qbo-bar-spent_hours { background: #5aa05a; }
|
||||
.qbo-bar-paid, .qbo-bar-tax_collected { background: #c0504d; }
|
||||
.qbo-bar-tax_invoiced { background: #e8a33d; }
|
||||
.qbo-bar-issue_hours { background: #9b7fc0; }
|
||||
.qbo-report-ratios { margin: 8px 4px; line-height: 1.7; }
|
||||
.qbo-report-cpi { margin: 10px 4px 4px; }
|
||||
@@ -181,6 +314,12 @@
|
||||
table.qbo-report-months .hours-start { border-left: 2px solid #ddd; }
|
||||
table.qbo-report-months tfoot td { border-top: 2px solid #ccc; }
|
||||
#qbo-report-form select, #qbo-report-form input { vertical-align: middle; }
|
||||
#qbo-report-form .qbo-report-compare { margin-left: 12px; white-space: nowrap; }
|
||||
#qbo-report-form .qbo-report-projects { display: flex; flex-wrap: wrap; align-items: flex-start; gap: 6px 10px; margin-top: 8px; }
|
||||
#qbo-report-form .qbo-report-projects select { min-width: 220px; max-width: 100%; }
|
||||
#qbo-report-form .qbo-report-projects-options { display: flex; flex-direction: column; gap: 4px; }
|
||||
#qbo-report-form .qbo-report-projects-options label { white-space: nowrap; }
|
||||
.qbo-report-chart { position: relative; height: 260px; margin: 4px 4px 16px; }
|
||||
</style>
|
||||
|
||||
<%= javascript_tag do %>
|
||||
@@ -190,4 +329,168 @@
|
||||
$dates.on('change', function() { $period.val('custom'); });
|
||||
$period.on('change', function() { if ($period.val() !== 'custom') { $('#qbo-report-form').submit(); } });
|
||||
});
|
||||
|
||||
// Line charts (Chart.js 4): the same figures and colors as the bars, a point per day,
|
||||
// week or month. "Compare with last year" adds last year's lines, dashed and faded, without reloading.
|
||||
(function() {
|
||||
var points = <%= raw chart_points.to_json %>;
|
||||
// The currency layout the tables use, e.g. "$%n"
|
||||
var currencyFormat = <%= raw number_to_currency(0, precision: 0).to_s.sub('0', '%n').to_json %>;
|
||||
var charts = [];
|
||||
|
||||
function money(v, decimals) {
|
||||
var n = Number(v || 0).toLocaleString(undefined, { minimumFractionDigits: decimals, maximumFractionDigits: decimals });
|
||||
return currencyFormat.replace('%n', n);
|
||||
}
|
||||
function hours(v) { return Number(v || 0).toFixed(1); }
|
||||
function faded(hex) {
|
||||
var n = parseInt(hex.slice(1), 16);
|
||||
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,
|
||||
fill: false, cubicInterpolationMode: 'monotone', pointRadius: 3, pointHoverRadius: 5, spanGaps: false, order: 1 });
|
||||
});
|
||||
series.forEach(function(s) {
|
||||
datasets.push({ label: s.label + ' (' + points.last_year + ')', data: s.previous, previous: true,
|
||||
borderColor: faded(s.color), backgroundColor: faded(s.color), borderDash: [6, 4],
|
||||
borderWidth: 2, fill: false, cubicInterpolationMode: 'monotone', pointRadius: 2, pointHoverRadius: 4,
|
||||
hidden: !compare, order: 2 });
|
||||
});
|
||||
return new Chart(canvas, {
|
||||
type: 'line',
|
||||
data: { labels: points.labels, datasets: datasets },
|
||||
options: {
|
||||
responsive: true,
|
||||
maintainAspectRatio: false,
|
||||
interaction: { mode: 'index', intersect: false },
|
||||
plugins: {
|
||||
// One entry per figure (clicking it hides this year's and last year's line), plus a single
|
||||
// dashed "last year" entry while comparing (clicking it turns comparing off)
|
||||
legend: {
|
||||
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;
|
||||
});
|
||||
if (chart.data.datasets.some(function(ds) { return ds.previous && !ds.hidden; })) {
|
||||
items.push({ text: points.last_year, fillStyle: 'rgba(0,0,0,0)', strokeStyle: '#999', lineWidth: 2,
|
||||
lineDash: [4, 3], hidden: false, datasetIndex: -1 });
|
||||
}
|
||||
return items;
|
||||
}
|
||||
},
|
||||
onClick: function(e, item, legend) {
|
||||
var chart = legend.chart;
|
||||
if (item.datasetIndex === -1) { $('#qbo-report-compare').prop('checked', false).trigger('change'); return; }
|
||||
var visible = !chart.isDatasetVisible(item.datasetIndex);
|
||||
chart.setDatasetVisibility(item.datasetIndex, visible);
|
||||
// last year's line follows (shown only while comparing)
|
||||
chart.getDatasetMeta(item.datasetIndex + series.length).hidden = visible ? null : true;
|
||||
chart.update();
|
||||
}
|
||||
},
|
||||
tooltip: {
|
||||
callbacks: {
|
||||
title: function(items) {
|
||||
if (!items.length) { return ''; }
|
||||
var i = items[0].dataIndex, lines = [points.titles[i]];
|
||||
if (items.some(function(it) { return it.dataset.previous; })) {
|
||||
lines.push(points.last_year + ': ' + points.previous_titles[i]);
|
||||
}
|
||||
return lines;
|
||||
},
|
||||
label: function(item) {
|
||||
return item.dataset.label + ': ' + (isMoney ? money(item.raw, 2) : hours(item.raw));
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
scales: {
|
||||
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; } } }
|
||||
}
|
||||
}
|
||||
});
|
||||
}
|
||||
|
||||
// Chart.js from the module: its default export or a named one. Chart.js 2 has no register() and is skipped.
|
||||
function chartClass(mod) {
|
||||
var found = [mod && mod.default, mod && mod.Chart, mod && mod.default && mod.default.Chart];
|
||||
for (var i = 0; i < found.length; i++) {
|
||||
if (typeof found[i] === 'function' && typeof found[i].register === 'function') { return found[i]; }
|
||||
}
|
||||
return null;
|
||||
}
|
||||
|
||||
function setCompare(on) {
|
||||
charts.forEach(function(chart) {
|
||||
var n = chart.data.datasets.length / 2;
|
||||
for (var j = 0; j < n; j++) {
|
||||
chart.data.datasets[j + n].hidden = !on;
|
||||
// a figure hidden from the legend keeps last year's line hidden too
|
||||
chart.getDatasetMeta(j + n).hidden = chart.isDatasetVisible(j) ? null : true;
|
||||
}
|
||||
chart.update();
|
||||
});
|
||||
// Keep the choice in the address, so reloading or changing the period keeps it
|
||||
if (window.history && history.replaceState) {
|
||||
var url = new URL(window.location.href);
|
||||
if (on) { url.searchParams.set('compare', '1'); } else { url.searchParams.delete('compare'); }
|
||||
history.replaceState(null, '', url);
|
||||
}
|
||||
}
|
||||
|
||||
$(function() {
|
||||
var $compare = $('#qbo-report-compare');
|
||||
// Chart.js 4 ships with this plugin (assets/javascripts), so the charts don't depend on how Redmine or
|
||||
// other plugins provide it (redmine_indicator puts Chart.js 2 on every page)
|
||||
import(<%= raw asset_path('plugin_assets/redmine_qbo/chart-4.5.1.min.js').to_json %>).then(function(mod) {
|
||||
var Chart = chartClass(mod);
|
||||
if (!Chart) {
|
||||
console.warn('Business report: Chart.js did not load', Object.keys(mod || {}));
|
||||
$('.qbo-report-chart').hide();
|
||||
return;
|
||||
}
|
||||
$('.qbo-report-chart canvas').each(function() { charts.push(draw(Chart, this, $compare.is(':checked'))); });
|
||||
window.qboReportCharts = charts;
|
||||
}).catch(function(error) {
|
||||
console.warn('Business report: Chart.js did not load', error);
|
||||
$('.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 %>
|
||||
@@ -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 |
+14
@@ -0,0 +1,14 @@
|
||||
/*!
|
||||
* Chart.js v4.5.1
|
||||
* https://www.chartjs.org
|
||||
* (c) 2025 Chart.js Contributors
|
||||
* Released under the MIT License
|
||||
*/
|
||||
function t(){}const e=(()=>{let t=0;return()=>t++})();function i(t){return null==t}function s(t){if(Array.isArray&&Array.isArray(t))return!0;const e=Object.prototype.toString.call(t);return"[object"===e.slice(0,7)&&"Array]"===e.slice(-6)}function n(t){return null!==t&&"[object Object]"===Object.prototype.toString.call(t)}function o(t){return("number"==typeof t||t instanceof Number)&&isFinite(+t)}function a(t,e){return o(t)?t:e}function r(t,e){return void 0===t?e:t}const l=(t,e)=>"string"==typeof t&&t.endsWith("%")?parseFloat(t)/100*e:+t;function h(t,e,i){if(t&&"function"==typeof t.call)return t.apply(i,e)}function c(t,e,i,o){let a,r,l;if(s(t))if(r=t.length,o)for(a=r-1;a>=0;a--)e.call(i,t[a],a);else for(a=0;a<r;a++)e.call(i,t[a],a);else if(n(t))for(l=Object.keys(t),r=l.length,a=0;a<r;a++)e.call(i,t[l[a]],l[a])}function d(t,e){let i,s,n,o;if(!t||!e||t.length!==e.length)return!1;for(i=0,s=t.length;i<s;++i)if(n=t[i],o=e[i],n.datasetIndex!==o.datasetIndex||n.index!==o.index)return!1;return!0}function u(t){if(s(t))return t.map(u);if(n(t)){const e=Object.create(null),i=Object.keys(t),s=i.length;let n=0;for(;n<s;++n)e[i[n]]=u(t[i[n]]);return e}return t}function f(t){return-1===["__proto__","prototype","constructor"].indexOf(t)}function g(t,e,i,s){if(!f(t))return;const o=e[t],a=i[t];n(o)&&n(a)?p(o,a,s):e[t]=u(a)}function p(t,e,i){const o=s(e)?e:[e],a=o.length;if(!n(t))return t;const r=(i=i||{}).merger||g;let l;for(let e=0;e<a;++e){if(l=o[e],!n(l))continue;const s=Object.keys(l);for(let e=0,n=s.length;e<n;++e)r(s[e],t,l,i)}return t}function m(t,e){return p(t,e,{merger:x})}function x(t,e,i){if(!f(t))return;const s=e[t],o=i[t];n(s)&&n(o)?m(s,o):Object.prototype.hasOwnProperty.call(e,t)||(e[t]=u(o))}const b={"":t=>t,x:t=>t.x,y:t=>t.y};function _(t,e){const i=b[e]||(b[e]=function(t){const e=function(t){const e=t.split("."),i=[];let s="";for(const t of e)s+=t,s.endsWith("\\")?s=s.slice(0,-1)+".":(i.push(s),s="");return i}(t);return t=>{for(const i of e){if(""===i)break;t=t&&t[i]}return t}}(e));return i(t)}function y(t){return t.charAt(0).toUpperCase()+t.slice(1)}const v=t=>void 0!==t,M=t=>"function"==typeof t,w=(t,e)=>{if(t.size!==e.size)return!1;for(const i of t)if(!e.has(i))return!1;return!0};const k=Math.PI,S=2*k,P=S+k,D=Number.POSITIVE_INFINITY,O=k/180,C=k/2,A=k/4,T=2*k/3,L=Math.log10,E=Math.sign;function R(t,e,i){return Math.abs(t-e)<i}function I(t){const e=Math.round(t);t=R(t,e,t/1e3)?e:t;const i=Math.pow(10,Math.floor(L(t))),s=t/i;return(s<=1?1:s<=2?2:s<=5?5:10)*i}function F(t){return!function(t){return"symbol"==typeof t||"object"==typeof t&&null!==t&&!(Symbol.toPrimitive in t||"toString"in t||"valueOf"in t)}(t)&&!isNaN(parseFloat(t))&&isFinite(t)}function z(t,e,i){let s,n,o;for(s=0,n=t.length;s<n;s++)o=t[s][i],isNaN(o)||(e.min=Math.min(e.min,o),e.max=Math.max(e.max,o))}function V(t){return t*(k/180)}function B(t){return t*(180/k)}function W(t){if(!o(t))return;let e=1,i=0;for(;Math.round(t*e)/e!==t;)e*=10,i++;return i}function N(t,e){const i=e.x-t.x,s=e.y-t.y,n=Math.sqrt(i*i+s*s);let o=Math.atan2(s,i);return o<-.5*k&&(o+=S),{angle:o,distance:n}}function H(t,e){return Math.sqrt(Math.pow(e.x-t.x,2)+Math.pow(e.y-t.y,2))}function j(t,e){return(t-e+P)%S-k}function $(t){return(t%S+S)%S}function Y(t,e,i,s){const n=$(t),o=$(e),a=$(i),r=$(o-n),l=$(a-n),h=$(n-o),c=$(n-a);return n===o||n===a||s&&o===a||r>l&&h<c}function U(t,e,i){return Math.max(e,Math.min(i,t))}function X(t,e,i,s=1e-6){return t>=Math.min(e,i)-s&&t<=Math.max(e,i)+s}function q(t,e,i){i=i||(i=>t[i]<e);let s,n=t.length-1,o=0;for(;n-o>1;)s=o+n>>1,i(s)?o=s:n=s;return{lo:o,hi:n}}const K=(t,e,i,s)=>q(t,i,s?s=>{const n=t[s][e];return n<i||n===i&&t[s+1][e]===i}:s=>t[s][e]<i),G=(t,e,i)=>q(t,i,(s=>t[s][e]>=i));const J=["push","pop","shift","splice","unshift"];function Z(t,e){const i=t._chartjs;if(!i)return;const s=i.listeners,n=s.indexOf(e);-1!==n&&s.splice(n,1),s.length>0||(J.forEach((e=>{delete t[e]})),delete t._chartjs)}function Q(t){const e=new Set(t);return e.size===t.length?t:Array.from(e)}const tt="undefined"==typeof window?function(t){return t()}:window.requestAnimationFrame;function et(t,e){let i=[],s=!1;return function(...n){i=n,s||(s=!0,tt.call(window,(()=>{s=!1,t.apply(e,i)})))}}const it=t=>"start"===t?"left":"end"===t?"right":"center",st=(t,e,i)=>"start"===t?e:"end"===t?i:(e+i)/2;function nt(t,e,s){const n=e.length;let o=0,a=n;if(t._sorted){const{iScale:r,vScale:l,_parsed:h}=t,c=t.dataset&&t.dataset.options?t.dataset.options.spanGaps:null,d=r.axis,{min:u,max:f,minDefined:g,maxDefined:p}=r.getUserBounds();if(g){if(o=Math.min(K(h,d,u).lo,s?n:K(e,d,r.getPixelForValue(u)).lo),c){const t=h.slice(0,o+1).reverse().findIndex((t=>!i(t[l.axis])));o-=Math.max(0,t)}o=U(o,0,n-1)}if(p){let t=Math.max(K(h,r.axis,f,!0).hi+1,s?0:K(e,d,r.getPixelForValue(f),!0).hi+1);if(c){const e=h.slice(t-1).findIndex((t=>!i(t[l.axis])));t+=Math.max(0,e)}a=U(t,o,n)-o}else a=n-o}return{start:o,count:a}}function ot(t){const{xScale:e,yScale:i,_scaleRanges:s}=t,n={xmin:e.min,xmax:e.max,ymin:i.Line truncated
|
||||
/*!
|
||||
* @kurkle/color v0.3.2
|
||||
* https://github.com/kurkle/color#readme
|
||||
* (c) 2023 Jukka Kurkela
|
||||
* Released under the MIT License
|
||||
*/
|
||||
function ut(t){return t+.5|0}const ft=(t,e,i)=>Math.max(Math.min(t,i),e);function gt(t){return ft(ut(2.55*t),0,255)}function pt(t){return ft(ut(255*t),0,255)}function mt(t){return ft(ut(t/2.55)/100,0,1)}function xt(t){return ft(ut(100*t),0,100)}const bt={0:0,1:1,2:2,3:3,4:4,5:5,6:6,7:7,8:8,9:9,A:10,B:11,C:12,D:13,E:14,F:15,a:10,b:11,c:12,d:13,e:14,f:15},_t=[..."0123456789ABCDEF"],yt=t=>_t[15&t],vt=t=>_t[(240&t)>>4]+_t[15&t],Mt=t=>(240&t)>>4==(15&t);function wt(t){var e=(t=>Mt(t.r)&&Mt(t.g)&&Mt(t.b)&&Mt(t.a))(t)?yt:vt;return t?"#"+e(t.r)+e(t.g)+e(t.b)+((t,e)=>t<255?e(t):"")(t.a,e):void 0}const kt=/^(hsla?|hwb|hsv)\(\s*([-+.e\d]+)(?:deg)?[\s,]+([-+.e\d]+)%[\s,]+([-+.e\d]+)%(?:[\s,]+([-+.e\d]+)(%)?)?\s*\)$/;function St(t,e,i){const s=e*Math.min(i,1-i),n=(e,n=(e+t/30)%12)=>i-s*Math.max(Math.min(n-3,9-n,1),-1);return[n(0),n(8),n(4)]}function Pt(t,e,i){const s=(s,n=(s+t/60)%6)=>i-i*e*Math.max(Math.min(n,4-n,1),0);return[s(5),s(3),s(1)]}function Dt(t,e,i){const s=St(t,1,.5);let n;for(e+i>1&&(n=1/(e+i),e*=n,i*=n),n=0;n<3;n++)s[n]*=1-e-i,s[n]+=e;return s}function Ot(t){const e=t.r/255,i=t.g/255,s=t.b/255,n=Math.max(e,i,s),o=Math.min(e,i,s),a=(n+o)/2;let r,l,h;return n!==o&&(h=n-o,l=a>.5?h/(2-n-o):h/(n+o),r=function(t,e,i,s,n){return t===n?(e-i)/s+(e<i?6:0):e===n?(i-t)/s+2:(t-e)/s+4}(e,i,s,h,n),r=60*r+.5),[0|r,l||0,a]}function Ct(t,e,i,s){return(Array.isArray(e)?t(e[0],e[1],e[2]):t(e,i,s)).map(pt)}function At(t,e,i){return Ct(St,t,e,i)}function Tt(t){return(t%360+360)%360}function Lt(t){const e=kt.exec(t);let i,s=255;if(!e)return;e[5]!==i&&(s=e[6]?gt(+e[5]):pt(+e[5]));const n=Tt(+e[2]),o=+e[3]/100,a=+e[4]/100;return i="hwb"===e[1]?function(t,e,i){return Ct(Dt,t,e,i)}(n,o,a):"hsv"===e[1]?function(t,e,i){return Ct(Pt,t,e,i)}(n,o,a):At(n,o,a),{r:i[0],g:i[1],b:i[2],a:s}}const Et={x:"dark",Z:"light",Y:"re",X:"blu",W:"gr",V:"medium",U:"slate",A:"ee",T:"ol",S:"or",B:"ra",C:"lateg",D:"ights",R:"in",Q:"turquois",E:"hi",P:"ro",O:"al",N:"le",M:"de",L:"yello",F:"en",K:"ch",G:"arks",H:"ea",I:"ightg",J:"wh"},Rt={OiceXe:"f0f8ff",antiquewEte:"faebd7",aqua:"ffff",aquamarRe:"7fffd4",azuY:"f0ffff",beige:"f5f5dc",bisque:"ffe4c4",black:"0",blanKedOmond:"ffebcd",Xe:"ff",XeviTet:"8a2be2",bPwn:"a52a2a",burlywood:"deb887",caMtXe:"5f9ea0",KartYuse:"7fff00",KocTate:"d2691e",cSO:"ff7f50",cSnflowerXe:"6495ed",cSnsilk:"fff8dc",crimson:"dc143c",cyan:"ffff",xXe:"8b",xcyan:"8b8b",xgTMnPd:"b8860b",xWay:"a9a9a9",xgYF:"6400",xgYy:"a9a9a9",xkhaki:"bdb76b",xmagFta:"8b008b",xTivegYF:"556b2f",xSange:"ff8c00",xScEd:"9932cc",xYd:"8b0000",xsOmon:"e9967a",xsHgYF:"8fbc8f",xUXe:"483d8b",xUWay:"2f4f4f",xUgYy:"2f4f4f",xQe:"ced1",xviTet:"9400d3",dAppRk:"ff1493",dApskyXe:"bfff",dimWay:"696969",dimgYy:"696969",dodgerXe:"1e90ff",fiYbrick:"b22222",flSOwEte:"fffaf0",foYstWAn:"228b22",fuKsia:"ff00ff",gaRsbSo:"dcdcdc",ghostwEte:"f8f8ff",gTd:"ffd700",gTMnPd:"daa520",Way:"808080",gYF:"8000",gYFLw:"adff2f",gYy:"808080",honeyMw:"f0fff0",hotpRk:"ff69b4",RdianYd:"cd5c5c",Rdigo:"4b0082",ivSy:"fffff0",khaki:"f0e68c",lavFMr:"e6e6fa",lavFMrXsh:"fff0f5",lawngYF:"7cfc00",NmoncEffon:"fffacd",ZXe:"add8e6",ZcSO:"f08080",Zcyan:"e0ffff",ZgTMnPdLw:"fafad2",ZWay:"d3d3d3",ZgYF:"90ee90",ZgYy:"d3d3d3",ZpRk:"ffb6c1",ZsOmon:"ffa07a",ZsHgYF:"20b2aa",ZskyXe:"87cefa",ZUWay:"778899",ZUgYy:"778899",ZstAlXe:"b0c4de",ZLw:"ffffe0",lime:"ff00",limegYF:"32cd32",lRF:"faf0e6",magFta:"ff00ff",maPon:"800000",VaquamarRe:"66cdaa",VXe:"cd",VScEd:"ba55d3",VpurpN:"9370db",VsHgYF:"3cb371",VUXe:"7b68ee",VsprRggYF:"fa9a",VQe:"48d1cc",VviTetYd:"c71585",midnightXe:"191970",mRtcYam:"f5fffa",mistyPse:"ffe4e1",moccasR:"ffe4b5",navajowEte:"ffdead",navy:"80",Tdlace:"fdf5e6",Tive:"808000",TivedBb:"6b8e23",Sange:"ffa500",SangeYd:"ff4500",ScEd:"da70d6",pOegTMnPd:"eee8aa",pOegYF:"98fb98",pOeQe:"afeeee",pOeviTetYd:"db7093",papayawEp:"ffefd5",pHKpuff:"ffdab9",peru:"cd853f",pRk:"ffc0cb",plum:"dda0dd",powMrXe:"b0e0e6",purpN:"800080",YbeccapurpN:"663399",Yd:"ff0000",Psybrown:"bc8f8f",PyOXe:"4169e1",saddNbPwn:"8b4513",sOmon:"fa8072",sandybPwn:"f4a460",sHgYF:"2e8b57",sHshell:"fff5ee",siFna:"a0522d",silver:"c0c0c0",skyXe:"87ceeb",UXe:"6a5acd",UWay:"708090",UgYy:"708090",snow:"fffafa",sprRggYF:"ff7f",stAlXe:"4682b4",tan:"d2b48c",teO:"8080",tEstN:"d8bfd8",tomato:"ff6347",Qe:"40e0d0",viTet:"ee82ee",JHt:"f5deb3",wEte:"ffffff",wEtesmoke:"f5f5f5",Lw:"ffff00",LwgYF:"9acd32"};let It;function Ft(t){It||(It=function(){const t={},e=Object.keys(Rt),i=Object.keys(Et);let s,n,o,a,r;for(s=0;s<e.length;s++){for(a=r=e[s],n=0;n<i.length;n++)o=i[n],r=r.replace(o,Et[o]);o=parseInt(Rt[a],16),t[r]=[o>>16&255,o>>8&255,255&o]}return t}(),It.transparent=[0,0,0,0]);const e=It[t.toLowerCase()];return e&&{r:e[0],g:e[1],b:e[2],a:4===e.length?e[3]:255}}const zt=/^rgba?\(\s*([-+.\d]+)(%)?[\s,]+([-+.e\d]+)(%)?[\s,]+([-+.e\d]+)(%)?(?:[\s,/]+([-+.e\d]+)(%)?)?\s*\)$/;const Vt=t=>t<=.0031308?12.92*t:1.055*Math.pow(t,1/2.4)-.055,Bt=t=>t<=.04045?t/12.92:Math.pow((t+.055)/1.055,2.4);function Wt(t,e,i){if(t){let s=Ot(t);s[e]=Math.max(0,Math.min(s[e]+s[e]*i,0===e?360:1)),s=ALine truncated
|
||||
@@ -2,4 +2,18 @@
|
||||
.ui-autocomplete .autocomplete-meta {
|
||||
color: #888;
|
||||
font-size: 0.9em;
|
||||
}
|
||||
}
|
||||
/* Contextual links on their own line under the page title (customer and vehicle pages), where a long title and
|
||||
many links would otherwise crowd each other */
|
||||
#content .contextual.qbo-under-title {
|
||||
float: none;
|
||||
text-align: right;
|
||||
white-space: normal;
|
||||
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;
|
||||
}
|
||||
+190
-2
@@ -11,6 +11,11 @@
|
||||
# English strings go here for Rails i18n
|
||||
# Usage I18n.t(:label)
|
||||
en:
|
||||
button_create_estimate_subtasks: "Create subtasks from estimate"
|
||||
error_estimate_parent_not_found: "Parent task #%{id} wasn't found, or you can't see it."
|
||||
error_estimate_parent_not_allowed: "You aren't allowed to add subtasks in %{project}."
|
||||
label_estimate_parent_placeholder: "Optional"
|
||||
text_estimate_parent_info: "The issues are created as subtasks. They get the parent's customer, and the vehicle and custom field values below start from the parent's; any left empty are filled from the parent."
|
||||
notice_qbo_oauth_state_mismatch: "QuickBooks connection was not completed: the request could not be verified. Please try connecting again."
|
||||
permission_bill_issues: "Bill issue time to QuickBooks"
|
||||
permission_share_issues_with_customers: "Share issues with customers"
|
||||
@@ -65,7 +70,8 @@ en:
|
||||
label_new_customer: "New Customer"
|
||||
label_new_issue: "New Issue"
|
||||
label_qbo_never_synced: "Never Synced"
|
||||
label_no_customers: "There are no customers matching the search term(s)."
|
||||
label_no_customers: "No customers match \"%{search}\"."
|
||||
text_customers_best_match: "%{count} best matches, closest first. Click a column to sort them by it instead."
|
||||
label_no_estimates: "No Estimates"
|
||||
label_no_invoices: "No Invoices"
|
||||
label_oauth2_refresh_token_expires_at: "Refresh Token Expires At"
|
||||
@@ -116,6 +122,9 @@ en:
|
||||
permission_send_estimates: "Email estimates"
|
||||
permission_write_invoices: "Write invoices"
|
||||
permission_send_invoices: "Email invoices"
|
||||
permission_edit_partially_paid_invoices: "Edit partially paid invoices"
|
||||
permission_edit_paid_invoices: "Edit paid invoices"
|
||||
error_invoice_paid_not_allowed: "You're not allowed to change invoices with this much paid on them"
|
||||
permission_create_estimate_issues: "Create issues from estimates"
|
||||
permission_receive_payments: "Receive payments"
|
||||
|
||||
@@ -128,8 +137,39 @@ 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"
|
||||
|
||||
# Estimate and invoice drafts
|
||||
label_qbo_drafts: "Drafts"
|
||||
label_qbo_draft_document: "Draft"
|
||||
label_qbo_draft_lines: "Lines"
|
||||
label_qbo_draft_saved_by: "Last saved"
|
||||
label_qbo_estimate_draft: "Estimate draft"
|
||||
label_qbo_invoice_draft: "Invoice draft"
|
||||
button_qbo_save_draft: "Save draft"
|
||||
button_qbo_delete_draft: "Delete draft"
|
||||
button_qbo_continue_draft: "Continue"
|
||||
notice_qbo_draft_saved: "Draft saved. It's kept in Redmine only, until you save it to QuickBooks."
|
||||
notice_qbo_draft_deleted: "Draft deleted."
|
||||
error_qbo_draft_not_found: "That draft is gone. It may have been finished or deleted."
|
||||
text_qbo_draft_saved_by: "%{user}, %{age} ago"
|
||||
text_qbo_editing_draft: "Draft, not in QuickBooks yet. Last saved by %{user}, %{age} ago. Save it to send it to QuickBooks; that deletes the draft."
|
||||
text_qbo_customer_has_estimate_drafts:
|
||||
one: "This customer has an estimate draft:"
|
||||
other: "This customer has %{count} estimate drafts:"
|
||||
text_qbo_customer_has_invoice_drafts:
|
||||
one: "This customer has an invoice draft:"
|
||||
other: "This customer has %{count} invoice drafts:"
|
||||
text_qbo_draft_link: "%{subtotal}, saved by %{user} %{date}"
|
||||
text_qbo_drafts_info: "New estimates and invoices saved as drafts. They're kept in Redmine only, so nothing is in QuickBooks (and no deposit is applied to an invoice) until a draft is saved from the editor."
|
||||
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"
|
||||
# Shown in the action bar while a save is on its way, with the buttons locked
|
||||
text_qbo_saving: "Saving to QuickBooks…"
|
||||
text_qbo_saving_and_sending: "Saving and sending…"
|
||||
text_qbo_saving_draft: "Saving draft…"
|
||||
|
||||
error_estimate_changed_in_quickbooks: "This estimate was changed in QuickBooks after you opened it, so it wasn't saved."
|
||||
error_estimate_field_invalid: "%{field} is not valid"
|
||||
@@ -148,6 +188,14 @@ en:
|
||||
label_choose_a_customer: "Choose a customer"
|
||||
label_customer_email: "Customer email"
|
||||
label_discount_from_quickbooks: "Discount"
|
||||
label_discount_amount: "$"
|
||||
label_discount_percent: "%"
|
||||
label_discount_type: "Discount type"
|
||||
error_discount_too_large: "The discount can't be more than the subtotal"
|
||||
error_invoice_below_paid: "The invoice total (about %{total} with tax) can't be less than the %{paid} already paid on it"
|
||||
button_unlock_invoice: "Unlock to edit"
|
||||
text_unlock_invoice_confirmation: "A payment has been applied to this invoice. Unlock it to make changes, such as a discount? The payment stays applied, and the total can't go below what's been paid."
|
||||
text_invoice_unlocked: "Unlocked: %{paid} has been paid on this invoice. The payment stays applied when you save, and the total can't go below it."
|
||||
label_drag_to_reorder: "Drag to reorder"
|
||||
label_estimate_date: "Estimate date"
|
||||
label_estimate_expiration_days: "Estimates expire after (days)"
|
||||
@@ -241,6 +289,7 @@ en:
|
||||
label_invoice_date: "Invoice date"
|
||||
label_invoice_no: "Invoice no."
|
||||
label_invoice_status_paid: "Paid"
|
||||
label_invoice_status_paid_on: "Paid %{date}"
|
||||
label_invoice_status_partial: "Partially paid"
|
||||
label_invoice_status_overdue: "Overdue"
|
||||
label_invoice_status_open: "Open"
|
||||
@@ -255,8 +304,11 @@ 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). The time goes where the first ticked line is."
|
||||
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."
|
||||
|
||||
# Issues from estimates (moved from redmine_qbo_calendar)
|
||||
button_create_estimate_issues_submit: "Create issues"
|
||||
@@ -267,6 +319,7 @@ en:
|
||||
label_default_project: "Default project"
|
||||
label_default_tracker: "Default tracker"
|
||||
label_estimate_issue_fields: "Issue fields"
|
||||
label_estimate_issue_dates: "Dates"
|
||||
label_estimate_issue_settings: "Issues from estimates"
|
||||
label_estimate_item: "Item"
|
||||
label_estimate_line_already_created: "Already created"
|
||||
@@ -288,6 +341,12 @@ en:
|
||||
button_print_payment: "Print"
|
||||
button_receive_payment: "Receive payment"
|
||||
button_save_payment: "Save payment"
|
||||
button_reload_payment: "Reload the payment"
|
||||
label_edit_payment: "Edit payment"
|
||||
notice_payment_updated: "Payment of %{amount} updated in QuickBooks"
|
||||
error_payment_changed_in_quickbooks: "This payment was changed in QuickBooks after this page was opened"
|
||||
error_payment_not_editable: "This payment also applies %{types}, which can't be shown here. Edit it in QuickBooks."
|
||||
text_payment_reload: "Reload it to see the changes, then make yours again."
|
||||
error_payment_amount: "Enter the amount received"
|
||||
error_payment_needs_method: "Choose the payment method"
|
||||
error_payment_not_saved: "QuickBooks didn't save the payment"
|
||||
@@ -309,6 +368,8 @@ en:
|
||||
permission_view_business_reports: "View business reports"
|
||||
label_business_report: "Business report"
|
||||
label_report_period: "Period"
|
||||
label_report_period_this_week: "This week"
|
||||
label_report_period_last_week: "Last week"
|
||||
label_report_period_this_month: "This month"
|
||||
label_report_period_last_month: "Last month"
|
||||
label_report_period_this_quarter: "This quarter"
|
||||
@@ -319,8 +380,19 @@ en:
|
||||
label_report_money: "Sales"
|
||||
label_report_hours: "Hours"
|
||||
label_report_by_month: "By month"
|
||||
label_report_compare_last_year: "Compare with last year"
|
||||
label_report_last_year: "last year"
|
||||
label_report_estimates_written: "Estimates written"
|
||||
label_report_invoices_written: "Invoices written"
|
||||
label_report_invoices_paid: "Invoices paid in full"
|
||||
label_report_taxes: "Sales tax"
|
||||
label_report_tax_invoiced: "Tax invoiced"
|
||||
label_report_tax_collected: "Tax collected"
|
||||
label_report_taxed_invoices:
|
||||
one: "1 invoice"
|
||||
other: "%{count} invoices"
|
||||
text_report_taxes: "Tax invoiced is the sales tax on invoices dated in the period (accrual); tax collected is the sales tax on invoices paid in full in the period (cash), counted on the day each was paid in full. Sales receipts and refunds aren't included: file from QuickBooks' Sales Tax Liability report."
|
||||
text_report_without_tax: "Estimates and invoices are without sales tax; invoices paid in full count on the day they were paid in full. Payments are as received, so collected vs. invoiced compares them with the invoices' totals with tax."
|
||||
label_report_payments_received: "Payments received"
|
||||
label_report_estimate_hours: "Estimated (estimates)"
|
||||
label_report_issue_hours: "Estimated (issues)"
|
||||
@@ -339,6 +411,10 @@ en:
|
||||
text_qbo_sync_queued: "waiting to sync"
|
||||
text_report_needs_sync: "%{count} estimates or invoices in this period don't have their total or hours yet. Run a full sync from QuickBooks to fill them in."
|
||||
text_report_notes: "Estimates, invoices and payments count by their QuickBooks date; their hours are the quantities of the labor products/services. Issues' estimated time counts issues created in the period, without subtasks. Spent time counts time logged in the period."
|
||||
label_report_remember_projects: "Remember these projects"
|
||||
text_report_projects: "For issues' estimated time and spent time. None picked: every project. Ctrl/Cmd-click to pick several."
|
||||
text_report_saved_projects: "Opens with: %{projects}"
|
||||
text_report_projects_filtered: "Only issues' estimated time and spent time are limited to these projects. Estimates, invoices and payments come from QuickBooks, which has no projects, so they cover the whole business (and so does the CPI's invoiced hours)."
|
||||
notice_payment_not_found: "Payment not found in QuickBooks"
|
||||
notice_payment_saved: "Payment of %{amount} saved in QuickBooks"
|
||||
text_no_payment_methods: "QuickBooks' payment methods couldn't be read. Check the QuickBooks connection."
|
||||
@@ -346,3 +422,115 @@ 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"
|
||||
|
||||
# ---- 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."
|
||||
+12
-1
@@ -68,8 +68,19 @@ resources :qbo_invoices, only: [:new, :create, :edit, :update] do
|
||||
end
|
||||
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] do
|
||||
resources :qbo_payments, only: [:index, :new, :create, :show, :edit, :update] do
|
||||
member do
|
||||
get :pdf
|
||||
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.
|
||||
|
||||
# Estimate and invoice drafts: what's filled in on the editor, kept in Redmine until it's saved to QuickBooks
|
||||
class CreateQboDrafts < ActiveRecord::Migration[7.0]
|
||||
def up
|
||||
return if table_exists?(:qbo_drafts)
|
||||
|
||||
create_table :qbo_drafts do |t|
|
||||
t.string :document, null: false, limit: 20
|
||||
t.bigint :customer_id
|
||||
# Who saved it last
|
||||
t.integer :user_id
|
||||
# The editor's fields, as posted (JSON)
|
||||
t.text :data, size: :medium
|
||||
t.timestamps
|
||||
end
|
||||
add_index :qbo_drafts, [:document, :customer_id]
|
||||
end
|
||||
|
||||
def down
|
||||
drop_table :qbo_drafts if table_exists?(:qbo_drafts)
|
||||
end
|
||||
end
|
||||
@@ -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
|
||||
@@ -0,0 +1,20 @@
|
||||
#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.
|
||||
|
||||
# An invoice's sales tax and the day it was paid in full, cached like its total and balance, so reports (e.g.
|
||||
# redmine_qbo_commission's monthly paid sales) don't have to read invoices from QuickBooks. A full invoice sync
|
||||
# fills them in for invoices synced before.
|
||||
class AddInvoiceTaxAndPaidOn < ActiveRecord::Migration[7.0]
|
||||
def change
|
||||
add_column :invoices, :tax_amount, :decimal, precision: 15, scale: 2 unless column_exists?(:invoices, :tax_amount)
|
||||
add_column :invoices, :paid_on, :date unless column_exists?(:invoices, :paid_on)
|
||||
add_index :invoices, :paid_on unless index_exists?(:invoices, :paid_on)
|
||||
end
|
||||
end
|
||||
@@ -0,0 +1,17 @@
|
||||
#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.
|
||||
|
||||
# An estimate's sales tax, cached like its total, so the business report can compare estimates and invoices
|
||||
# without tax. A full estimate sync fills it in for estimates synced before.
|
||||
class AddEstimateTax < ActiveRecord::Migration[7.0]
|
||||
def change
|
||||
add_column :estimates, :tax_amount, :decimal, precision: 15, scale: 2 unless column_exists?(:estimates, :tax_amount)
|
||||
end
|
||||
end
|
||||
@@ -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.4'
|
||||
version '2026.11.22'
|
||||
url 'https://github.com/rickbarrette/redmine_qbo'
|
||||
author_url 'https://barrettefabrication.com'
|
||||
settings default: {empty: true}, partial: 'qbo/settings'
|
||||
@@ -27,9 +27,6 @@ Redmine::Plugin.register :redmine_qbo do
|
||||
User.safe_attributes :employee_id
|
||||
TimeEntry.safe_attributes :billed
|
||||
|
||||
# set per_page globally
|
||||
WillPaginate.per_page = 20
|
||||
|
||||
# Global Permissions
|
||||
# autocomplete and the filter_* actions feed the customer, estimate and invoice pickers on issue forms
|
||||
permission :view_customers, { customers: [:index, :show, :autocomplete,
|
||||
@@ -43,18 +40,32 @@ Redmine::Plugin.register :redmine_qbo do
|
||||
|
||||
# Billing (global): estimates, invoices, payments, issues from estimates
|
||||
# customer_info and items feed the customer details and product/service search on the estimate/invoice editor
|
||||
permission :write_estimates, { qbo_estimates: [:new, :create, :edit, :update, :customer_info, :items] }, global: true
|
||||
# Drafts (QboDraft): each user sees the drafts of the documents they may write
|
||||
permission :write_estimates, { qbo_estimates: [:new, :create, :edit, :update, :customer_info, :items],
|
||||
qbo_drafts: [:index, :destroy] }, global: true
|
||||
permission :send_estimates, { qbo_estimates: [:send_email] }, global: true
|
||||
permission :create_estimate_issues, { qbo_estimates: [:issues_preview, :create_issues] }, global: true
|
||||
permission :write_invoices, { qbo_invoices: [:new, :create, :edit, :update, :import_options],
|
||||
qbo_estimates: [:customer_info, :items] }, global: true
|
||||
qbo_estimates: [:customer_info, :items], qbo_drafts: [:index, :destroy] }, global: true
|
||||
permission :send_invoices, { qbo_invoices: [:send_email] }, global: true
|
||||
# Unlocking an invoice with a payment applied (on top of Write invoices); see RedmineQboBilling.paid_invoice_editor?
|
||||
permission :edit_partially_paid_invoices, {}, global: true
|
||||
permission :edit_paid_invoices, {}, global: true
|
||||
permission :view_payments, { qbo_payments: [:index, :show, :pdf] }, global: true
|
||||
permission :receive_payments, { qbo_payments: [:index, :new, :create, :show, :pdf, :open_invoices],
|
||||
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)
|
||||
|
||||
# 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,
|
||||
|
||||
@@ -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
|
||||
@@ -103,6 +103,9 @@ module RedmineQbo
|
||||
left << [l(:field_status), issue.status]
|
||||
left << [l(:field_priority), issue.priority]
|
||||
left << [l(:field_customer), issue.customer&.name]
|
||||
left << [l(:field_estimate), issue.estimate.doc_number] if issue.estimate
|
||||
invoice_numbers = issue.invoices.map(&:doc_number).compact_blank
|
||||
left << [invoice_numbers.size > 1 ? l(:label_invoices) : l(:field_invoice), invoice_numbers.join(', ')] if invoice_numbers.any?
|
||||
left << [l(:field_assigned_to), issue.assigned_to] unless issue.disabled_core_fields.include?(:assigned_to_id)
|
||||
|
||||
log "Calling :pdf_left hook"
|
||||
|
||||
@@ -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
|
||||
@@ -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
|
||||
|
||||
@@ -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)
|
||||
@@ -93,6 +98,13 @@ module RedmineQboBilling
|
||||
user.allowed_to?(:write_invoices, nil, global: true)
|
||||
end
|
||||
|
||||
# True when the user may unlock and change an invoice with a payment applied: a paid-off one needs
|
||||
# "Edit paid invoices", a partly paid one "Edit partially paid invoices" (both on top of "Write invoices")
|
||||
def self.paid_invoice_editor?(fully_paid, user = User.current)
|
||||
invoice_writer?(user) &&
|
||||
user.allowed_to?(fully_paid ? :edit_paid_invoices : :edit_partially_paid_invoices, nil, global: true)
|
||||
end
|
||||
|
||||
# True when the user may email invoices to customers
|
||||
def self.invoice_sender?(user = User.current)
|
||||
user.allowed_to?(:send_invoices, nil, global: true)
|
||||
|
||||
@@ -12,21 +12,31 @@
|
||||
module RedmineQboBilling
|
||||
# Business figures for a date range, from the estimates, invoices and payments cached from QuickBooks and from
|
||||
# Redmine's issues and spent time:
|
||||
# money: estimates written, invoices written, payments received (totals and counts)
|
||||
# money: estimates written, invoices written, invoices paid in full, payments received (totals and counts);
|
||||
# estimates and invoices without sales tax (it isn't the shop's revenue), payments as received
|
||||
# taxes: sales tax on invoices written (by their date) and on invoices paid in full (by that day)
|
||||
# hours: man-hours on estimates, issues' estimated time, man-hours invoiced, time spent
|
||||
# with a month-by-month breakdown. Estimates, invoices and payments count by their QuickBooks date, issues by
|
||||
# the day they were created (only issues without subtasks, so parents' totals aren't counted twice), and
|
||||
# spent time by the day it was spent.
|
||||
# spent time by the day it was spent. project_ids limits the issues and spent time to those projects; the
|
||||
# QuickBooks figures have no project, so they always cover the whole business.
|
||||
class BusinessReport
|
||||
PERIODS = %w[this_month last_month this_quarter last_quarter this_year last_year custom].freeze
|
||||
MONEY = %i[estimates invoices payments].freeze
|
||||
PERIODS = %w[this_week last_week this_month last_month this_quarter last_quarter this_year last_year custom].freeze
|
||||
WEEK_DAYS = { 1 => :monday, 6 => :saturday, 7 => :sunday }.freeze
|
||||
# Chart points: a day each for up to two weeks, a week each up to about three months, else a month each
|
||||
DAILY_UP_TO = 14
|
||||
WEEKLY_UP_TO = 93
|
||||
MONEY = %i[estimates invoices paid payments].freeze
|
||||
HOURS = %i[estimate_hours issue_hours invoice_hours spent_hours].freeze
|
||||
TAXES = %i[tax_invoiced tax_collected].freeze
|
||||
|
||||
attr_reader :from, :to, :period
|
||||
attr_reader :from, :to, :period, :project_ids
|
||||
|
||||
# The dates for a period, from today: [from, to]. "custom" uses the given dates (either can be blank).
|
||||
def self.range_for(period, today: Date.current, from: nil, to: nil)
|
||||
def self.range_for(period, today: Date.current, from: nil, to: nil, week_start: :monday)
|
||||
case period.to_s
|
||||
when 'this_week' then [today.beginning_of_week(week_start), today.end_of_week(week_start)]
|
||||
when 'last_week' then w = today - 7; [w.beginning_of_week(week_start), w.end_of_week(week_start)]
|
||||
when 'this_month' then [today.beginning_of_month, today.end_of_month]
|
||||
when 'last_month' then m = today.prev_month; [m.beginning_of_month, m.end_of_month]
|
||||
when 'this_quarter' then [today.beginning_of_quarter, today.end_of_quarter]
|
||||
@@ -47,26 +57,142 @@ module RedmineQboBilling
|
||||
nil
|
||||
end
|
||||
|
||||
# data (for tests): { estimates: [[date, total, hours]], invoices: [[date, total, hours, balance]],
|
||||
# payments: [[date, total]], issues: [[date, estimated_hours]], time_entries: [[date, hours]] }
|
||||
def initialize(period: 'this_year', from: nil, to: nil, today: Date.current, data: nil)
|
||||
# data (for tests): { estimates: [[date, total, hours, tax]], invoices: [[date, total, hours, balance, tax]],
|
||||
# paid: [[paid_on, total, tax]], payments: [[date, total]], issues: [[date, estimated_hours]],
|
||||
# time_entries: [[date, hours]] }. Tax may be left off (none).
|
||||
# week_start: the first day of a week (:monday, :saturday or :sunday); see week_start_from_setting.
|
||||
# previous_data (for tests): last year's data, like data.
|
||||
# project_ids: the projects whose issues and spent time count; blank for every project.
|
||||
def initialize(period: 'this_year', from: nil, to: nil, today: Date.current, data: nil, week_start: :monday,
|
||||
previous_data: nil, project_ids: nil)
|
||||
@period = PERIODS.include?(period.to_s) ? period.to_s : 'this_year'
|
||||
@from, @to = self.class.range_for(@period, today: today, from: from, to: to)
|
||||
@week_start = week_start
|
||||
@from, @to = self.class.range_for(@period, today: today, from: from, to: to, week_start: week_start)
|
||||
@today = today
|
||||
@data = data
|
||||
@previous_data = previous_data
|
||||
@project_ids = Array(project_ids).map(&:to_i).select(&:positive?).uniq
|
||||
end
|
||||
|
||||
# Whether the issues and spent time are limited to some projects
|
||||
def projects_filtered?
|
||||
project_ids.any?
|
||||
end
|
||||
|
||||
# Redmine's "Start calendars on" setting (1 Monday, 6 Saturday, 7 Sunday); Monday when it follows the language
|
||||
def self.week_start_from_setting(value)
|
||||
WEEK_DAYS[value.to_i] || :monday
|
||||
end
|
||||
|
||||
# ---- charts ----
|
||||
|
||||
# :day, :week or :month, from the length of the period
|
||||
def granularity
|
||||
days = (to - from).to_i + 1
|
||||
return :day if days <= DAILY_UP_TO
|
||||
days <= WEEKLY_UP_TO ? :week : :month
|
||||
end
|
||||
|
||||
# The chart's points as [first day, last day] pairs covering the period
|
||||
def buckets
|
||||
@buckets ||= begin
|
||||
list = []
|
||||
case granularity
|
||||
when :day
|
||||
(from..to).each { |day| list << [day, day] }
|
||||
when :week
|
||||
start = from.beginning_of_week(@week_start)
|
||||
while start <= to
|
||||
list << [[start, from].max, [start + 6, to].min]
|
||||
start += 7
|
||||
end
|
||||
else
|
||||
start = from.beginning_of_month
|
||||
while start <= to
|
||||
list << [[start, from].max, [start.end_of_month, to].min]
|
||||
start = start.next_month
|
||||
end
|
||||
end
|
||||
list
|
||||
end
|
||||
end
|
||||
|
||||
# The same points a year earlier. Days and weeks go back 52 weeks, so a Monday lines up with a Monday;
|
||||
# months go back to the same month.
|
||||
def previous_buckets
|
||||
@previous_buckets ||= if granularity == :month
|
||||
buckets.map { |a, b| [a.prev_year, b.prev_year] }
|
||||
else
|
||||
buckets.map { |a, b| [a - 364, b - 364] }
|
||||
end
|
||||
end
|
||||
|
||||
# Everything the line charts need: the points' start dates, this period's figures per point (nil after
|
||||
# today, so the line stops there), and last year's for the same points (the toggle shows them).
|
||||
# { granularity:, points: ["2026-10-26", ...],
|
||||
# current: { estimates: [...], invoices:, payments:, estimate_hours:, issue_hours:, invoice_hours:, spent_hours: },
|
||||
# previous: { same keys } }
|
||||
def chart
|
||||
current = sums_by_bucket(data, buckets)
|
||||
current.each_value { |values| buckets.each_with_index { |(a, _), i| values[i] = nil if a > @today } }
|
||||
{
|
||||
granularity: granularity,
|
||||
points: buckets.map { |a, _| a.iso8601 },
|
||||
ends: buckets.map { |_, b| b.iso8601 },
|
||||
previous_points: previous_buckets.map { |a, _| a.iso8601 },
|
||||
current: current,
|
||||
previous: sums_by_bucket(previous_data, previous_buckets)
|
||||
}
|
||||
end
|
||||
|
||||
# Last year's data for the chart's points
|
||||
def previous_data
|
||||
@previous_data ||= load_data(previous_buckets.first[0], previous_buckets.last[1])
|
||||
end
|
||||
|
||||
def data
|
||||
@data ||= load_data
|
||||
end
|
||||
|
||||
# { estimates: { total:, count: }, invoices: { total:, count:, balance: }, payments: { total:, count: } }
|
||||
# Where each money figure's rows are and how much each row counts: estimates, invoices and invoices paid in
|
||||
# full without their sales tax, payments as received
|
||||
MONEY_ROWS = {
|
||||
estimates: [:estimates, ->(r) { to_money(r[1]) - to_money(r[3]) }],
|
||||
invoices: [:invoices, ->(r) { to_money(r[1]) - to_money(r[4]) }],
|
||||
paid: [:paid, ->(r) { to_money(r[1]) - to_money(r[2]) }],
|
||||
payments: [:payments, ->(r) { to_money(r[1]) }]
|
||||
}.freeze
|
||||
|
||||
# Sales tax on invoices written (by their date) and on invoices paid in full (by that day)
|
||||
TAX_ROWS = {
|
||||
tax_invoiced: [:invoices, ->(r) { to_money(r[4]) }],
|
||||
tax_collected: [:paid, ->(r) { to_money(r[2]) }]
|
||||
}.freeze
|
||||
|
||||
def self.to_money(value)
|
||||
BigDecimal(value.to_s.presence || '0')
|
||||
rescue ArgumentError
|
||||
BigDecimal('0')
|
||||
end
|
||||
|
||||
# { estimates: { total:, count: }, invoices: { total:, count:, balance:, with_tax: }, paid: { total:, count: },
|
||||
# payments: { total:, count: } }. Invoices' balance (still owed) and with_tax are what the customers pay.
|
||||
def money
|
||||
@money ||= {
|
||||
estimates: { total: money_sum(data[:estimates], 1), count: data[:estimates].size },
|
||||
invoices: { total: money_sum(data[:invoices], 1), count: data[:invoices].size, balance: money_sum(data[:invoices], 3) },
|
||||
payments: { total: money_sum(data[:payments], 1), count: data[:payments].size }
|
||||
}
|
||||
@money ||= MONEY_ROWS.to_h do |key, (source, value)|
|
||||
rows = Array(data[source])
|
||||
[key, { total: rows.sum(BigDecimal('0')) { |r| value.call(r) }, count: rows.size }]
|
||||
end.tap do |figures|
|
||||
figures[:invoices][:balance] = money_sum(data[:invoices], 3)
|
||||
figures[:invoices][:with_tax] = money_sum(data[:invoices], 1)
|
||||
end
|
||||
end
|
||||
|
||||
# { tax_invoiced: { total:, count: }, tax_collected: { total:, count: } }: count is the invoices that had tax
|
||||
def taxes
|
||||
@taxes ||= TAX_ROWS.to_h do |key, (source, value)|
|
||||
amounts = Array(data[source]).map { |r| value.call(r) }
|
||||
[key, { total: amounts.sum(BigDecimal('0')), count: amounts.count(&:positive?) }]
|
||||
end
|
||||
end
|
||||
|
||||
# { estimate_hours:, issue_hours:, invoice_hours:, spent_hours: }
|
||||
@@ -103,7 +229,8 @@ module RedmineQboBilling
|
||||
def ratios
|
||||
{
|
||||
invoiced_of_estimated: percent(money[:invoices][:total], money[:estimates][:total]),
|
||||
collected_of_invoiced: percent(money[:payments][:total], money[:invoices][:total]),
|
||||
# Payments include sales tax, so they're compared with the invoices' totals with tax
|
||||
collected_of_invoiced: percent(money[:payments][:total], money[:invoices][:with_tax]),
|
||||
invoiced_of_spent: percent(hours[:invoice_hours], hours[:spent_hours]),
|
||||
spent_of_estimated: percent(hours[:spent_hours], hours[:issue_hours])
|
||||
}
|
||||
@@ -118,7 +245,7 @@ module RedmineQboBilling
|
||||
last = [to, @today].min
|
||||
last = from if last < from
|
||||
while month <= last
|
||||
rows << { month: month }.merge((MONEY + HOURS).index_with { |_| 0 })
|
||||
rows << { month: month }.merge((MONEY + HOURS + TAXES).index_with { |_| 0 })
|
||||
month = month.next_month
|
||||
end
|
||||
index = rows.index_by { |r| [r[:month].year, r[:month].month] }
|
||||
@@ -128,9 +255,12 @@ module RedmineQboBilling
|
||||
r[key] += kind == :money ? to_d(row[col]) : row[col].to_f
|
||||
end
|
||||
end
|
||||
add.call(data[:estimates], :estimates, 1, :money)
|
||||
add.call(data[:invoices], :invoices, 1, :money)
|
||||
add.call(data[:payments], :payments, 1, :money)
|
||||
MONEY_ROWS.merge(TAX_ROWS).each do |key, (source, value)|
|
||||
Array(data[source]).each do |row|
|
||||
r = index[[row[0].year, row[0].month]] or next
|
||||
r[key] += value.call(row)
|
||||
end
|
||||
end
|
||||
add.call(data[:estimates], :estimate_hours, 2, :hours)
|
||||
add.call(data[:issues], :issue_hours, 1, :hours)
|
||||
add.call(data[:invoices], :invoice_hours, 2, :hours)
|
||||
@@ -139,24 +269,55 @@ module RedmineQboBilling
|
||||
end
|
||||
end
|
||||
|
||||
# Estimates and invoices in the range that synced before totals and hours were cached (a full sync fills them)
|
||||
# Estimates and invoices in the range that synced before totals, hours and sales tax were cached (a full sync
|
||||
# fills them)
|
||||
def unsynced_count
|
||||
data[:estimates].count { |r| r[1].nil? || r[2].nil? } + data[:invoices].count { |r| r[1].nil? || r[2].nil? }
|
||||
data[:estimates].count { |r| r[1].nil? || r[2].nil? || (r.size > 3 && r[3].nil?) } +
|
||||
data[:invoices].count { |r| r[1].nil? || r[2].nil? || (r.size > 4 && r[4].nil?) }
|
||||
end
|
||||
|
||||
private
|
||||
|
||||
def load_data
|
||||
# { money key or hours key => [sum per bucket] } for the data, in buckets ([first day, last day] pairs)
|
||||
def sums_by_bucket(rows, bucket_list)
|
||||
sums = (MONEY + HOURS + TAXES).index_with { |_| Array.new(bucket_list.size, 0.0) }
|
||||
find = lambda do |date|
|
||||
bucket_list.index { |a, b| date >= a && date <= b }
|
||||
end
|
||||
MONEY_ROWS.merge(TAX_ROWS).each do |key, (source, value)|
|
||||
Array(rows[source]).each do |row|
|
||||
i = find.call(row[0]) or next
|
||||
sums[key][i] += value.call(row).to_f
|
||||
end
|
||||
end
|
||||
columns = { estimate_hours: [:estimates, 2], issue_hours: [:issues, 1], invoice_hours: [:invoices, 2],
|
||||
spent_hours: [:time_entries, 1] }
|
||||
columns.each do |key, (source, col)|
|
||||
Array(rows[source]).each do |row|
|
||||
i = find.call(row[0]) or next
|
||||
sums[key][i] += row[col].to_f
|
||||
end
|
||||
end
|
||||
sums.transform_values { |values| values.map { |v| v.round(2) } }
|
||||
end
|
||||
|
||||
def load_data(from = self.from, to = self.to)
|
||||
dates = from..to
|
||||
times = from.in_time_zone.beginning_of_day..to.in_time_zone.end_of_day
|
||||
leaf = "#{Issue.table_name}.rgt IS NULL OR #{Issue.table_name}.rgt - #{Issue.table_name}.lft = 1"
|
||||
issues = Issue.where(created_on: times).where(leaf).where.not(estimated_hours: nil)
|
||||
time_entries = TimeEntry.where(spent_on: dates)
|
||||
if projects_filtered?
|
||||
issues = issues.where(project_id: project_ids)
|
||||
time_entries = time_entries.where(project_id: project_ids)
|
||||
end
|
||||
{
|
||||
estimates: Estimate.where(txn_date: dates).pluck(:txn_date, :total_amount, :hours),
|
||||
invoices: Invoice.where(txn_date: dates).pluck(:txn_date, :total_amount, :hours, :balance),
|
||||
estimates: Estimate.where(txn_date: dates).pluck(:txn_date, :total_amount, :hours, :tax_amount),
|
||||
invoices: Invoice.where(txn_date: dates).pluck(:txn_date, :total_amount, :hours, :balance, :tax_amount),
|
||||
paid: Invoice.where(paid_on: dates).where('total_amount > 0').pluck(:paid_on, :total_amount, :tax_amount),
|
||||
payments: Payment.where(txn_date: dates).pluck(:txn_date, :total_amount),
|
||||
issues: Issue.where(created_on: times).where(leaf).where.not(estimated_hours: nil)
|
||||
.pluck(:created_on, :estimated_hours).map { |t, h| [t.in_time_zone.to_date, h] },
|
||||
time_entries: TimeEntry.where(spent_on: dates).pluck(:spent_on, :hours)
|
||||
issues: issues.pluck(:created_on, :estimated_hours).map { |t, h| [t.in_time_zone.to_date, h] },
|
||||
time_entries: time_entries.pluck(:spent_on, :hours)
|
||||
}
|
||||
end
|
||||
|
||||
|
||||
@@ -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 }
|
||||
@@ -58,6 +75,11 @@ module RedmineQboBilling
|
||||
settings[:custom_txn_numbers] == true
|
||||
end
|
||||
|
||||
# Whether QuickBooks has discounts turned on for sales forms (true when its settings couldn't be read)
|
||||
def discounts_allowed?
|
||||
settings[:allow_discount] != false
|
||||
end
|
||||
|
||||
# The "default message shown on estimates" from QuickBooks' sales settings
|
||||
def estimate_message
|
||||
settings[:estimate_message].to_s
|
||||
@@ -96,6 +118,7 @@ module RedmineQboBilling
|
||||
{
|
||||
custom_fields: merge_fields(parse_custom_fields(forms&.custom_fields), custom_fields_from_estimates),
|
||||
custom_txn_numbers: forms&.custom_txn_numbers? == 'true' || forms&.custom_txn_numbers? == true,
|
||||
allow_discount: forms.nil? || forms.allow_discount?.nil? ? nil : forms.allow_discount?.to_s == 'true',
|
||||
estimate_message: forms&.estimate_message.to_s,
|
||||
invoice_message: forms&.default_customer_message.to_s
|
||||
}
|
||||
@@ -105,9 +128,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
|
||||
|
||||
@@ -92,8 +92,12 @@ module RedmineQboBilling
|
||||
end
|
||||
end
|
||||
|
||||
# due_date is an invoice's; expiration_date an estimate's
|
||||
HEADER_ATTRIBUTES = %i[customer_id customer_name email txn_date expiration_date due_date doc_number customer_memo private_note].freeze
|
||||
# due_date is an invoice's; expiration_date an estimate's. The discount is a percent of the subtotal
|
||||
# (discount_type "percent") or a dollar amount ("amount"), saved as QuickBooks' discount line.
|
||||
HEADER_ATTRIBUTES = %i[customer_id customer_name email txn_date expiration_date due_date doc_number customer_memo private_note
|
||||
discount_type discount_value].freeze
|
||||
|
||||
DISCOUNT_TYPES = %w[percent amount].freeze
|
||||
|
||||
# "estimate" or "invoice"
|
||||
attr_writer :document
|
||||
@@ -105,8 +109,11 @@ module RedmineQboBilling
|
||||
# Invoices: estimates whose lines are on this invoice (they're linked and closed when saved)
|
||||
:linked_estimate_ids,
|
||||
# Read-only details shown on the editor
|
||||
# (discount: the discount amount QuickBooks worked out when it was last saved)
|
||||
:billing_address, :total, :total_tax, :discount, :email_status, :txn_status, :duplicated_from,
|
||||
:balance, :converted_from,
|
||||
# Invoices: a paid invoice opened for editing anyway (Unlock), and the amount paid on it
|
||||
:unlocked, :amount_paid,
|
||||
# Estimates: the invoices it's billed on ([[id, number], ...])
|
||||
:invoiced_on,
|
||||
# nil, :bundles (has bundle lines), :linked (an issue is linked to the estimate) or
|
||||
@@ -117,6 +124,7 @@ module RedmineQboBilling
|
||||
validate :validate_lines
|
||||
validate :validate_dates
|
||||
validate :validate_email
|
||||
validate :validate_discount
|
||||
# Plugins can block a save (e.g. redmine_qbo_vehicles: one vehicle per invoice); see IssueValues
|
||||
validate :validate_with_plugins
|
||||
|
||||
@@ -193,6 +201,35 @@ module RedmineQboBilling
|
||||
filled_lines.sum(BigDecimal('0'), &:amount)
|
||||
end
|
||||
|
||||
def discount_type
|
||||
DISCOUNT_TYPES.include?(@discount_type.to_s) ? @discount_type.to_s : 'percent'
|
||||
end
|
||||
|
||||
def percent_discount?
|
||||
discount_type == 'percent'
|
||||
end
|
||||
|
||||
# "10%" reads as 10
|
||||
def discount_value_number
|
||||
self.class.decimal(discount_value.to_s.delete('%'))
|
||||
end
|
||||
|
||||
# A discount is given when a value above zero is entered
|
||||
def discount?
|
||||
(discount_value_number || 0).positive?
|
||||
end
|
||||
|
||||
# The discount in dollars, as QuickBooks works it out: a percent of the subtotal, rounded to the cent
|
||||
def discount_amount
|
||||
return BigDecimal('0') unless discount?
|
||||
percent_discount? ? (subtotal * discount_value_number / 100).round(2) : discount_value_number.round(2)
|
||||
end
|
||||
|
||||
# Invoices: nothing left owing (a payment covers it all)
|
||||
def fully_paid?
|
||||
balance.present? && self.class.decimal(balance).to_d <= 0
|
||||
end
|
||||
|
||||
def sent?
|
||||
email_status.to_s == 'EmailSent'
|
||||
end
|
||||
@@ -240,6 +277,17 @@ module RedmineQboBilling
|
||||
invalid(:label_due_date) if due_date.present? && due_date_value.nil?
|
||||
end
|
||||
|
||||
def validate_discount
|
||||
return if discount_value.blank?
|
||||
|
||||
value = discount_value_number
|
||||
if value.nil? || value.negative? || (percent_discount? && value > 100)
|
||||
invalid(:label_discount_from_quickbooks)
|
||||
elsif discount_amount > subtotal
|
||||
errors.add(:base, I18n.t(:error_discount_too_large))
|
||||
end
|
||||
end
|
||||
|
||||
def validate_with_plugins
|
||||
IssueValues.plugin_errors(self).each { |message| errors.add(:base, message) }
|
||||
end
|
||||
|
||||
@@ -17,6 +17,9 @@ module RedmineQboBilling
|
||||
# - Lines already turned into issues are shown but can't be created again
|
||||
# - Creation is all-or-nothing: if any issue fails validation, none are saved
|
||||
# - All issues created from the same estimate are related to each other, across batches
|
||||
# - With a parent issue, the issues are created as its subtasks and take its customer, plus its vehicle and
|
||||
# custom field values where the page left them empty (the same rules as the subtask_field_copier plugin,
|
||||
# which is used when installed)
|
||||
#
|
||||
# Other plugins fill in more through hooks:
|
||||
# :qbo_billing_issue_defaults, { estimate:, params: } => a hash of start_date, due_date, assignee,
|
||||
@@ -91,13 +94,15 @@ module RedmineQboBilling
|
||||
end
|
||||
end
|
||||
|
||||
attr_reader :estimate, :defaults, :errors
|
||||
attr_reader :estimate, :defaults, :parent, :errors
|
||||
|
||||
# estimate: redmine_qbo's local Estimate (its QuickBooks details give the lines)
|
||||
# defaults: start_date, due_date, assignee, description and plugins' own values (from :qbo_billing_issue_defaults)
|
||||
def initialize(estimate, defaults: {})
|
||||
# parent: an issue to create the issues under as subtasks (optional; the caller checks the user may see it)
|
||||
def initialize(estimate, defaults: {}, parent: nil)
|
||||
@estimate = estimate
|
||||
@defaults = (defaults || {}).to_h.symbolize_keys
|
||||
@parent = parent
|
||||
@errors = []
|
||||
end
|
||||
|
||||
@@ -190,10 +195,12 @@ module RedmineQboBilling
|
||||
key.to_s
|
||||
end
|
||||
|
||||
# Relates the new issues to each other and to every issue created earlier from the same estimate.
|
||||
# Relates the new issues to each other and to every issue created earlier from the same estimate,
|
||||
# except their parent and its ancestors (Redmine doesn't allow relating a subtask to its parent)
|
||||
def relate_issues(new_issues)
|
||||
skip_ids = parent ? parent.self_and_ancestors.pluck(:id) : []
|
||||
earlier = QboEstimateLineIssue.where(estimate_id: estimate.id)
|
||||
.where.not(issue_id: new_issues.map(&:id))
|
||||
.where.not(issue_id: new_issues.map(&:id) + skip_ids)
|
||||
.includes(:issue)
|
||||
.filter_map(&:issue)
|
||||
self.class.relate_all(earlier + new_issues)
|
||||
@@ -223,15 +230,45 @@ module RedmineQboBilling
|
||||
assignee = defaults[:assignee]
|
||||
issue.assigned_to = assignee if assignee && issue.assignable_users.include?(assignee)
|
||||
|
||||
issue.customer_id = estimate.customer_id if issue.respond_to?(:customer_id=)
|
||||
# A subtask belongs to its parent's customer; otherwise the estimate's
|
||||
if issue.respond_to?(:customer_id=)
|
||||
issue.customer_id = parent&.customer_id.presence || estimate.customer_id
|
||||
end
|
||||
issue.estimate_id = estimate.id if issue.respond_to?(:estimate_id=)
|
||||
|
||||
# Plugins set their own fields (e.g. redmine_qbo_vehicles: the vehicle)
|
||||
Redmine::Hook.call_hook(:qbo_billing_build_issue, { issue: issue, estimate: estimate, defaults: defaults })
|
||||
|
||||
if parent
|
||||
issue.parent_issue_id = parent.id
|
||||
copy_from_parent(issue, author)
|
||||
end
|
||||
|
||||
issue
|
||||
end
|
||||
|
||||
# Fills the subtask's empty fields from the parent: custom fields (those the author can see on the parent
|
||||
# and edit on the subtask) and plugins' registered fields (customer, vehicle). Values entered on the page win.
|
||||
def copy_from_parent(issue, author)
|
||||
if defined?(::SubtaskFieldCopier)
|
||||
::SubtaskFieldCopier.copy_from_parent(issue, parent, author, {})
|
||||
return
|
||||
end
|
||||
|
||||
parent_values = parent.visible_custom_field_values(author).index_by(&:custom_field_id)
|
||||
copied = issue.editable_custom_field_values(author).each_with_object({}) do |custom_value, values|
|
||||
value = parent_values[custom_value.custom_field_id]&.value
|
||||
next if Array(value).all?(&:blank?) || Array(custom_value.value).any?(&:present?)
|
||||
|
||||
values[custom_value.custom_field_id.to_s] = value
|
||||
end
|
||||
issue.custom_field_values = copied if copied.any?
|
||||
|
||||
if issue.respond_to?(:vehicle_id=) && issue.vehicle_id.blank? && parent.respond_to?(:vehicle_id)
|
||||
issue.vehicle_id = parent.vehicle_id
|
||||
end
|
||||
end
|
||||
|
||||
def default_description
|
||||
defaults[:description].presence ||
|
||||
"The purpose of this work is to bill the time spent on this issue for Estimate ##{estimate.doc_number}"
|
||||
|
||||
@@ -13,8 +13,9 @@ module RedmineQboBilling
|
||||
#
|
||||
# Subtotal rows are saved the way QuickBooks saves the subtotals added on its own estimate screen: a
|
||||
# description-only line reading "Subtotal: $342.60", which prints where it was placed. The subtotal
|
||||
# QuickBooks always adds after the last line isn't shown (QuickBooks adds it back). Discount lines are kept
|
||||
# as they are, and estimates with bundle (group) lines are read-only so a bundle can't be broken up.
|
||||
# QuickBooks always adds after the last line isn't shown (QuickBooks adds it back). The discount (a percent
|
||||
# or an amount) is QuickBooks' discount line after the lines, and estimates with bundle (group) lines are
|
||||
# read-only so a bundle can't be broken up.
|
||||
#
|
||||
# Estimate numbers are never typed: QuickBooks numbers new estimates, or when its custom transaction
|
||||
# numbers are on, the next number is filled in when the estimate is created.
|
||||
@@ -72,8 +73,8 @@ module RedmineQboBilling
|
||||
save(form, user: user)
|
||||
end
|
||||
|
||||
# A new estimate copied from an existing one: same customer, lines, custom fields and messages, dated today, with a
|
||||
# new number, the current user as sales person, and no discounts or bundles (those stay in QuickBooks)
|
||||
# A new estimate copied from an existing one: same customer, lines, discount, custom fields and messages, dated
|
||||
# today, with a new number and the current user as sales person (bundles aren't copied)
|
||||
def duplicate_form(id, user: User.current)
|
||||
source = load(id)
|
||||
today = user.today
|
||||
@@ -88,6 +89,8 @@ module RedmineQboBilling
|
||||
custom_fields: source.custom_fields.dup,
|
||||
customer_memo: source.customer_memo,
|
||||
private_note: source.private_note,
|
||||
discount_type: source.discount_type,
|
||||
discount_value: source.discount_value,
|
||||
lines: source.lines.map do |line|
|
||||
EstimateForm::Line.new(kind: line.kind, item_id: line.item_id, item_name: line.item_name,
|
||||
description: line.description, quantity: line.quantity, rate: line.rate,
|
||||
@@ -258,6 +261,7 @@ module RedmineQboBilling
|
||||
total: remote.total,
|
||||
total_tax: remote.txn_tax_detail&.total_tax,
|
||||
discount: discount_total(remote),
|
||||
**discount_fields(remote),
|
||||
email_status: remote.email_status.to_s,
|
||||
txn_status: remote.txn_status.to_s,
|
||||
invoiced_on: Array(remote.linked_transactions).select { |t| t.txn_type.to_s == 'Invoice' }.map { |t|
|
||||
@@ -291,11 +295,17 @@ module RedmineQboBilling
|
||||
# QuickBooks' own subtotal (always after the last line), discount and group lines aren't edited here
|
||||
end
|
||||
|
||||
# The custom field's value, found by the field QuickBooks' preferences name, or by name on the estimate
|
||||
# The custom field's value on a QuickBooks estimate or invoice ("" when it isn't there)
|
||||
def custom_value(remote, field, name_pattern = nil)
|
||||
fields = Array(remote.custom_fields)
|
||||
match = fields.detect { |f| field && f.id.to_i == field.id.to_i } ||
|
||||
(name_pattern && fields.detect { |f| f.name.to_s =~ name_pattern })
|
||||
# The company's field, by id. A document without it has no value: falling back to a similarly named
|
||||
# field picked up retired ones, e.g. a "Sales Rep old" dropdown, which QuickBooks returns as its option
|
||||
# number ("4"), and that number was copied onto invoices as the sales person.
|
||||
return fields.detect { |f| f.id.to_i == field.id.to_i }&.string_value.to_s if field
|
||||
|
||||
# The field isn't known (QuickBooks' settings couldn't be read): found by name, never a hidden one
|
||||
hidden = Company.hidden_field_ids
|
||||
match = name_pattern && fields.detect { |f| f.name.to_s =~ name_pattern && !hidden.include?(f.id.to_i) }
|
||||
match&.string_value.to_s
|
||||
end
|
||||
|
||||
@@ -319,9 +329,16 @@ module RedmineQboBilling
|
||||
estimate.private_note = form.private_note.to_s
|
||||
estimate.custom_fields = build_custom_fields(form, remote, user)
|
||||
estimate.line_items = build_lines(form, remote)
|
||||
discount_before_tax(estimate, form)
|
||||
estimate
|
||||
end
|
||||
|
||||
# A discount comes off before sales tax: QuickBooks takes the discount from the subtotal, then works out
|
||||
# the tax on what's left (otherwise it taxes the full amount and discounts after)
|
||||
def discount_before_tax(document, form)
|
||||
document.apply_tax_after_discount = true if form.discount?
|
||||
end
|
||||
|
||||
# Keeps every custom field already on the estimate, then sets the ones edited on the form, and the sales
|
||||
# person on create
|
||||
# (left empty for estimates made without a user, e.g. by a background job)
|
||||
@@ -365,14 +382,44 @@ module RedmineQboBilling
|
||||
built
|
||||
end
|
||||
|
||||
# Discounts keep their place after the lines
|
||||
Array(remote&.line_items).select(&:discount_item?).each do |discount|
|
||||
discount.line_num = lines.size + 1
|
||||
lines << discount
|
||||
end
|
||||
# The discount goes after the lines, as on QuickBooks' own screen
|
||||
discount = discount_line(form, remote, lines.size + 1)
|
||||
lines << discount if discount
|
||||
lines
|
||||
end
|
||||
|
||||
# QuickBooks' discount line for the form's discount, or nil (taken off before tax, see discount_before_tax). A percent discount is sent as a percent so
|
||||
# QuickBooks works it out from its own subtotal; the discount account already on the document is kept
|
||||
# (otherwise QuickBooks uses its default discount account).
|
||||
def discount_line(form, remote, number)
|
||||
return nil unless form.discount?
|
||||
|
||||
account = Array(remote&.line_items).detect(&:discount_item?)&.discount_line_detail&.discount_account_ref
|
||||
line = Quickbooks::Model::InvoiceLineItem.new
|
||||
line.line_num = number
|
||||
line.amount = form.discount_amount
|
||||
line.discount_item! do |detail|
|
||||
detail.percent_based = form.percent_discount?
|
||||
detail.discount_percent = form.discount_value_number if form.percent_discount?
|
||||
detail.discount_account_ref = account if account
|
||||
end
|
||||
line
|
||||
end
|
||||
|
||||
# The editor's discount fields from a document's discount lines: one percent line stays a percent;
|
||||
# an amount, or several discount lines, become their total in dollars
|
||||
def discount_fields(remote)
|
||||
discounts = Array(remote.line_items).select(&:discount_item?)
|
||||
return {} if discounts.empty?
|
||||
|
||||
detail = discounts.first.discount_line_detail
|
||||
if discounts.size == 1 && detail&.percent_based?.to_s == 'true' && detail.discount_percent
|
||||
{ discount_type: 'percent', discount_value: plain_number(detail.discount_percent) }
|
||||
else
|
||||
{ discount_type: 'amount', discount_value: plain_number(discount_total(remote)) }
|
||||
end
|
||||
end
|
||||
|
||||
def build_line(line, number, keep_id:, section_total: BigDecimal('0'))
|
||||
remote = Quickbooks::Model::InvoiceLineItem.new
|
||||
remote.id = line.id if keep_id
|
||||
@@ -443,7 +490,7 @@ module RedmineQboBilling
|
||||
"Subtotal: #{'-' if value.negative?}$#{whole.reverse.scan(/\d{1,3}/).join(',').reverse}.#{cents}"
|
||||
end
|
||||
|
||||
# Discount lines aren't edited here but count toward the total shown
|
||||
# What the document's discount lines take off, in dollars
|
||||
def discount_total(remote)
|
||||
discounts = Array(remote.line_items).select(&:discount_item?)
|
||||
discounts.empty? ? nil : discounts.sum(BigDecimal('0')) { |l| l.amount || BigDecimal('0') }
|
||||
|
||||
@@ -0,0 +1,65 @@
|
||||
#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
|
||||
# An invoice's sales tax and the day it was paid in full, worked out from the QuickBooks invoice when it's synced
|
||||
# (InvoiceSyncService).
|
||||
#
|
||||
# An invoice is paid in full on the later of its own date and the dates of the payments and credit memos applied
|
||||
# to it, so a deposit taken before the work counts on the day the job was invoiced. The payments' dates come from
|
||||
# the local payments (synced from QuickBooks); QuickBooks is only asked for the ones not synced yet and for credit
|
||||
# memos.
|
||||
module InvoicePaidOn
|
||||
APPLIED_TYPES = %w[Payment CreditMemo].freeze
|
||||
IDS_PER_QUERY = 100
|
||||
|
||||
module_function
|
||||
|
||||
def tax(remote)
|
||||
tax = remote.respond_to?(:txn_tax_detail) ? remote.txn_tax_detail&.total_tax : nil
|
||||
tax.nil? ? BigDecimal('0') : BigDecimal(tax.to_s)
|
||||
end
|
||||
|
||||
# The day the invoice was paid in full, or nil while it's open (or voided: a $0 total)
|
||||
def paid_on(remote, dates: nil)
|
||||
return nil unless remote.txn_date
|
||||
return nil unless BigDecimal(remote.balance.to_s.presence || '1').zero?
|
||||
return nil unless BigDecimal(remote.total.to_s.presence || '0').positive?
|
||||
|
||||
dates ||= applied_dates(applied(remote))
|
||||
[remote.txn_date, *applied(remote).map { |type, id| dates[[type, id]] }.compact].max
|
||||
end
|
||||
|
||||
# [["Payment", "123"], ...] applied to the invoice
|
||||
def applied(remote)
|
||||
Array(remote.linked_transactions).select { |link| APPLIED_TYPES.include?(link.txn_type.to_s) }
|
||||
.map { |link| [link.txn_type.to_s, link.txn_id.to_s] }
|
||||
end
|
||||
|
||||
# { ["Payment", "123"] => Date }: local payments first, the rest read from QuickBooks
|
||||
def applied_dates(links)
|
||||
dates = {}
|
||||
payment_ids = links.select { |type, _| type == 'Payment' }.map(&:last)
|
||||
Payment.where(id: payment_ids).pluck(:id, :txn_date).each { |id, date| dates[['Payment', id.to_s]] = date if date }
|
||||
missing = links.reject { |link| dates.key?(link) }
|
||||
missing.group_by(&:first).each do |type, list|
|
||||
list.map(&:last).uniq.each_slice(IDS_PER_QUERY) do |ids|
|
||||
query = "SELECT * FROM #{type} WHERE Id IN (#{ids.map { |id| "'#{id.gsub(/\D/, '')}'" }.join(',')})"
|
||||
records = QboConnectionService.with_qbo_service(entity: type) { |service| service.query(query).entries }
|
||||
Array(records).each { |record| dates[[type, record.id.to_s]] = record.txn_date }
|
||||
end
|
||||
end
|
||||
dates
|
||||
rescue StandardError => e
|
||||
Rails.logger.warn "[RedmineQboBilling] Could not read the dates of what was applied to an invoice: #{e.message}"
|
||||
dates
|
||||
end
|
||||
end
|
||||
end
|
||||
@@ -34,8 +34,12 @@ module RedmineQboBilling
|
||||
balance < total ? :partial : :open
|
||||
end
|
||||
|
||||
def label(status)
|
||||
status ? I18n.t("label_invoice_status_#{status}") : ''
|
||||
# "Paid", or with the day it was paid in full, "Paid 11/03/2026"
|
||||
def label(status, paid_on: nil)
|
||||
return '' unless status
|
||||
return I18n.t(:label_invoice_status_paid_on, date: I18n.l(paid_on)) if status == :paid && paid_on
|
||||
|
||||
I18n.t("label_invoice_status_#{status}")
|
||||
end
|
||||
|
||||
def to_d(value)
|
||||
|
||||
@@ -19,7 +19,9 @@ module RedmineQboBilling
|
||||
# * billable QuickBooks time activities (the ones redmine_qbo makes from an issue's time entries). Each
|
||||
# becomes a line linked to its time activity, so QuickBooks marks the time as billed.
|
||||
#
|
||||
# An invoice with a payment applied to it is read-only, so a paid invoice can't be changed under the payment.
|
||||
# An invoice with a payment applied to it is read-only, so a paid invoice isn't changed under the payment by
|
||||
# accident. It can be unlocked on purpose (e.g. to give a discount after a deposit); the payment stays
|
||||
# applied, and the total can't go below what's been paid.
|
||||
module InvoiceWriter
|
||||
Error = EstimateWriter::Error
|
||||
Conflict = EstimateWriter::Conflict
|
||||
@@ -77,6 +79,8 @@ module RedmineQboBilling
|
||||
# The estimate's writer sells the job; with no one on the estimate, whoever writes the invoice
|
||||
form.sales_person = source.sales_person.presence || user.name
|
||||
form.private_note = source.private_note
|
||||
form.discount_type = source.discount_type
|
||||
form.discount_value = source.discount_value
|
||||
form.lines = copy_lines(source.lines)
|
||||
form.linked_estimate_ids = [source.id.to_s]
|
||||
form.converted_from = source.doc_number
|
||||
@@ -92,7 +96,8 @@ module RedmineQboBilling
|
||||
# Creates or updates the invoice in QuickBooks, closes the estimates it was made from, and returns the
|
||||
# saved QuickBooks invoice. The sales person is the one on the estimate it was made from (the first linked
|
||||
# estimate that names one), or else the user who creates it; editing keeps the original one.
|
||||
def save(form, user: User.current)
|
||||
# unlock: a paid invoice may be changed (the user unlocked it), as long as it still covers the payments
|
||||
def save(form, user: User.current, unlock: false)
|
||||
customer = Customer.find_by(id: form.customer_id)
|
||||
raise Error, I18n.t(:error_estimate_needs_customer) unless customer
|
||||
|
||||
@@ -102,7 +107,7 @@ module RedmineQboBilling
|
||||
raise Error, I18n.t(:notice_invoice_not_found) unless remote
|
||||
raise Conflict, I18n.t(:error_invoice_changed_in_quickbooks) if remote.sync_token.to_s != form.sync_token.to_s
|
||||
raise Error, I18n.t(:error_invoice_has_bundles) if writer.group_lines?(remote)
|
||||
raise Error, I18n.t(:error_invoice_paid) if paid?(remote)
|
||||
check_paid(form, remote, unlock, user)
|
||||
check_not_billed(form.linked_estimate_ids - linked_ids(remote, ESTIMATE))
|
||||
|
||||
invoice = Quickbooks::Model::Invoice.new
|
||||
@@ -154,7 +159,9 @@ module RedmineQboBilling
|
||||
total: remote.total,
|
||||
total_tax: remote.txn_tax_detail&.total_tax,
|
||||
discount: writer.discount_total(remote),
|
||||
**writer.discount_fields(remote),
|
||||
balance: remote.balance,
|
||||
amount_paid: amount_paid(remote),
|
||||
email_status: remote.email_status.to_s,
|
||||
locked: (:bundles if writer.group_lines?(remote)) || (:paid if paid?(remote))
|
||||
)
|
||||
@@ -166,6 +173,46 @@ module RedmineQboBilling
|
||||
BigDecimal(remote.balance.to_s) < BigDecimal(remote.total.to_s)
|
||||
end
|
||||
|
||||
# What's been paid on the invoice: its total less its balance
|
||||
def amount_paid(remote)
|
||||
return BigDecimal('0') unless paid?(remote)
|
||||
BigDecimal(remote.total.to_s) - BigDecimal(remote.balance.to_s)
|
||||
end
|
||||
|
||||
# Nothing left owing on it
|
||||
def fully_paid?(remote)
|
||||
paid?(remote) && BigDecimal(remote.balance.to_s) <= 0
|
||||
end
|
||||
|
||||
# A paid invoice is only changed when unlocked by a user allowed to (see
|
||||
# RedmineQboBilling.paid_invoice_editor?), and never to less than what's been paid on it
|
||||
def check_paid(form, remote, unlock, user)
|
||||
return unless paid?(remote)
|
||||
raise Error, I18n.t(:error_invoice_paid) unless unlock
|
||||
raise Error, I18n.t(:error_invoice_paid_not_allowed) unless RedmineQboBilling.paid_invoice_editor?(fully_paid?(remote), user)
|
||||
|
||||
paid = amount_paid(remote)
|
||||
total = estimated_total(form, remote)
|
||||
return if total >= paid - BigDecimal('0.005')
|
||||
|
||||
raise Error, I18n.t(:error_invoice_below_paid, total: money(total), paid: money(paid))
|
||||
end
|
||||
|
||||
# The invoice's new total, before QuickBooks works out the tax: the lines less the discount, plus the tax
|
||||
# it had, scaled to the new amount (the same lines give exactly the old total)
|
||||
def estimated_total(form, remote)
|
||||
before_tax = form.subtotal - form.discount_amount
|
||||
old_tax = BigDecimal(remote.txn_tax_detail&.total_tax.to_s.presence || '0')
|
||||
old_before_tax = BigDecimal(remote.total.to_s) - old_tax
|
||||
return before_tax if old_tax.zero? || old_before_tax <= 0
|
||||
|
||||
(before_tax + old_tax * before_tax / old_before_tax).round(2)
|
||||
end
|
||||
|
||||
def money(amount)
|
||||
ActiveSupport::NumberHelper.number_to_currency(amount)
|
||||
end
|
||||
|
||||
def linked_ids(remote, type)
|
||||
Array(remote&.linked_transactions).select { |t| t.txn_type.to_s == type }.map { |t| t.txn_id.to_s }.uniq
|
||||
end
|
||||
@@ -188,16 +235,19 @@ module RedmineQboBilling
|
||||
invoice.private_note = form.private_note.to_s
|
||||
invoice.custom_fields = writer.build_custom_fields(form, remote, user, sales_person: sales_person)
|
||||
invoice.line_items = writer.build_lines(form, remote)
|
||||
writer.discount_before_tax(invoice, form)
|
||||
invoice.linked_transactions = header_links(form, remote)
|
||||
invoice
|
||||
end
|
||||
|
||||
# The invoice-level links: the estimates it was made from, and every time activity a line bills
|
||||
# (QuickBooks wants time linked both on the line and on the invoice)
|
||||
# The invoice-level links: the estimates it was made from, every time activity a line bills (QuickBooks
|
||||
# wants time linked both on the line and on the invoice), and whatever else QuickBooks linked to it, e.g.
|
||||
# the payments applied to it (left out, QuickBooks would unlink them)
|
||||
def header_links(form, remote)
|
||||
estimates = (linked_ids(remote, ESTIMATE) + form.linked_estimate_ids).uniq
|
||||
times = form.filled_lines.filter_map(&:time_activity_id).map(&:to_s).uniq
|
||||
estimates.map { |id| link(id, ESTIMATE) } + times.map { |id| link(id, TIME_ACTIVITY) }
|
||||
others = Array(remote&.linked_transactions).reject { |t| [ESTIMATE, TIME_ACTIVITY].include?(t.txn_type.to_s) }
|
||||
estimates.map { |id| link(id, ESTIMATE) } + times.map { |id| link(id, TIME_ACTIVITY) } + others
|
||||
end
|
||||
|
||||
def link(id, type)
|
||||
|
||||
@@ -9,8 +9,8 @@
|
||||
#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 Receive payment page posts: who paid, how, and how much. PaymentWriter turns it into a
|
||||
# QuickBooks payment, applied to the customer's oldest open invoices first, or kept as a deposit.
|
||||
# What the Receive payment and Edit payment pages post: who paid, how, and how much. PaymentWriter turns it
|
||||
# into a QuickBooks payment, applied to the customer's oldest open invoices first, or kept as a deposit.
|
||||
class PaymentForm
|
||||
include ActiveModel::Model
|
||||
include ActiveModel::Validations
|
||||
@@ -20,16 +20,24 @@ module RedmineQboBilling
|
||||
attr_accessor(*ATTRIBUTES)
|
||||
# Invoices ticked on the page: the payment goes on these (oldest first). None ticked: all open invoices.
|
||||
attr_accessor :invoice_ids
|
||||
# A saved payment being edited: its QuickBooks id and sync token, and why it can't be edited here (or nil)
|
||||
attr_accessor :id, :sync_token, :locked
|
||||
|
||||
validate :validate_payment
|
||||
|
||||
def self.from_params(params)
|
||||
def self.from_params(params, id: nil)
|
||||
params = params.to_h.stringify_keys
|
||||
new(ATTRIBUTES.to_h { |attr| [attr, params[attr.to_s].to_s.strip] }).tap do |form|
|
||||
form.invoice_ids = Array(params['invoice_ids']).map(&:to_s).reject(&:blank?).uniq
|
||||
form.id = id.presence
|
||||
form.sync_token = params['sync_token'].presence
|
||||
end
|
||||
end
|
||||
|
||||
def persisted?
|
||||
id.present?
|
||||
end
|
||||
|
||||
def initialize(attributes = {})
|
||||
super
|
||||
self.invoice_ids ||= []
|
||||
|
||||
@@ -12,8 +12,13 @@ module RedmineQboBilling
|
||||
# Receives customer payments in QuickBooks: payment type and amount, applied to the customer's open
|
||||
# invoices oldest first (the way QuickBooks applies them on its own screen), or only to the invoices ticked
|
||||
# on the page, or saved unapplied as a deposit. Whatever doesn't fit stays unapplied as a credit.
|
||||
#
|
||||
# A saved payment can be edited the same way (date, method, reference, memo, amount and the invoices it
|
||||
# pays); its customer stays. Left as it was, it keeps the amounts it already applied to each invoice.
|
||||
module PaymentWriter
|
||||
Error = EstimateWriter::Error
|
||||
Conflict = EstimateWriter::Conflict
|
||||
INVOICE = 'Invoice'.freeze
|
||||
|
||||
METHODS_CACHE_KEY = 'redmine_qbo_billing:payment_methods'
|
||||
|
||||
@@ -39,17 +44,21 @@ module RedmineQboBilling
|
||||
[]
|
||||
end
|
||||
|
||||
# The customer's invoices with a balance, oldest first (by date, then number)
|
||||
def open_invoices(customer)
|
||||
# The customer's invoices with a balance, oldest first (by date, then number). For a payment being edited
|
||||
# (payment:, the QuickBooks payment), what it paid on each invoice counts as still open, so the invoices it
|
||||
# pays are listed even when it paid them off.
|
||||
def open_invoices(customer, payment: nil)
|
||||
invoices = with_service('Invoice') do |service|
|
||||
service.query("SELECT * FROM Invoice WHERE CustomerRef = '#{customer.id.to_i}' ORDERBY TxnDate", per_page: 1000).entries
|
||||
end
|
||||
paid_here = payment ? applied_amounts(payment) : {}
|
||||
|
||||
Array(invoices).select { |i| BigDecimal(i.balance.to_s.presence || '0') > 0 }
|
||||
.sort_by { |i| [i.txn_date || Date.new(1900), i.doc_number.to_s.rjust(12, '0')] }
|
||||
.map do |i|
|
||||
Array(invoices).map { |i| [i, BigDecimal(i.balance.to_s.presence || '0') + paid_here.fetch(i.id.to_s, 0)] }
|
||||
.select { |_, balance| balance > 0 }
|
||||
.sort_by { |i, _| [i.txn_date || Date.new(1900), i.doc_number.to_s.rjust(12, '0')] }
|
||||
.map do |i, balance|
|
||||
{ id: i.id.to_s, doc_number: i.doc_number.to_s, date: i.txn_date.to_s, due_date: i.due_date.to_s,
|
||||
total: i.total.to_s, balance: BigDecimal(i.balance.to_s).to_s('F') }
|
||||
total: i.total.to_s, balance: balance.to_s('F') }
|
||||
end
|
||||
end
|
||||
|
||||
@@ -67,45 +76,132 @@ module RedmineQboBilling
|
||||
[applied, left]
|
||||
end
|
||||
|
||||
# Creates the payment in QuickBooks and returns it. Open invoices are read again here, so the payment
|
||||
# goes on what's open right now.
|
||||
# Creates the payment in QuickBooks (or updates the one being edited) and returns it. Open invoices are
|
||||
# read again here, so the payment goes on what's open right now.
|
||||
def save(form)
|
||||
return update(form) if form.persisted?
|
||||
|
||||
customer = Customer.find_by(id: form.customer_id)
|
||||
raise Error, I18n.t(:error_estimate_needs_customer) unless customer
|
||||
|
||||
amount = form.amount_value.round(2)
|
||||
applied =
|
||||
if form.deposit?
|
||||
[]
|
||||
else
|
||||
invoices = open_invoices(customer)
|
||||
invoices = invoices.select { |i| form.invoice_ids.include?(i[:id]) } if form.invoice_ids.any?
|
||||
allocate(amount, invoices).first
|
||||
end
|
||||
applied = allocation(form, customer, amount)
|
||||
|
||||
payment = Quickbooks::Model::Payment.new
|
||||
payment.customer_id = customer.id
|
||||
payment.txn_date = form.txn_date_value
|
||||
payment.payment_method_ref = Quickbooks::Model::BaseReference.new(form.payment_method_id)
|
||||
payment.payment_ref_number = form.reference if form.reference.present?
|
||||
payment.private_note = form.memo if form.memo.present?
|
||||
payment.total = amount
|
||||
payment.line_items = applied.map do |invoice, take|
|
||||
line = Quickbooks::Model::Line.new
|
||||
line.amount = take
|
||||
line.invoice_id = invoice[:id]
|
||||
line
|
||||
end
|
||||
fill(payment, form, amount, applied)
|
||||
payment.payment_ref_number = nil if form.reference.blank?
|
||||
payment.private_note = nil if form.memo.blank?
|
||||
|
||||
saved = with_service('Payment') { |service| service.create(payment) }
|
||||
raise Error, I18n.t(:error_payment_not_saved) unless saved
|
||||
|
||||
# Invoice balances changed: update the local invoices, and cache the payment for reports
|
||||
applied.each { |invoice, _| sync_invoice(invoice[:id]) }
|
||||
applied.each { |invoice_id, _| sync_invoice(invoice_id) }
|
||||
sync_payment(saved.id)
|
||||
saved
|
||||
end
|
||||
|
||||
# A saved payment on the Edit payment page
|
||||
def load_form(id)
|
||||
payment = load(id)
|
||||
applied = applied_amounts(payment)
|
||||
PaymentForm.new(
|
||||
id: payment.id.to_s,
|
||||
sync_token: payment.sync_token.to_s,
|
||||
customer_id: payment.customer_ref&.value.to_s,
|
||||
customer_name: payment.customer_ref&.name.presence || Customer.find_by(id: payment.customer_ref&.value)&.name,
|
||||
txn_date: payment.txn_date&.iso8601,
|
||||
payment_method_id: payment.payment_method_ref&.value.to_s,
|
||||
reference: payment.payment_ref_number.to_s,
|
||||
amount: BigDecimal(payment.total.to_s).round(2).to_s('F'),
|
||||
deposit: applied.empty? ? '1' : '0',
|
||||
memo: payment.private_note.to_s,
|
||||
invoice_ids: applied.keys,
|
||||
locked: edit_blocked(payment)
|
||||
)
|
||||
end
|
||||
|
||||
# Saves the changes to a payment. Its customer stays. If the amount and the ticked invoices are the
|
||||
# same as before, each invoice keeps the amount it had; otherwise the amount is spread again, oldest first.
|
||||
def update(form)
|
||||
applied = nil
|
||||
previously = []
|
||||
saved = with_service('Payment') do |service|
|
||||
remote = service.fetch_by_id(form.id)
|
||||
raise Error, I18n.t(:notice_payment_not_found) unless remote
|
||||
raise Conflict, I18n.t(:error_payment_changed_in_quickbooks) if remote.sync_token.to_s != form.sync_token.to_s
|
||||
blocked = edit_blocked(remote)
|
||||
raise Error, blocked if blocked
|
||||
|
||||
customer = Customer.find_by(id: remote.customer_ref&.value)
|
||||
raise Error, I18n.t(:error_estimate_needs_customer) unless customer
|
||||
|
||||
amount = form.amount_value.round(2)
|
||||
before = applied_amounts(remote)
|
||||
applied =
|
||||
if !form.deposit? && before.any? && amount == BigDecimal(remote.total.to_s) && form.invoice_ids.sort == before.keys.sort
|
||||
before.to_a
|
||||
else
|
||||
allocation(form, customer, amount, payment: remote)
|
||||
end
|
||||
previously = before.keys
|
||||
|
||||
payment = Quickbooks::Model::Payment.new
|
||||
payment.id = remote.id
|
||||
payment.sync_token = remote.sync_token
|
||||
payment.customer_ref = remote.customer_ref
|
||||
fill(payment, form, amount, applied)
|
||||
service.update(payment, sparse: true)
|
||||
end
|
||||
raise Error, I18n.t(:error_payment_not_saved) unless saved
|
||||
|
||||
# Balances changed on the invoices it paid before and the ones it pays now
|
||||
(previously + applied.map(&:first)).uniq.each { |invoice_id| sync_invoice(invoice_id) }
|
||||
sync_payment(saved.id)
|
||||
saved
|
||||
end
|
||||
|
||||
# Where the payment goes: [[invoice_id, amount], ...] (nothing for a deposit)
|
||||
def allocation(form, customer, amount, payment: nil)
|
||||
return [] if form.deposit?
|
||||
|
||||
invoices = open_invoices(customer, payment: payment)
|
||||
invoices = invoices.select { |i| form.invoice_ids.include?(i[:id]) } if form.invoice_ids.any?
|
||||
allocate(amount, invoices).first.map { |invoice, take| [invoice[:id], take] }
|
||||
end
|
||||
|
||||
# The form's details on a QuickBooks payment, applied as given ([[invoice_id, amount], ...])
|
||||
def fill(payment, form, amount, applied)
|
||||
payment.txn_date = form.txn_date_value
|
||||
payment.payment_method_ref = Quickbooks::Model::BaseReference.new(form.payment_method_id)
|
||||
payment.payment_ref_number = form.reference.to_s
|
||||
payment.private_note = form.memo.to_s
|
||||
payment.total = amount
|
||||
payment.line_items = applied.map do |invoice_id, take|
|
||||
line = Quickbooks::Model::Line.new
|
||||
line.amount = take
|
||||
line.invoice_id = invoice_id
|
||||
line
|
||||
end
|
||||
payment
|
||||
end
|
||||
|
||||
# Why a payment can't be edited here, or nil: it also applies credit memos or other transactions, which
|
||||
# this page doesn't show (saving would drop them)
|
||||
def edit_blocked(payment)
|
||||
others = Array(payment.line_items).flat_map { |line| Array(line.linked_transactions) }
|
||||
.reject { |t| t.txn_type.to_s == INVOICE }
|
||||
others.any? ? I18n.t(:error_payment_not_editable, types: others.map { |t| t.txn_type.to_s }.uniq.join(', ')) : nil
|
||||
end
|
||||
|
||||
# What the payment pays on each invoice: { invoice_id => amount }
|
||||
def applied_amounts(payment)
|
||||
applied_invoices(payment).each_with_object(Hash.new(BigDecimal('0'))) do |(invoice_id, _, amount), sums|
|
||||
sums[invoice_id] += BigDecimal(amount.to_s.presence || '0')
|
||||
end.to_h
|
||||
end
|
||||
|
||||
# Every payment the customer has made, newest first (by date, then QuickBooks id), read from QuickBooks
|
||||
def customer_payments(customer)
|
||||
payments = with_service('Payment') do |service|
|
||||
|
||||
@@ -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
|
||||
@@ -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
|
||||
@@ -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
|
||||
@@ -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
|
||||
@@ -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
|
||||
@@ -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
|
||||
@@ -0,0 +1,68 @@
|
||||
#The MIT License (MIT)
|
||||
#
|
||||
#Copyright (c) 2026 rick barrette
|
||||
#
|
||||
#Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
|
||||
#
|
||||
#The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
|
||||
#
|
||||
#THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
||||
|
||||
require File.expand_path('../test_helper', __dir__)
|
||||
|
||||
class BusinessReportTest < ActiveSupport::TestCase
|
||||
Report = RedmineQboBilling::BusinessReport
|
||||
NOV = Date.new(2026, 11, 1)
|
||||
|
||||
def report(data)
|
||||
full = { estimates: [], invoices: [], paid: [], payments: [], issues: [], time_entries: [] }.merge(data)
|
||||
Report.new(period: 'custom', from: NOV, to: NOV.end_of_month, today: Date.new(2026, 11, 20), data: full,
|
||||
previous_data: full.transform_values { [] })
|
||||
end
|
||||
|
||||
def test_estimates_and_invoices_without_tax
|
||||
r = report(estimates: [[NOV + 1, '1080', 10, '80'], [NOV + 2, '500', 2]],
|
||||
invoices: [[NOV + 3, '1070', 5, '0', '70'], [NOV + 4, '200', 1, '200', '0']],
|
||||
payments: [[NOV + 5, '1070']])
|
||||
assert_equal BigDecimal('1500'), r.money[:estimates][:total]
|
||||
assert_equal BigDecimal('1200'), r.money[:invoices][:total]
|
||||
assert_equal BigDecimal('1270'), r.money[:invoices][:with_tax]
|
||||
assert_equal BigDecimal('200'), r.money[:invoices][:balance]
|
||||
assert_equal BigDecimal('1070'), r.money[:payments][:total]
|
||||
# $1,070 collected of $1,270 invoiced with tax
|
||||
assert_equal 84, r.ratios[:collected_of_invoiced]
|
||||
assert_equal 80, r.ratios[:invoiced_of_estimated]
|
||||
end
|
||||
|
||||
def test_invoices_paid_in_full
|
||||
r = report(paid: [[NOV + 3, '1070', '70'], [NOV + 9, '500', nil]])
|
||||
assert_equal BigDecimal('1500'), r.money[:paid][:total]
|
||||
assert_equal 2, r.money[:paid][:count]
|
||||
november = r.months.find { |m| m[:month] == NOV }
|
||||
assert_equal BigDecimal('1500'), november[:paid]
|
||||
assert_equal 1500.0, r.chart[:current][:paid].compact.sum
|
||||
end
|
||||
|
||||
def test_rows_missing_tax_are_unsynced
|
||||
r = report(estimates: [[NOV + 1, '100', 1, nil]], invoices: [[NOV + 1, '100', 1, '0', '0']])
|
||||
assert_equal 1, r.unsynced_count
|
||||
end
|
||||
|
||||
def test_paid_badge_shows_the_day
|
||||
assert_equal 'Paid', RedmineQboBilling::InvoiceStatus.label(:paid)
|
||||
assert_match(/\APaid \S+/, RedmineQboBilling::InvoiceStatus.label(:paid, paid_on: Date.new(2026, 11, 3)))
|
||||
assert_equal 'Open', RedmineQboBilling::InvoiceStatus.label(:open, paid_on: Date.new(2026, 11, 3))
|
||||
end
|
||||
|
||||
def test_taxes
|
||||
r = report(invoices: [[NOV + 3, '1070', 5, '0', '70'], [NOV + 4, '200', 1, '200', '0'], [NOV + 6, '535', 2, '0', '35']],
|
||||
paid: [[NOV + 9, '1070', '70'], [Date.new(2026, 11, 10), '500', nil]])
|
||||
assert_equal({ total: BigDecimal('105'), count: 2 }, r.taxes[:tax_invoiced])
|
||||
assert_equal({ total: BigDecimal('70'), count: 1 }, r.taxes[:tax_collected])
|
||||
november = r.months.find { |m| m[:month] == NOV }
|
||||
assert_equal BigDecimal('105'), november[:tax_invoiced]
|
||||
assert_equal BigDecimal('70'), november[:tax_collected]
|
||||
assert_equal 105.0, r.chart[:current][:tax_invoiced].compact.sum
|
||||
assert_equal 70.0, r.chart[:current][:tax_collected].compact.sum
|
||||
end
|
||||
end
|
||||
@@ -0,0 +1,79 @@
|
||||
#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 InvoicePaidOnTest < ActiveSupport::TestCase
|
||||
PaidOn = RedmineQboBilling::InvoicePaidOn
|
||||
|
||||
def setup
|
||||
Payment.where(id: [9301, 9302]).delete_all
|
||||
end
|
||||
|
||||
def link(type, id)
|
||||
link = Quickbooks::Model::LinkedTransaction.new
|
||||
link.txn_type = type
|
||||
link.txn_id = id.to_s
|
||||
link
|
||||
end
|
||||
|
||||
def invoice(date: Date.new(2026, 10, 30), total: 2207.99, balance: 0, links: [], tax: nil)
|
||||
invoice = Quickbooks::Model::Invoice.new
|
||||
invoice.id = '601'
|
||||
invoice.txn_date = date
|
||||
invoice.total = BigDecimal(total.to_s)
|
||||
invoice.balance = BigDecimal(balance.to_s)
|
||||
invoice.linked_transactions = links
|
||||
if tax
|
||||
invoice.txn_tax_detail = Quickbooks::Model::TransactionTaxDetail.new
|
||||
invoice.txn_tax_detail.total_tax = BigDecimal(tax.to_s)
|
||||
end
|
||||
invoice
|
||||
end
|
||||
|
||||
def local_payment(id, date)
|
||||
payment = Payment.new(id: id, txn_date: date, total_amount: 100)
|
||||
payment.skip_qbo_push = true
|
||||
payment.save!(validate: false)
|
||||
end
|
||||
|
||||
def test_tax
|
||||
assert_equal BigDecimal('80.30'), PaidOn.tax(invoice(tax: '80.30'))
|
||||
assert_equal BigDecimal('0'), PaidOn.tax(invoice)
|
||||
end
|
||||
|
||||
def test_paid_in_full_on_the_last_payment
|
||||
local_payment(9301, Date.new(2026, 10, 8)) # deposit before the invoice
|
||||
local_payment(9302, Date.new(2026, 11, 3)) # final payment
|
||||
remote = invoice(links: [link('Payment', 9301), link('Payment', 9302), link('Estimate', 598)])
|
||||
QboConnectionService.expects(:with_qbo_service).never
|
||||
assert_equal Date.new(2026, 11, 3), PaidOn.paid_on(remote)
|
||||
end
|
||||
|
||||
def test_deposit_before_the_invoice_counts_on_the_invoice_date
|
||||
local_payment(9301, Date.new(2026, 10, 8))
|
||||
assert_equal Date.new(2026, 10, 30), PaidOn.paid_on(invoice(links: [link('Payment', 9301)]))
|
||||
end
|
||||
|
||||
def test_payments_not_synced_and_credit_memos_are_read_from_quickbooks
|
||||
memo = Quickbooks::Model::CreditMemo.new
|
||||
memo.id = '70'
|
||||
memo.txn_date = Date.new(2026, 11, 9)
|
||||
service = mock('service')
|
||||
service.stubs(:query).returns(stub(entries: [memo]))
|
||||
QboConnectionService.expects(:with_qbo_service).with(entity: 'CreditMemo').yields(service).returns([memo])
|
||||
assert_equal Date.new(2026, 11, 9), PaidOn.paid_on(invoice(links: [link('CreditMemo', 70)]))
|
||||
end
|
||||
|
||||
def test_open_and_voided_invoices_arent_paid
|
||||
assert_nil PaidOn.paid_on(invoice(balance: 10))
|
||||
assert_nil PaidOn.paid_on(invoice(total: 0))
|
||||
end
|
||||
end
|
||||
@@ -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
|
||||
Reference in new issue
Block a user