Compare commits

..
32 Commits
Author SHA1 Message Date
rickyandClaude Opus 5.5 cf5328cb21 2026.11.24
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-18 13:23:10 -05:00
rickyandClaude Opus 5.5 c851929e02 Refunds of paid invoices: refund receipt with optional restocking fee
Completed work that's billed and paid in full can be refunded from its
invoice (Refund on the invoice, or Paid invoice on the customer's Refund
page). It makes a QuickBooks Refund Receipt: the invoice lines refunded
(all or part, by quantity or amount) with their products/services and
tax codes, the invoice discount's share, and the restocking fee as a
negative line when it's ticked: the fee rate of the parts refunded, so
labor-only work has none. Paid out of the refund check or card account,
with the check number.

Each refund records the lines it refunded, so a line can't be refunded
for more than it was billed across refunds. Optionally notes the refund
on the invoice's work orders and emails the customer. The refund page,
PDF and email show the lines, tax and fee. Migration 056 adds the
columns to qbo_refunds.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-18 13:23:10 -05:00
rickyandClaude Opus 5.5 56859d1794 2026.11.23
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-17 20:25:23 -05:00
rickyandClaude Opus 5.5 671afa2436 README: sharing an issue with the customer; ticked estimates
Documents share links (what they show, a month's validity, the
purge_customer_tokens task), the Share issues with customers
permission, and ticked estimates filling in New issue and Add
appointment on the customer page.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-17 20:22:49 -05:00
rickyandClaude Opus 5.5 30c1f5181e Clear out expired customer share links
CustomerToken.purge_expired deletes share links that have expired or
whose issue was deleted. It runs whenever a new link is made, so they
don't pile up, and from rake redmine_qbo:purge_customer_tokens for a
manual or scheduled run. Expired links were only ignored before.

Also drops Issue's belongs_to :customer_token: issues have no such
column, so the association could only raise.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-17 19:51:25 -05:00
rickyandClaude Opus 5.5 0d143e6eb1 Remove orphaned code
* customers#filter_estimates_by_customer and #filter_invoices_by_customer,
  their routes, permission entries and template: they filled an estimate
  dropdown on the old issue form, which is gone.
* Routes with no action: accounts new/create/show/edit/update/destroy
  (only index, Set default and Sync exist) and customers#destroy.
* Unused methods: AuthHelper#require_user, #allowed_to?, #check_permission;
  CustomersController#address_to_s; CustomerToken#expired? and
  .remove_expired_tokens; QboBaseModel#skip_qbo_push?;
  QboDraft.writable_document?; SyncServiceBase#extract_value.
* CustomersController's before_action helpers are private.
* The unused .autocomplete-meta style and 28 unused translation keys.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-17 19:48:17 -05:00
rickyandClaude Opus 5.5 92f9eb1bc7 Customer page lists: short paid badge, aligned icons, appointment link
* The invoice list's paid badge is short so each invoice stays on one
  line: "Paid", or "Paid +3d" when it was paid in full 3 days after
  its date, with the day on hover. The invoice page keeps the date.
* The estimate and invoice lists are laid out in columns (checkbox,
  number, date, status, actions), so the edit/view icons line up.
* Ticked estimates (and redmine_qbo_vehicles' vehicles) fill in
  redmine_qbo_calendar's Add appointment link (estimate_id,
  vehicle_id) as well as New issue. Estimate checkboxes are only on
  the customer page, where they're used.
* application.js is gone: it only carried the old Google Calendar
  link code, which threw an error when a box was ticked on a vehicle
  page.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-17 19:39:08 -05:00
rickyandClaude Opus 5.5 40eb6205c4 2026.11.22
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-17 19:09:07 -05:00
rickyandClaude Opus 5.5 0c5bac855e Business report: Sales tax section at the bottom
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-17 19:09:07 -05:00
rickyandClaude Opus 5.5 663639b8fd 2026.11.21
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-17 18:45:29 -05:00
rickyandClaude Opus 5.5 ec4e5f681d Business report: sales tax invoiced and collected
A Sales tax section: tax invoiced (on invoices dated in the period,
accrual) and tax collected (on invoices paid in full in the period,
counted on the day each was paid in full, cash), with counts, a line
chart and a month-by-month table. Only invoices are counted; sales tax
is filed from QuickBooks' Sales Tax Liability report.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-17 18:45:29 -05:00
rickyandClaude Opus 5.5 a72b0fa73b Business report without sales tax; invoices paid in full; paid dates
Estimates and invoices written are reported without sales tax (new
estimates.tax_amount, filled in by the estimate sync), and a new
Invoices paid in full figure counts invoices on the day they were paid
in full. Payments stay as received, so collected vs. invoiced compares
them with the invoices' totals with tax.

Paid invoices show the day they were paid in full on the customer's
invoice list and the invoice page ("Paid 11/03/2026").

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-17 18:34:21 -05:00
rickyandClaude Opus 5.5 5b6c1ed2c2 Cache invoices' sales tax and the day they were paid in full
New invoices columns tax_amount and paid_on, filled in by the invoice
sync. An invoice is paid in full on the later of its date and the
dates of the payments and credit memos applied to it (local payments
first; QuickBooks only for ones not synced yet and credit memos), so
reports such as the monthly sales commission don't have to read
invoices from QuickBooks. A full sync fills them in for older
invoices; it now syncs payments before invoices.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-17 18:34:21 -05:00
rickyandClaude Opus 5.5 4f6f81c87a 2026.11.20
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-16 20:43:36 -05:00
rickyandClaude Opus 5.5 9fa199aa98 Refunds for canceled orders and returned parts (SOP-OPS-014)
A Refund page on the customer: the canceled order's estimate fills in
the parts the 30% restocking fee is worked out on. Refunding makes the
fee invoice, pays it from the customer's credit, records the rest as a
Check (company check) or Expense (card refund on the terminal) with the
category Accounts Receivable, applies the credit to it so the balance
comes back to $0.00, and optionally marks the estimate Rejected,
cancels its work orders with the reason as a note and emails the
customer. Each refund has a page with a PDF of it.

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

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-16 20:43:36 -05:00
rickyandClaude Opus 5.5 16f9441568 2026.11.19
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-16 08:42:08 -05:00
rickyandClaude Opus 5.5 5c48646041 Invoice page hook for plugin actions
:view_qbo_invoice_contextual, { invoice_id:, customer_id:, doc_number: }
in the invoice page's top-right actions, like the estimate page's hook
(used by redmine_qbo_labels' Print label).

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-16 08:42:08 -05:00
rickyandClaude Opus 5.5 90adb96d54 2026.11.18
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-09 20:17:38 -05:00
rickyandClaude Opus 5.5 8a947483db Estimate/invoice numbers on issue PDF; create estimate issues as subtasks
- Issue PDF: show the issue's estimate number and invoice number(s)
- Create issues from estimate: optional parent task. The issues are created as
  its subtasks, take its customer, and start from its project, vehicle and
  custom field values (subtask_field_copier's rules when installed)
- Issue page: shortcut to create the estimate's issues as subtasks of the issue
- Create issues page: editable start and due dates, pre-filled from the
  appointment or the parent task
- Always show plugins' fields (e.g. the vehicle) on the Create issues page

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-09 20:17:38 -05:00
rickyandClaude Opus 5.5 42461e7899 2026.11.17
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-06 10:44:25 -05:00
rickyandClaude Opus 5.5 461fa79bc5 Show a saving indicator on estimates and invoices
Clicking Save, Save and send or Save draft shows a spinner in the action bar and locks the buttons until the page reloads, so a second click can't save or send twice.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-06 10:44:25 -05:00
ricky 2fb21c34bb 2026.11.16 2026-11-04 15:04:19 -05:00
rickyandClaude Opus 5.5 1c71e3a4c9 Add discounts, unlocking paid invoices and editing payments
- Estimates and invoices take a discount, as a percent of the subtotal or an
  amount, saved as QuickBooks' discount line and taken off before sales tax.
  Duplicated estimates and invoices made from an estimate keep it. The box is
  hidden when discounts are off in QuickBooks.
- A paid invoice can be unlocked for editing after a confirmation. The
  payments stay linked, and the total can't go below what's been paid.
  Unlocking needs the new "Edit partially paid invoices" or "Edit paid
  invoices" permission, checked again when saving.
- Saved payments can be edited: date, method, reference, memo, amount and the
  invoices they pay. Each invoice keeps its amount unless the amount or the
  invoices change. Payments that also apply credit memos stay read-only.
- Locked estimates and invoices are readable again (disabled boxes had faint
  or invisible text, especially in Safari).

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-04 15:04:19 -05:00
ricky 89f4797bbe 2026.11.15 2026-11-04 12:41:32 -05:00
rickyandClaude Opus 5.5 3bbceacda4 Don't take the sales person from a retired custom field
When an estimate didn't have the company's sales person field, the plugin fell back to
any field named like "Sales Rep", e.g. a retired "Sales Rep old" dropdown, which
QuickBooks returns as its option number. Invoices made from those estimates got "4"
as their sales person. Only the company's field is read now; an estimate without it
has no sales person, so the invoice gets the user who creates it. Matching by name is
left for when QuickBooks' settings can't be read, and never picks a hidden field.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-04 12:41:32 -05:00
ricky d75dee2866 2026.11.14 2026-11-04 10:33:03 -05:00
rickyandClaude Opus 5.5 c8e2d2d92e Save new estimates and invoices as drafts
A draft is kept in Redmine only, however incomplete, so nothing is in QuickBooks
until it's saved from the editor. QuickBooks can't apply a deposit to an invoice
that's still being written, which made it read-only. Saving to QuickBooks deletes
the draft.

Drafts are listed on the customer's page, on a Drafts page linked from Customers,
and on a new invoice or estimate for a customer who already has one. Anyone with
Write invoices (or Write estimates) can continue or delete invoice (or estimate)
drafts. Adds the qbo_drafts table (migration 052).

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-04 10:33:03 -05:00
ricky a1fb88e77c 2026.11.13 2026-11-04 10:07:54 -05:00
rickyandClaude Opus 5.5 0a7b2e34b8 Fix the settings page before QuickBooks is connected
The token expiry came back as "never synced" text, which the page treated as a
time, so it failed. It's now empty, shown as N/A.

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

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

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-04 09:47:36 -05:00
86 changed files with 4901 additions and 379 deletions

No files matched your search

+47 -6
View File
@@ -75,10 +75,22 @@ The plugin provides basic Customer management:
* 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
* On the customer page, ticking an estimate (or a redmine_qbo_vehicles vehicle) adds it to the **New issue** link and to redmine_qbo_calendar's **Add appointment** link, one of each at a time
Customers are synchronized with QuickBooks.
### Sharing an issue with the customer
**Share** on an issue (permission **Share issues with customers**) opens a link the customer can open without logging in: the issue with its history, attachments, estimate and invoices. A link lasts a month; sharing the issue again while it's valid gives the same link.
Expired links, and links whose issue was deleted, are deleted whenever a new link is made. To delete them now (or on a schedule):
```
bundle exec rake redmine_qbo:purge_customer_tokens RAILS_ENV=production
```
---
## Webhook Support
@@ -97,7 +109,7 @@ 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.
---
@@ -128,7 +140,7 @@ Estimates and invoices keep their number, date, customer, total and **man-hours*
* 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 when it was paid in full (the later of its date and the last payment or credit memo applied to it): on the customer page's list, **Paid** when it was paid the day it was written, or **Paid +3d** when it was paid in full 3 days after its date, with the date when hovering over it; on the invoice page, the date (e.g. **Paid 11/03/2026**).
* 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
@@ -140,17 +152,42 @@ 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.
#### Refunding a paid invoice
Completed work that's billed and paid in full is refunded from its invoice, with a QuickBooks **Refund Receipt**, the way QuickBooks refunds a paid sale:
* **Refund** on a paid-in-full invoice (or pick it under **Paid invoice** on the customer's Refund page). The invoice's lines are listed (bundles opened up into their lines), each marked parts or labor, with what earlier refunds already took of it. Tick the lines to refund and change the **quantity** (e.g. 2 of 4 parts returned) or the **amount** (a partial refund, e.g. some of the labor). A line can't be refunded, over one or more refunds, for more than it was billed.
* **Restocking fee** is optional: when ticked, it's the rate in the settings of the *parts* refunded. Labor carries no fee, so a refund of labor alone has none. Leave it off when the parts aren't coming back.
* The page shows the lines, the invoice discount's share (if it had one), the estimated sales tax refunded, the fee and the refund. Choose **Company check** (with its number) or **Card**.
* **Refund** records the refund receipt in QuickBooks: the refunded lines with their products/services and tax codes (so the income and sales tax come back off the books; QuickBooks works out the tax), the discount's share, the fee as a negative line with the restocking fee product/service, paid out of the refund check or card refund account in the settings, with the payment method (a QuickBooks payment method named Check, or one with Card/Visa/Mastercard/Amex/Discover in its name) and the check number. The invoice stays as it is, paid.
* As ticked on the page, it also notes the refund on the invoice's work orders (their status is left alone) and emails the customer a summary. The refund's page, PDF and email list the lines refunded, and show the refund receipt's exact total: refund exactly that.
### Business report
**Business report** in the top menu compares, for a period (this or last week, month, quarter or year, or custom dates; weeks start on the day set in Redmine's *Start calendars on* setting, Monday when it follows the language):
* **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.
* **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 figure month by month, with totals.
* **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
@@ -192,11 +229,14 @@ 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 (customer credit) and refunds of paid invoices, refunds and their PDFs
* **Share issues with customers**: the Share link on issues (see Sharing an issue with the customer)
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 or refund receipt line (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
@@ -233,8 +273,9 @@ Hook|:qbo_billing_issues_created, { estimate:, issues:, params: } | Called after
Hook|:qbo_billing_field_defaults, { customer:, issues: } | Return `{ field_id => value }` for a document's work orders: used when an invoice is made from an estimate, for the fields it leaves blank. New estimates and invoices start blank (redmine_qbo_vehicles: the work orders' VIN and highest mileage)
Hook|:qbo_billing_field_options, { customer: } | Return `{ field_id => [{ value:, label: }, ...] }` to suggest in the editor's custom field boxes for a customer (redmine_qbo_vehicles: the customer's vehicles for the VIN box)
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|checkboxes with `data-new-issue-param="issue[field]"` and `data-appointment-param="field"` on the customer page | Ticking one adds `issue[field]=value` to the New issue link and `field=value` to redmine_qbo_calendar's Add appointment link (`#appointment_link`), one per field (redmine_qbo's estimates: `estimate_id`, redmine_qbo_vehicles' vehicles: `vehicle_id`)
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
+34 -62
View File
@@ -33,36 +33,6 @@ class CustomersController < ApplicationController
before_action :require_admin, only: :sync
skip_before_action :verify_authenticity_token, :check_if_login_required, only: [:view]
def address_to_s(address)
return if address.nil?
lines = [
address.line1,
address.line2,
address.line3,
address.line4,
address.line5
].compact_blank
city_line = [
address.city,
address.country_sub_division_code,
address.postal_code
].compact_blank.join(" ")
lines << city_line unless city_line.blank?
lines.join("\n")
end
def add_customer
global_check_permission(:add_customers)
end
def allowed_params
params.require(:customer).permit(:name, :email, :primary_phone, :mobile_phone, :phone_number, :notes)
end
# Used for autocomplete forms. Fuzzy matching (nicknames, typos, word order, phone digits) helps
# staff spot an existing customer before creating a duplicate. See CustomerSearchService.
def autocomplete
@@ -109,14 +79,6 @@ class CustomersController < ApplicationController
render_404
end
def filter_estimates_by_customer
@filtered_estimates = Estimate.all.where(customer_id: params[:selected_customer])
end
def filter_invoices_by_customer
@filtered_invoices = Invoice.all.where(customer_id: params[:selected_customer])
end
# Most matches a search lists (best first)
SEARCH_LIMIT = 200
@@ -146,29 +108,6 @@ class CustomersController < ApplicationController
@issue_counts = Issue.where(customer_id: @customers.map(&:id)).group(:customer_id).count
end
def load_issue_data
@journals = @issue.journals.preload(:details).preload(user: :email_address).reorder(:created_on, :id).to_a
@journals.each_with_index { |j, i| j.indice = i + 1 }
@journals.reject!(&:private_notes?) unless User.current.allowed_to?(:view_private_notes, @issue.project)
Journal.preload_journals_details_custom_fields(@journals)
@journals.select! { |journal| journal.notes? || journal.visible_details.any? }
@journals.reverse! if User.current.wants_comments_in_reverse_order?
@changesets = @issue.changesets.visible.preload(:repository, :user).to_a
@changesets.reverse! if User.current.wants_comments_in_reverse_order?
@relations = @issue.relations.select { |r| r.other_issue(@issue)&.visible? }
@allowed_statuses = @issue.new_statuses_allowed_to(User.current)
@priorities = IssuePriority.active
@time_entry = TimeEntry.new(issue: @issue, project: @issue.project)
@relation = IssueRelation.new
end
def log(msg)
Rails.logger.info "[CustomersController] #{msg}"
end
def new
@customer = Customer.new
@@ -253,8 +192,41 @@ class CustomersController < ApplicationController
render_403
end
private
def add_customer
global_check_permission(:add_customers)
end
def allowed_params
params.require(:customer).permit(:name, :email, :primary_phone, :mobile_phone, :phone_number, :notes)
end
def load_issue_data
@journals = @issue.journals.preload(:details).preload(user: :email_address).reorder(:created_on, :id).to_a
@journals.each_with_index { |j, i| j.indice = i + 1 }
@journals.reject!(&:private_notes?) unless User.current.allowed_to?(:view_private_notes, @issue.project)
Journal.preload_journals_details_custom_fields(@journals)
@journals.select! { |journal| journal.notes? || journal.visible_details.any? }
@journals.reverse! if User.current.wants_comments_in_reverse_order?
@changesets = @issue.changesets.visible.preload(:repository, :user).to_a
@changesets.reverse! if User.current.wants_comments_in_reverse_order?
@relations = @issue.relations.select { |r| r.other_issue(@issue)&.visible? }
@allowed_statuses = @issue.new_statuses_allowed_to(User.current)
@priorities = IssuePriority.active
@time_entry = TimeEntry.new(issue: @issue, project: @issue.project)
@relation = IssueRelation.new
end
def log(msg)
Rails.logger.info "[CustomersController] #{msg}"
end
def view_customer
global_check_permission(:view_customers)
end
end
end
+31
View File
@@ -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
+86 -10
View File
@@ -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 })
@@ -165,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 })
+34 -2
View File
@@ -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
+32 -5
View File
@@ -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)
+178
View File
@@ -0,0 +1,178 @@
#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 (a canceled order's deposit), the
# Refund invoice page for completed work on a paid invoice, 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
# Refund of a paid invoice: its lines to pick from, the optional restocking fee, how the money goes back
def new_invoice
@form = RedmineQboBilling::InvoiceRefundForm.new(invoice_id: params[:invoice_id].to_s, txn_date: User.current.today.iso8601,
method: 'check', charge_fee: '1', note_issues: '1', email_customer: '1')
return unless load_invoice_page
@form.customer_id = @customer.id.to_s
# Every line with something left to refund is ticked, at what's left of it
@lines.select(&:refundable?).each do |line|
@form.lines[line.key] = RedmineQboBilling::InvoiceRefundForm::LineChoice.new(
refund: '1', quantity: (quantity = RedmineQboBilling::InvoiceRefundWriter.default_quantity(line)) && RedmineQboBilling::RefundWriter.plain(quantity),
amount: format('%.2f', line.remaining_amount)
)
end
load_invoice_plan
end
def create_invoice
@form = RedmineQboBilling::InvoiceRefundForm.from_params(params.require(:refund).permit(*RedmineQboBilling::InvoiceRefundForm.permitted))
return unless load_invoice_page
return show_invoice_form unless @form.valid?
refund = RedmineQboBilling::InvoiceRefundWriter.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_invoice_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)
@invoices = RedmineQboBilling::InvoiceRefundWriter.invoice_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
# The paid invoice from QuickBooks, its customer and its lines; renders the error and returns false when it
# can't be refunded
def load_invoice_page
gateway = RedmineQboBilling::RefundGateway.new
@invoice = gateway.invoice(@form.invoice_id) if @form.invoice_id.present?
@customer = Customer.find_by(id: @invoice&.customer_ref&.value)
if @invoice.nil? || @customer.nil?
render_404
return false
end
unless RedmineQboBilling::InvoiceRefundWriter.paid_in_full?(@invoice)
flash[:error] = l(:error_refund_invoice_not_paid)
redirect_to edit_qbo_invoice_path(@invoice.id)
return false
end
@lines = RedmineQboBilling::InvoiceRefundWriter.lines(@invoice)
@refunds = QboRefund.of_invoice(@invoice.id).recent.to_a
true
rescue *QBO_ERRORS => e
flash[:error] = qbo_message(e)
redirect_to(@form.customer_id.present? ? customer_path(@form.customer_id) : customers_path)
false
end
def load_invoice_plan
@plan, = RedmineQboBilling::InvoiceRefundWriter.plan(@invoice, @form, invoice_lines: @lines)
end
def show_invoice_form
load_invoice_plan
render :new_invoice, 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
-22
View File
@@ -31,28 +31,6 @@ module AuthHelper
require_login
end
# Kept for plugins that still call it (e.g. redmine_qbo_vehicles): requires a logged-in user.
# The old version effectively never ran; share-link customers use require_login_or_customer_token.
def require_user
return true if User.current.logged?
require_login
end
def allowed_to?(action)
return false if User.current.nil?
project = Project.find_by(id: params[:project_id])
return false if project.nil?
User.current.allowed_to?(action, project)
end
def check_permission(permission)
if !allowed_to?(permission)
flash[:error] = t :notice_forbidden
render_403
end
end
def global_check_permission(permission)
if !globaly_allowed_to?(permission)
flash[:error] = t :notice_forbidden
+3 -2
View File
@@ -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.
+40
View File
@@ -0,0 +1,40 @@
#The MIT License (MIT)
#
#Copyright (c) 2026 rick barrette
#
#Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
#
#The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
#
#THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
# Emails a customer the summary of their refund (SOP-OPS-014). It goes out like redmine_qbo_reminders' appointment
# reminders when that plugin is installed (its From, Reply-To and SMTP server, e.g. the shop's sales mailbox);
# otherwise through Redmine's own email settings, from Redmine's emission address. Not Redmine's Mailer, which only
# writes to Redmine users and adds Redmine's headers and footer.
class QboRefundMailer < ActionMailer::Base
layout false
self.raise_delivery_errors = true
class DeliveryOff < StandardError; end
def refund_summary(refund, email)
@refund = refund
@customer = refund.customer
reminders = defined?(RedmineQboReminders::Settings) ? RedmineQboReminders::Settings.current : nil
@shop_name = reminders&.[]('shop_name').to_s.presence || Setting.app_title
delivery = reminders ? reminders.delivery_options : {}
if delivery.empty? && !ActionMailer::Base.perform_deliveries
raise DeliveryOff, I18n.t(:text_refund_email_off)
end
options = { to: email, from: reminders&.from.presence || Setting.mail_from.to_s,
subject: I18n.t(:text_refund_email_subject, shop: @shop_name, amount: RedmineQboBilling::RefundWriter.money(refund.refund_amount)) }
options[:reply_to] = reminders.reply_to if reminders&.reply_to
message = mail(options.merge(delivery)) do |format|
format.text
end
message.perform_deliveries = true unless delivery.empty?
message
end
end
+10 -11
View File
@@ -21,17 +21,8 @@ class CustomerToken < ApplicationRecord
TOKEN_EXPIRATION = 1.month
# Check if the token has expired
def expired?
expires_at.present? && expires_at <= Time.current
end
# Remove expired tokens from the database
def self.remove_expired_tokens
where("expires_at <= ?", Time.current).delete_all
end
# Get or create a token for the given issue
# Get or create a token for the given issue. Making a new one also clears out the share links that have expired
# or whose issue was deleted, so they don't pile up.
def self.get_token(issue)
return unless issue
return unless User.current.allowed_to?(:view_issues, issue.project)
@@ -39,9 +30,17 @@ class CustomerToken < ApplicationRecord
token = active.find_by(issue_id: issue.id)
return token if token
purge_expired
create!(issue: issue)
end
# Deletes the share links that have expired or whose issue no longer exists; returns how many
def self.purge_expired
where('expires_at <= ?', Time.current)
.or(where.not(issue_id: Issue.select(:id)))
.delete_all
end
private
# Generate a unique token for the customer
+3 -2
View File
@@ -23,16 +23,17 @@ class Qbo < ActiveRecord::Base
return I18n.t(:label_qbo_never_synced)
end
# Token expiry times, or nil when QuickBooks isn't connected (the settings page shows N/A)
def self.oauth2_access_token_expires_at
QboConnectionService.current!.oauth2_access_token_expires_at
rescue
return I18n.t(:label_qbo_never_synced)
nil
end
def self.oauth2_refresh_token_expires_at
QboConnectionService.current!.oauth2_refresh_token_expires_at
rescue
return I18n.t(:label_qbo_never_synced)
nil
end
# Updates last sync time stamp
-6
View File
@@ -79,12 +79,6 @@ class QboBaseModel < ActiveRecord::Base
QboSyncJob.perform_later(entity: model_name.name, id: id)
end
# Flag used to update local without pushing to QBO.
# This is used to prevent loops with the webhook
def skip_qbo_push?
!!skip_qbo_push
end
def self.qbo_sync(push: true)
self.qbo_push_enabled = push
end
+66
View File
@@ -0,0 +1,66 @@
#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)
}
# 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
+103
View File
@@ -0,0 +1,103 @@
#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.
# Two kinds: credit, a canceled order's deposit (RefundWriter), and invoice, completed work on a paid invoice
# (InvoiceRefundWriter).
class QboRefund < ApplicationRecord
METHODS = %w[check card].freeze
STATUSES = %w[done incomplete].freeze
KINDS = %w[credit invoice].freeze
# A refunded invoice line, as recorded: its key on the invoice (InvoiceRefundWriter.line_key)
RefundedLine = Struct.new(:key, :description, :quantity, :amount, :parts, keyword_init: true)
belongs_to :customer
belongs_to :user, optional: true
validates :customer_id, presence: true
validates :method, inclusion: { in: METHODS }
validates :status, inclusion: { in: STATUSES }
validates :kind, inclusion: { in: KINDS }
scope :recent, -> { order(created_at: :desc, id: :desc) }
# The invoice's refunds that made a refund receipt in QuickBooks
scope :of_invoice, ->(id) { where(kind: 'invoice', invoice_id: id).where.not(purchase_id: [nil, '']) }
def invoice?
kind == 'invoice'
end
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
def noted_issue_ids
Array(JSON.parse(self[:noted_issue_ids].presence || '[]')).map(&:to_i)
rescue JSON::ParserError
[]
end
def noted_issue_ids=(ids)
self[:noted_issue_ids] = Array(ids).map(&:to_i).uniq.to_json
end
def refunded_lines
Array(JSON.parse(self[:refunded_lines].presence || '[]')).map do |line|
RefundedLine.new(key: line['key'].to_s, description: line['description'].to_s, quantity: line['quantity'],
amount: BigDecimal(line['amount'].to_s.presence || '0'), parts: line['parts'] == true)
end
rescue JSON::ParserError
[]
end
def refunded_lines=(lines)
self[:refunded_lines] = Array(lines).map do |line|
{ key: line.key.to_s, description: line.description.to_s, quantity: line.quantity&.to_s,
amount: line.amount.to_d.to_s('F'), parts: line.parts ? true : false }
end.to_json
end
# What the order or invoice is called: "E1068", "Invoice #1234", or nil
def document_label
if invoice? then I18n.t(:label_refund_invoice_number, number: invoice_number)
elsif estimate_number.present? then "E#{estimate_number}"
end
end
# The QuickBooks screen for the refund receipt, check or expense
def purchase_url
return nil if purchase_id.blank?
page = if invoice? then 'refundreceipt'
elsif check? then 'check'
else 'expense'
end
"https://#{RedmineQbo.sandbox_mode? ? 'sandbox' : 'app'}.qbo.intuit.com/app/#{page}?txnId=#{purchase_id}"
end
end
+2
View File
@@ -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
+3
View File
@@ -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
-10
View File
@@ -80,15 +80,6 @@ class SyncServiceBase
false
end
def extract_value(remote, remote_attr)
case remote_attr
when Proc
remote_attr.call(remote)
else
remote.public_send(remote_attr)
end
end
# Attribute Mapping DSL
#
# This DSL defines how attributes from a QuickBooks Online (QBO) entity
@@ -157,7 +148,6 @@ class SyncServiceBase
end
end
def map_attribute(local_attr, remote_attr = nil, &block)
attribute_map[local_attr] =
if block_given?
@@ -1,45 +1,58 @@
<%#
Adds what's ticked on the customer page to the "New issue" link (#dynamic-new-issue-link in the contextual
area). Any checkbox with data-new-issue-param="issue[field]" takes part, one ticked per field: this plugin's
estimates (issue[estimate_id]), and other plugins' lists (e.g. redmine_qbo_vehicles' issue[vehicle_id]).
Adds what's ticked on the customer page to its links: "New issue" (#dynamic-new-issue-link in the contextual area)
and redmine_qbo_calendar's "Add appointment" (#appointment_link). A checkbox takes part with
data-new-issue-param="issue[field]" (New issue) and data-appointment-param="field" (Add appointment); one is
ticked per field: this plugin's estimates (estimate_id), and other plugins' lists (e.g. redmine_qbo_vehicles'
vehicle_id).
%>
<script>
function newIssueParamBoxes(param) {
return Array.prototype.filter.call(document.querySelectorAll('input[data-new-issue-param]'), function (cb) {
return !param || cb.getAttribute('data-new-issue-param') === param;
});
}
(function () {
var LINKS = [['dynamic-new-issue-link', 'data-new-issue-param'], ['appointment_link', 'data-appointment-param']];
var ANY = 'input[data-new-issue-param], input[data-appointment-param]';
// One box per field: ticking one unticks the others for the same field
document.addEventListener('change', function (event) {
var box = event.target;
if (!box.matches || !box.matches('input[data-new-issue-param]')) return;
if (box.checked) {
newIssueParamBoxes(box.getAttribute('data-new-issue-param')).forEach(function (cb) {
if (cb !== box) cb.checked = false;
function boxes(attr, param) {
return Array.prototype.filter.call(document.querySelectorAll('input[' + attr + ']'), function (cb) {
return !param || cb.getAttribute(attr) === param;
});
}
updateLink();
});
function updateLink() {
var link = document.getElementById('dynamic-new-issue-link');
if (!link) return;
// Cache the pristine base URL on first run
if (!link.dataset.baseUrl) link.dataset.baseUrl = link.getAttribute('href');
var url = new URL(link.dataset.baseUrl, window.location.origin);
newIssueParamBoxes().forEach(function (cb) {
var param = cb.getAttribute('data-new-issue-param');
var ticked = newIssueParamBoxes(param).filter(function (b) { return b.checked; })[0];
if (ticked) {
url.searchParams.set(param, ticked.value);
} else {
url.searchParams.delete(param);
// Boxes for the same field (the same estimate list, the same vehicle list)
function sameField(box) {
for (var i = 0; i < LINKS.length; i++) {
var attr = LINKS[i][1], param = box.getAttribute(attr);
if (param) return boxes(attr, param);
}
});
return [box];
}
link.setAttribute('href', url.toString());
}
function updateLinks() {
LINKS.forEach(function (pair) {
var link = document.getElementById(pair[0]);
if (!link) return;
// Cache the pristine base URL on first run
if (!link.dataset.baseUrl) link.dataset.baseUrl = link.getAttribute('href');
var url = new URL(link.dataset.baseUrl, window.location.origin);
boxes(pair[1]).forEach(function (cb) {
var param = cb.getAttribute(pair[1]);
var ticked = boxes(pair[1], param).filter(function (b) { return b.checked; })[0];
if (ticked) {
url.searchParams.set(param, ticked.value);
} else {
url.searchParams.delete(param);
}
});
link.setAttribute('href', url.toString());
});
}
// One box per field: ticking one unticks the others for the same field
document.addEventListener('change', function (event) {
var box = event.target;
if (!box.matches || !box.matches(ANY)) return;
if (box.checked) {
sameField(box).forEach(function (cb) { if (cb !== box) cb.checked = false; });
}
updateLinks();
});
})();
</script>
@@ -1 +0,0 @@
$('select#issue_estimate_id').html('<%= j content_tag(:option,'',value:"")+options_from_collection_for_select(@filtered_estimates, :id, :doc_number) %>');
+5
View File
@@ -5,6 +5,11 @@
<% 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 %>
+38 -1
View File
@@ -23,6 +23,9 @@
<% if RedmineQboBilling.payment_receiver? %>
<%= link_to sprite_icon('add', l(:button_receive_payment)), new_qbo_payment_path(customer_id: @customer.id), class: 'icon icon-add' %>
<% end %>
<% if RedmineQboBilling.refunder? %>
<%= link_to sprite_icon('arrow-narrow-left', l(:label_refund)), new_qbo_refund_path(customer_id: @customer.id), class: 'icon icon-arrow-narrow-left' %>
<% end %>
<% if User.current.allowed_to?(:edit_customers, nil, global: true) %>
<%= link_to sprite_icon('edit', l(:button_edit)), edit_customer_path(@customer),
class: 'icon icon-edit', accesskey: accesskey(:edit) %>
@@ -49,7 +52,7 @@
<div class="splitcontent">
<div class="splitcontentleft">
<h4><%=t(:estimates)%>:</h4>
<%= render partial: 'estimates/list', locals: {estimates: @customer.estimates} %>
<%= render partial: 'estimates/list', locals: {estimates: @customer.estimates, new_issue_checkboxes: true} %>
</div>
<div class="splitcontentleft">
@@ -58,6 +61,40 @@
</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>
<% if refund.invoice? %>
<%= link_to refund.document_label, RedmineQboBilling.invoice_writer? ? edit_qbo_invoice_path(refund.invoice_id) : invoice_path(refund.invoice_id) %>
<% elsif refund.estimate_id.present? %>
<%= link_to("E#{refund.estimate_number}", RedmineQboBilling.writer? ? edit_qbo_estimate_path(refund.estimate_id) : estimate_path(refund.estimate_id)) %>
<% end %>
</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">
+11 -6
View File
@@ -3,14 +3,19 @@
<%= render partial: 'qbo_estimates/status_styles' %>
<div class="qbo-estimate-list">
<% estimates.sort.reverse.each do |estimate| %>
<%# One cell each (qbo_estimates/_status_styles lines them up in columns, so the icons line up) %>
<div class="row">
<%= check_box_tag "estimate_ids[]", estimate.id, false, onchange: "updateLink()", data: { text: "Estimate ##{estimate.doc_number}", new_issue_param: 'issue[estimate_id]' }, class: "estimate-checkbox appointment" %>
<b><%= link_to "##{estimate.doc_number}", estimate_path(estimate), target: :_blank %></b> <%= estimate.txn_date %>
<%# Ticking an estimate adds it to the customer page's New issue and Add appointment links (customers/_new_issue_link_script) %>
<span class="qbo-list-check"><%= check_box_tag "estimate_ids[]", estimate.id, false, data: { new_issue_param: 'issue[estimate_id]', appointment_param: 'estimate_id' }, class: "estimate-checkbox" if local_assigns[:new_issue_checkboxes] %></span>
<b class="qbo-list-number"><%= link_to "##{estimate.doc_number}", estimate_path(estimate), target: :_blank %></b>
<span class="qbo-list-date"><%= estimate.txn_date %></span>
<%# QuickBooks status, cached by the estimate sync (kept current by the webhook) %>
<% if estimate.txn_status.present? %>
<span class="qbo-estimate-status qbo-estimate-status-<%= estimate.txn_status.downcase %>"><%= estimate.txn_status %></span>
<% end %>
<%= render partial: 'qbo_estimates/estimate_actions', locals: { estimate: estimate } if RedmineQboBilling.writer? %>
<span class="qbo-list-status">
<% if estimate.txn_status.present? %>
<span class="qbo-estimate-status qbo-estimate-status-<%= estimate.txn_status.downcase %>"><%= estimate.txn_status %></span>
<% end %>
</span>
<span class="qbo-list-actions"><%= render partial: 'qbo_estimates/estimate_actions', locals: { estimate: estimate } if RedmineQboBilling.writer? %></span>
</div>
<% end %>
</div>
+12 -7
View File
@@ -13,14 +13,19 @@
<div class="qbo-invoice-list">
<% invoices.sort.reverse.each do |invoice| %>
<%# One cell each (qbo_estimates/_status_styles lines them up in columns, so the icons line up) %>
<div class="row">
<%= check_box_tag "invoice_ids[]", invoice.id, false, onchange: "updateLink()", data: { url: invoice_path(invoice), text: "Invoice ##{invoice.to_s}" }, class: "invoice-checkbox appointment" if invoices.count > 1 %>
<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>
<% end %>
<%= render partial: 'qbo_invoices/invoice_actions', locals: { invoice: invoice } if RedmineQboBilling.invoice_writer? %>
<span class="qbo-list-check"><%= check_box_tag "invoice_ids[]", invoice.id, false, class: "invoice-checkbox" if invoices.count > 1 %></span>
<b class="qbo-list-number"><%= link_to "##{invoice.doc_number}", invoice_path(invoice), target: :_blank %></b>
<span class="qbo-list-date"><%= invoice.txn_date %></span>
<%# Paid / partially paid / overdue / open / voided, from the cached balance and due date; short so the list
stays narrow: "Paid", or "Paid +3d" when paid in full days after its date (the date on hover) %>
<span class="qbo-list-status">
<% if (status = invoice.status) %>
<span class="qbo-estimate-status qbo-invoice-status-<%= status %>" title="<%= RedmineQboBilling::InvoiceStatus.title(status, paid_on: invoice.paid_on) %>"><%= RedmineQboBilling::InvoiceStatus.short_label(status, paid_on: invoice.paid_on, invoice_date: invoice.txn_date) %></span>
<% end %>
</span>
<span class="qbo-list-actions"><%= render partial: 'qbo_invoices/invoice_actions', locals: { invoice: invoice } if RedmineQboBilling.invoice_writer? %></span>
</div>
<% end %>
</div>
+6
View File
@@ -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>
+67
View File
@@ -16,6 +16,36 @@
multiple: true, size: 8, id: 'settings_labor_item_ids' %>
<em class="info"><%= l(:text_labor_items) %></em>
</p>
<%# QuickBooks custom fields to leave out of estimates and invoices (see RedmineQboBilling::Company). Hidden
fields that aren't found right now (e.g. no recent estimate has them) are kept as hidden. %>
<% company = RedmineQboBilling::Company %>
<% qbo_fields = company.all_custom_fields %>
<% hidden_ids = company.hidden_field_ids %>
<% sales_field = company.sales_person_field %>
<p class="qbo-custom-fields-setting">
<label><%= l(:label_qbo_hidden_custom_fields) %></label>
<%= hidden_field_tag 'settings[hidden_custom_field_ids][]', '', id: nil %>
<% (hidden_ids - qbo_fields.map { |f| f.id.to_i }).each do |id| %>
<%= hidden_field_tag 'settings[hidden_custom_field_ids][]', id, id: nil %>
<% end %>
<% if qbo_fields.empty? %>
<%= l(:label_none) %>
<% else %>
<% qbo_fields.each do |field| %>
<label class="block">
<%= check_box_tag 'settings[hidden_custom_field_ids][]', field.id, hidden_ids.include?(field.id.to_i),
id: "settings_hidden_custom_field_#{field.id}" %>
<%= field.name %>
<% if sales_field && sales_field.id.to_i == field.id.to_i %>
<em>(<%= l(:text_qbo_sales_person_field) %>)</em>
<% end %>
</label>
<% end %>
<% end %>
<%= link_to sprite_icon('reload', l(:button_refresh_quickbooks_fields)), refresh_company_qbo_estimates_path,
method: :post, class: 'icon icon-reload' %>
<em class="info"><%= l(:text_qbo_hidden_custom_fields) %></em>
</p>
</div>
<% issue_builder = RedmineQboBilling::EstimateIssueBuilder %>
@@ -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 %>
+40
View File
@@ -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>
+11
View File
@@ -0,0 +1,11 @@
<% html_title l(:label_qbo_drafts) %>
<h2><%= link_to l(:label_customers), customers_path %> &#187; <%= 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 %>
+37 -6
View File
@@ -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 %>
+13 -2
View File
@@ -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 %>
+61 -3
View File
@@ -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 {
@@ -743,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; });
@@ -751,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();
@@ -761,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) {
@@ -14,4 +14,11 @@
.qbo-invoice-status-open { background: #e8eefa; color: #0d47a1; }
.qbo-invoice-status-voided { background: #eceef1; color: #6b6c72; text-decoration: line-through; }
.qbo-invoice-list .qbo-estimate-status { font-size: .8em; padding: 1px 7px; margin-left: 4px; }
/* The estimate and invoice lists: checkbox, number, date, status and actions in columns, so the edit/view icons
line up; a list wider than its column scrolls instead of wrapping */
.qbo-estimate-list, .qbo-invoice-list { display: grid; grid-template-columns: repeat(5, max-content); column-gap: .35em;
row-gap: 2px; align-items: center; overflow-x: auto; }
.qbo-estimate-list .row, .qbo-invoice-list .row { display: contents; }
.qbo-estimate-list .row > *, .qbo-invoice-list .row > * { white-space: nowrap; }
.qbo-list-status .qbo-estimate-status { margin-left: 0; }
</style>
+20 -1
View File
@@ -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; }
+61 -11
View File
@@ -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';
+2 -1
View File
@@ -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 } %>
+6
View File
@@ -1,9 +1,15 @@
<% 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 %>
<%# Completed work that's paid in full is refunded with a refund receipt %>
<% if RedmineQboBilling.refunder? && @form.total.to_d.positive? && @form.balance.to_d <= 0 %>
<%= link_to sprite_icon('arrow-narrow-left', l(:label_refund)), new_invoice_qbo_refunds_path(invoice_id: @form.id), class: 'icon icon-arrow-narrow-left' %>
<% end %>
<%= link_to sprite_icon('application-pdf', l(:label_estimate_pdf)), invoice_path(@form.id), class: 'icon icon-pdf', target: :_blank %>
<% if RedmineQboBilling.invoice_sender? && @form.email.present? %>
<%= link_to sprite_icon('email', l(:button_email_estimate)), send_email_qbo_invoice_path(@form.id, email: @form.email),
+2 -1
View File
@@ -1,5 +1,6 @@
<% html_title l(:label_new_invoice) %>
<%= render partial: 'qbo_estimates/header', 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 } %>
<%= render partial: 'qbo_estimates/form', locals: { form: @form, draft: @draft } %>
+2
View File
@@ -0,0 +1,2 @@
<%# A saved payment, on the same page as Receive payment %>
<%= render template: 'qbo_payments/new' %>
+3
View File
@@ -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>
+30 -8
View File
@@ -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 %> &#187;
<% if customer %><%= link_to customer.name, customer_path(customer) %> &#187;<% end %>
<%= l(:button_receive_payment) %>
<% if editing %>
<%= link_to l(:label_payments), qbo_payments_path(customer_id: @form.customer_id) %> &#187;
<% 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 %>
+3
View File
@@ -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,29 @@
<% 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.document_label || t(:label_refund_your_order)) %>
<% if @refund.invoice? -%>
<% @refund.refunded_lines.each do |line| -%>
<%= line.description %>: <%= money.(line.amount) %>
<% end -%>
<%= t(:label_refund_lines_amount) %>: <%= money.(@refund.lines_amount) %>
<% if @refund.discount_amount.to_d.positive? -%>
<%= t(:label_refund_discount) %>: -<%= money.(@refund.discount_amount) %>
<% end -%>
<%= t(:label_refund_tax) %>: <%= money.(@refund.tax_amount) %>
<% end -%>
<% 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) %>
<% if !@refund.invoice? -%>
<%= t(:text_refund_email_terms) %>
<% elsif @refund.fee_amount.to_d.positive? -%>
<%= t(:text_refund_email_terms_invoice) %>
<% end -%>
<%= @shop_name %>
+137
View File
@@ -0,0 +1,137 @@
<%# Refund for a canceled order or returned parts (SOP-OPS-014) %>
<% html_title l(:label_refund) %>
<% money = ->(amount) { RedmineQboBilling::RefundWriter.money(amount) } %>
<% preview = @preview %>
<h2>
<%= link_to l(:label_customers), customers_path %> &#187;
<%= link_to @customer.name, customer_path(@customer) %> &#187;
<%= l(:label_refund) %>
</h2>
<%= error_messages_for @form %>
<p class="warning"><%= l(:text_refund_final_sale) %></p>
<%# Completed work on a paid invoice is refunded from the invoice (a refund receipt), not from credit %>
<% if @invoices.present? %>
<%= form_tag new_invoice_qbo_refunds_path, method: :get, id: 'qbo-refund-invoice' do %>
<div class="box tabular">
<p>
<label for="qbo_refund_invoice"><%= l(:label_refund_paid_invoice) %></label>
<%= select_tag 'invoice_id', options_for_select(@invoices), include_blank: true, id: 'qbo_refund_invoice',
onchange: 'if (this.value) this.form.submit()' %>
<noscript><%= submit_tag l(:button_apply), name: nil %></noscript>
<em class="info"><%= l(:text_refund_paid_invoice) %></em>
</p>
</div>
<% end %>
<% end %>
<% 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 %>
+195
View File
@@ -0,0 +1,195 @@
<%# Refund of completed work on a paid invoice: a QuickBooks Refund Receipt (InvoiceRefundWriter) %>
<% html_title "#{l(:label_refund)} #{l(:label_refund_invoice_number, number: @invoice.doc_number)}" %>
<% writer = RedmineQboBilling::RefundWriter %>
<% money = ->(amount) { writer.money(amount) } %>
<% plan = @plan %>
<% number = @invoice.doc_number.to_s %>
<h2>
<%= link_to l(:label_customers), customers_path %> &#187;
<%= link_to @customer.name, customer_path(@customer) %> &#187;
<%= link_to l(:label_refund_invoice_number, number: number), edit_qbo_invoice_path(@invoice.id) %> &#187;
<%= l(:label_refund) %>
</h2>
<%= error_messages_for @form %>
<p class="warning"><%= l(:text_refund_final_sale) %></p>
<% if @refunds.any? %>
<div class="flash warning">
<%= l(:text_refund_invoice_earlier) %>
<%= safe_join(@refunds.map { |r| link_to("#{format_date(r.txn_date)} · #{money.(r.refund_amount)}", qbo_refund_path(r)) }, ', ') %>
</div>
<% end %>
<%= form_tag create_invoice_qbo_refunds_path, method: :post, id: 'qbo-refund-form' do %>
<%= hidden_field_tag 'refund[customer_id]', @customer.id, id: nil %>
<%= hidden_field_tag 'refund[invoice_id]', @invoice.id, id: nil %>
<fieldset class="box" id="qbo-refund-lines">
<legend><%= l(:label_refund_invoice_lines, number: number, date: format_date(@invoice.txn_date)) %></legend>
<table class="list" data-discount-rate="<%= plan.discount_rate.to_s('F') %>" data-tax-rate="<%= plan.tax_rate.to_s('F') %>"
data-fee-rate="<%= plan.fee_rate.to_s('F') %>">
<thead>
<tr>
<th></th>
<th style="text-align: left"><%= l(:label_refund_line) %></th>
<th></th>
<th style="text-align: right"><%= l(:label_refund_line_billed) %></th>
<th style="text-align: right"><%= l(:label_refund_line_refunded) %></th>
<th><%= l(:label_refund_line_quantity) %></th>
<th><%= l(:label_refund_line_amount) %></th>
</tr>
</thead>
<tbody>
<% @lines.each do |line| %>
<% choice = @form.line(line.key) %>
<% field = "refund[lines][#{line.key}]" %>
<% dom = "qbo_refund_line_#{line.key.parameterize(separator: '_')}" %>
<tr class="qbo-refund-line<%= ' disabled' unless line.refundable? %>" data-rate="<%= line.rate&.to_s('F') %>"
data-parts="<%= line.parts ? 1 : 0 %>" data-taxable="<%= line.taxable ? 1 : 0 %>">
<td>
<% if line.refundable? %>
<%= hidden_field_tag "#{field}[refund]", '0', id: nil %>
<%= check_box_tag "#{field}[refund]", '1', choice&.refund?, id: dom, class: 'qbo-refund-pick' %>
<% end %>
</td>
<td style="text-align: left">
<label for="<%= dom %>">
<% if line.item_name.present? %><strong><%= line.item_name %></strong><br><% end %>
<%= line.description %>
</label>
</td>
<td><span class="badge <%= line.parts ? 'badge-status-open' : 'badge-status-closed' %>"><%= l(line.parts ? :label_refund_parts : :label_refund_labor) %></span>
<% if line.taxable %><span class="badge"><%= l(:label_refund_taxable) %></span><% end %></td>
<td style="text-align: right">
<% if line.quantity && line.rate %><%= writer.plain(line.quantity) %> × <%= money.(line.rate) %><br><% end %>
<%= money.(line.amount) %>
</td>
<td style="text-align: right"><%= line.refunded_amount.positive? ? money.(line.refunded_amount) : '' %></td>
<% if line.refundable? %>
<td style="white-space: nowrap">
<% if line.quantity && line.rate %>
<%= text_field_tag "#{field}[quantity]", choice&.quantity, size: 5, inputmode: 'decimal', autocomplete: 'off',
class: 'qbo-refund-quantity', 'aria-label': l(:label_refund_line_quantity) %>
<em class="info">/ <%= writer.plain(line.remaining_quantity) %></em>
<% end %>
</td>
<td style="white-space: nowrap">
$<%= text_field_tag "#{field}[amount]", choice&.amount, size: 9, inputmode: 'decimal', autocomplete: 'off',
class: 'qbo-refund-line-amount', 'aria-label': l(:label_refund_line_amount),
data: { max: line.remaining_amount.to_s('F') } %>
</td>
<% else %>
<td colspan="2"><em class="info"><%= l(:text_refund_line_done) %></em></td>
<% end %>
</tr>
<% end %>
</tbody>
</table>
<p><em class="info"><%= l(:text_refund_invoice_lines) %></em></p>
</fieldset>
<div class="box tabular">
<p>
<label for="qbo_refund_charge_fee"><%= l(:label_refund_charge_fee) %></label>
<%= hidden_field_tag 'refund[charge_fee]', '0', id: nil %>
<%= check_box_tag 'refund[charge_fee]', '1', @form.charge_fee?, id: 'qbo_refund_charge_fee' %>
<%= l(:label_refund_fee_rate, rate: writer.plain(plan.fee_rate)) %>
<em class="info"><%= l(:text_refund_charge_fee) %></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_invoice_reason) %></em>
</p>
<p>
<label><%= l(:label_refund_also) %></label>
<% [[:note_issues, :label_refund_note_issues], [:email_customer, :label_refund_email_customer]].each do |flag, label| %>
<label class="block">
<%= hidden_field_tag "refund[#{flag}]", '0', id: nil %>
<%= check_box_tag "refund[#{flag}]", '1', @form.send(:"#{flag}?"), id: "qbo_refund_#{flag}" %>
<%= l(label) %>
</label>
<% end %>
<% if @customer.email.blank? %><em class="info"><%= l(:text_refund_no_email) %></em><% end %>
</p>
</div>
<fieldset class="box" id="qbo-refund-preview">
<legend><%= l(:label_refund_summary) %></legend>
<table class="list">
<tbody>
<tr><td><%= l(:label_refund_lines_amount) %></td><td style="text-align: right" id="qbo-refund-lines-amount"><%= money.(plan.lines_amount) %></td></tr>
<tr id="qbo-refund-discount-row"<%= ' style="display: none"'.html_safe unless plan.discount_rate.positive? %>>
<td><%= l(:label_refund_discount) %></td><td style="text-align: right" id="qbo-refund-discount">-<%= money.(plan.discount) %></td>
</tr>
<tr><td><%= l(:label_refund_tax_estimate) %></td><td style="text-align: right" id="qbo-refund-tax"><%= money.(plan.tax) %></td></tr>
<tr><td><%= l(:label_refund_fee_on_parts) %> (<span id="qbo-refund-parts"><%= money.(plan.parts_amount) %></span>)</td>
<td style="text-align: right" id="qbo-refund-fee">-<%= money.(plan.fee) %></td></tr>
</tbody>
<tfoot>
<tr><td><strong><%= l(:label_refund_amount) %></strong></td><td style="text-align: right"><strong id="qbo-refund-amount"><%= money.(plan.refund) %></strong></td></tr>
</tfoot>
</table>
<p><em class="info"><%= l(:text_refund_invoice_summary) %></em></p>
</fieldset>
<p><%= submit_tag l(:button_refund), data: { confirm: l(:text_refund_invoice_confirm) }, disabled: @lines.none?(&:refundable?) %></p>
<% end %>
<%= javascript_tag do %>
$(function() {
var table = $('#qbo-refund-lines table');
var money = function(n) { return '$' + n.toFixed(2).replace(/\B(?=(\d{3})+(?!\d))/g, ','); };
var num = function(v) { return parseFloat(String(v || '').replace(/[$,\s]/g, '')) || 0; };
var round = function(n) { return Math.round(n * 100) / 100; };
function update() {
var lines = 0, parts = 0, taxable = 0;
$('tr.qbo-refund-line').each(function() {
var row = $(this);
if (!row.find('.qbo-refund-pick').is(':checked')) return;
var amount = num(row.find('.qbo-refund-line-amount').val());
lines += amount;
if (row.data('parts') == 1) parts += amount;
if (row.data('taxable') == 1) taxable += amount;
});
var discountRate = num(table.data('discount-rate')), taxRate = num(table.data('tax-rate'));
var discount = round(lines * discountRate);
var tax = round(taxable * (1 - discountRate) * taxRate);
var fee = $('#qbo_refund_charge_fee').is(':checked') ? Math.round(parts * num(table.data('fee-rate'))) / 100 : 0;
$('#qbo-refund-lines-amount').text(money(lines));
$('#qbo-refund-discount').text('-' + money(discount));
$('#qbo-refund-tax').text(money(tax));
$('#qbo-refund-parts').text(money(parts));
$('#qbo-refund-fee').text('-' + money(fee));
$('#qbo-refund-amount').text(money(Math.max(lines - discount + tax - fee, 0)));
}
// A quantity refunds that many at the line's rate (the amount can still be changed after)
$('.qbo-refund-quantity').on('input', function() {
var row = $(this).closest('tr'), rate = num(row.data('rate'));
if (rate) row.find('.qbo-refund-line-amount').val(round(num($(this).val()) * rate).toFixed(2));
row.find('.qbo-refund-pick').prop('checked', num($(this).val()) > 0);
update();
});
$('.qbo-refund-line-amount, #qbo_refund_charge_fee, .qbo-refund-pick').on('input change', update);
function method() { $('#qbo-refund-check-number').toggle($('#qbo_refund_method_check').is(':checked')); }
$('input[name="refund[method]"]').on('change', method);
update(); method();
});
<% end %>
+97
View File
@@ -0,0 +1,97 @@
<%# A refund as it was made (SOP-OPS-014) %>
<% html_title l(:label_refund) %>
<% money = ->(amount) { RedmineQboBilling::RefundWriter.money(amount) } %>
<h2>
<%= link_to l(:label_customers), customers_path %> &#187;
<% if @customer %><%= link_to @customer.name, customer_path(@customer) %> &#187;<% end %>
<%= l(:label_refund) %> <%= format_date(@refund.txn_date) %>
</h2>
<div class="contextual">
<%= link_to sprite_icon('application-pdf', 'PDF'), pdf_qbo_refund_path(@refund), class: 'icon icon-pdf', target: :_blank %>
<% if @refund.fee_invoice_id.present? %>
<%= link_to sprite_icon('application-pdf', l(:label_refund_fee_invoice_pdf)), invoice_path(@refund.fee_invoice_id), class: 'icon icon-pdf', target: :_blank %>
<% end %>
</div>
<% if @refund.done? && @refund.invoice? %>
<p class="notice flash"><%= l(:text_refund_receipt_made, number: @refund.receipt_number.presence || @refund.purchase_id) %></p>
<% elsif @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">
<% if @refund.invoice? %>
<p><label><%= l(:label_refund_invoice) %></label>
<%= link_to @refund.document_label, RedmineQboBilling.invoice_writer? ? edit_qbo_invoice_path(@refund.invoice_id) : invoice_path(@refund.invoice_id) %>
· <%= l(:label_refund_paid_on_invoice) %> <%= money.(@refund.credit_amount) %></p>
<p><label><%= l(:label_refund_reason) %></label> <%= @refund.reason %></p>
<p><label><%= l(:label_refund_lines_amount) %></label> <%= money.(@refund.lines_amount) %></p>
<% if @refund.refunded_lines.any? %>
<table class="list" style="max-width: 50em">
<tbody>
<% @refund.refunded_lines.each do |line| %>
<tr>
<td style="text-align: left"><%= line.description %></td>
<td><%= l(line.parts ? :label_refund_parts : :label_refund_labor) %></td>
<td style="text-align: right"><%= RedmineQboBilling::RefundWriter.plain(BigDecimal(line.quantity.to_s)) if line.quantity.present? %></td>
<td style="text-align: right"><%= money.(line.amount) %></td>
</tr>
<% end %>
</tbody>
</table>
<% end %>
<% if @refund.discount_amount.to_d.positive? %>
<p><label><%= l(:label_refund_discount) %></label> -<%= money.(@refund.discount_amount) %></p>
<% end %>
<p><label><%= l(:label_refund_tax) %></label> <%= money.(@refund.tax_amount) %></p>
<% else %>
<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>
<% end %>
<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>
<%= @refund.fee_amount.to_d.positive? ? money.(@refund.fee_amount) : l(:label_refund_no_fee) %>
<% 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.invoice? ? :label_refund_open_receipt : (@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.noted_issue_ids.any? %>
<p><label><%= l(:label_refund_note_issues) %></label>
<%= safe_join(Issue.where(id: @refund.noted_issue_ids).map { |issue| link_to_issue(issue, project: false) }, ', ') %></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>
+61 -2
View File
@@ -2,7 +2,7 @@
<% 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) } %>
@@ -40,7 +40,12 @@
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'],
@@ -132,7 +137,7 @@
<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>
@@ -146,6 +151,7 @@
<%= 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">
@@ -188,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>
@@ -202,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>
@@ -216,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>
@@ -226,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>
@@ -237,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; }
-20
View File
@@ -1,20 +0,0 @@
function updateLink() {
console.log("updateLink called");
const linkElement = document.getElementById("appointment_link");
const regex = /((?:<br\/>|%3Cbr\/?%3E))([\s\S]*?)(&dates)/gi;
linkElement.href = linkElement.href.replace(regex, `$1${getSelectedDocs()}$3`);
}
function getSelectedDocs() {
const appointent_extras = document.querySelectorAll('.appointment');
let output = '';
for (const item of appointent_extras) {
if (item.checked) {
console.log(`Checked item: ${item.dataset.text} with URL: ${item.dataset.url}`);
output += `%0A`+ encodeURIComponent(`<a href="${window.location.origin}${item.dataset.url}">${item.dataset.text}</a>`) +`%0A`;
}
}
return output;
}
-5
View File
@@ -1,8 +1,3 @@
/* Keep Redmine default look, just enhance metadata */
.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 {
+217 -28
View File
@@ -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"
@@ -24,14 +29,11 @@ en:
field_invoice: "Invoice"
field_notes: "Notes"
label_account_balance: "Account Balance"
label_actions: "Actions"
label_amount: "Amount"
label_appointment: "Add Appointment"
label_balance_with_jobs: "Balance With Jobs"
label_bill_time: "Bill Time"
label_billing_address: "Billing Address"
label_billing_enqueued: "Billing has been enqueued for issue"
label_billed_success: "Successfully billed "
label_client_id: "Intuit QBO OAuth2 Client ID"
label_client_secret: "Intuit QBO OAuth2 Client Secret"
label_closed_issues: "Closed Issues"
@@ -40,23 +42,17 @@ en:
label_customer_link_expires: "This customer link expires in"
label_customer: "Customer"
label_customers: "Customers"
label_delete: "Delete"
label_deposit_into: "Deposit to Account"
label_details: "Details"
label_display_name: "Display Name"
label_door: "Door"
label_edit: "Edit"
label_edit_customer: "Edit Customer"
label_email: "Email"
label_error: "Error"
label_estimate_404: "Estimate not found"
label_estimate: "Estimate"
label_estimates: "Estimates"
label_hours: "Hours"
label_invoice_404: "Invoice not found"
label_invoices: "Invoices"
label_last_sync: "Last Sync"
label_load_customer: "Load Customer"
label_make: "Make"
label_matching: "Matching"
label_mobile_phone: "Mobile Phone"
@@ -69,13 +65,9 @@ en:
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"
label_oauth_expires: "OAuth2 Access Token Expires At"
label_oauth_note: "Note: You need to authenticate with QuickBooks after saving your key and secret above."
label_open_issues: "Open Issues"
label_primary_phone: "Primary Phone"
label_qbo_sync_success: "Successfully synced to QuickBooks"
label_redmine_qbo: "Redmine QuickBooks"
label_sandbox: "Sandbox"
label_search: "Search"
label_search_customers: "Search Customers"
@@ -92,23 +84,11 @@ en:
notice_billing_error_no_customer: "Cannot bill without an assigned customer."
notice_billing_error_no_employee: "Cannot bill without an assigned employee."
notice_billing_error_no_qbo: "Cannot bill without a QuickBooks connection. Please connect to QuickBooks and try again."
notice_customer_created: "Customer created in QuickBooks"
notice_customer_deleted: "Customer deleted in QuickBooks"
notice_customer_not_deleted: "Customer could not be deleted in QuickBooks"
notice_customer_not_found: "Customer not found in QuickBooks"
notice_customer_updated: "Customer updated in QuickBooks"
notice_error_issue_not_found: "The issue could not be found. Please check the issue and try again."
notice_error_project_nil: "The issue's project is nil. Set project to:"
notice_error_tracker_nil: "The issue's tracker is nil. Set tracker to:"
notice_estimate_created: "Estimate created in QuickBooks"
notice_estimate_not_found: "Estimate not found, we are syncing with QuickBooks to find it. Please check back shortly."
notice_estimate_updated: "Estimate updated in QuickBooks"
notice_forbidden: "You do not have permission to access this resource."
notice_invoice_created: "Invoice created in QuickBooks"
notice_invoice_not_found: "Invoice not found"
notice_invoice_updated: "Invoice updated in QuickBooks"
notice_issue_not_found: "Issue not found"
warn_ru_sure: "Are you sure?"
# ---- Billing: estimates, invoices, payments, items and accounts ----
label_billing_settings: "Billing"
@@ -117,6 +97,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"
@@ -129,8 +112,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"
@@ -149,6 +163,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)"
@@ -200,7 +222,6 @@ en:
label_default_account: "Default Item Income Account"
label_description: "Description"
label_edit_item: "Edit Item"
label_item: "Item"
label_item_new: "New Item"
label_items: "Items"
label_management_and_sync: "Synchronization"
@@ -214,9 +235,7 @@ en:
text_qbo_sync_info: "Sync changes reads what changed in QuickBooks since the last sync; Full sync and each type's Sync re-read every record (e.g. after changing the labor products/services, sync estimates and invoices). Webhooks keep things current in between."
text_default_account_info: "New products/services go in this income account; set it on the Accounts page."
label_never_synced: "Never synced"
label_no: "No"
label_type: "Type"
label_yes: "Yes"
error_default_account_not_selected: "Select an account to make it the default."
notice_default_account_updated: "Default account updated."
@@ -242,6 +261,9 @@ 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_paid_days: "Paid +%{days}d"
text_invoice_paid_in_full: "Paid in full %{date}"
label_invoice_status_partial: "Partially paid"
label_invoice_status_overdue: "Overdue"
label_invoice_status_open: "Open"
@@ -271,6 +293,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"
@@ -292,6 +315,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"
@@ -329,6 +358,15 @@ en:
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)"
@@ -368,3 +406,154 @@ en:
label_activity_payment: "Payment from %{customer}: %{amount}"
text_activity_invoice_owed: "%{amount} owed"
text_activity_payment_unapplied: "%{amount} not applied to an invoice"
# ---- Refunds (SOP-OPS-014) ----
permission_issue_refunds: "Issue refunds"
label_refund: "Refund"
label_refunds: "Refunds"
label_refund_incomplete: "Incomplete"
label_refund_estimate: "Canceled order"
label_refund_no_estimate: "None (customer credit only)"
label_refund_your_order: "your order"
label_refund_parts: "Parts"
label_refund_method: "Refund by"
label_refund_method_check: "Company check"
label_refund_method_card: "Card (on the terminal)"
label_refund_check_number: "Check no."
label_refund_date: "Refund date"
label_refund_reason: "Reason"
label_refund_also: "Also"
label_refund_close_estimate: "Mark the estimate Rejected in QuickBooks"
label_refund_cancel_issues: "Cancel the order's work orders"
label_refund_email_customer: "Email the customer a summary"
label_refund_summary: "Refund"
label_refund_credit_from: "Credit from payment"
label_refund_credit: "Customer credit"
label_refund_fee_rate: "Restocking fee (%{rate}% of parts)"
label_refund_amount: "Refund"
label_refund_fee_invoice: "Invoice #%{number}"
label_refund_open_check: "Check in QuickBooks"
label_refund_open_expense: "Expense in QuickBooks"
label_refund_settings: "Refunds"
label_refund_balance_after: "Customer balance afterwards"
label_refund_recorded_by: "Recorded by"
label_refund_received_by: "Received by (customer signature)"
label_refund_fee_invoice_pdf: "Fee invoice PDF"
label_refund_pdf_fee: "Restocking fee: %{rate}% × %{parts} parts"
label_refund_pdf_work_orders: "Work orders canceled"
label_refund_pdf_estimate: "Estimate"
text_refund_pdf_estimate_rejected: "E%{number} marked Rejected in QuickBooks"
label_restocking_fee_rate: "Restocking fee"
label_restocking_item: "Restocking fee product/service"
label_refund_check_account: "Refund checks from"
label_refund_card_account: "Card refunds from"
label_refund_first_bank_account: "The first bank account"
label_refund_canceled_status: "Canceled work order status"
button_refund: "Refund"
button_refund_email: "Email the customer"
button_refund_email_again: "Email again"
notice_refund_emailed: "Refund summary emailed to %{email}."
notice_refund_done: "Refund of %{amount} recorded in QuickBooks."
error_refund_method: "Choose how the refund is paid: company check or card."
error_refund_check_number: "Enter the check number."
error_refund_reason: "Enter the reason for the refund."
error_refund_parts_amount: "Parts must be an amount of $0.00 or more."
error_refund_estimate_customer: "That estimate is for another customer."
error_refund_no_fee_item: "Pick the restocking fee product/service in the QuickBooks plugin settings (Billing » Refunds)."
error_refund_no_credit: "This customer has no credit (unapplied payments) to refund."
error_refund_fee_over_credit: "The restocking fee (%{fee}) isn't less than the customer's credit (%{credit}), so there's nothing to refund."
error_refund_no_ar_account: "QuickBooks has no Accounts Receivable account."
error_refund_no_bank_account: "QuickBooks has no bank account to record the refund from. Pick one in the plugin settings."
error_refund_fee_not_saved: "QuickBooks didn't save the restocking fee invoice."
error_refund_fee_unpaid: "The customer's credit didn't cover the restocking fee invoice (%{amount} still open)."
error_refund_nothing_left: "No credit is left to refund after the restocking fee."
error_refund_not_saved: "QuickBooks didn't save the refund."
error_refund_step_fee: "The restocking fee invoice couldn't be made or paid from the customer's credit: %{error}. Nothing was refunded. Finish or undo it in QuickBooks."
error_refund_step_refund: "The refund couldn't be recorded in QuickBooks: %{error}. The restocking fee invoice (if any) is made. Record the refund in QuickBooks (Check or Expense, category Accounts Receivable) and apply the customer's credit to it."
text_refund_final_sale: "Custom fabricated assemblies and discontinued or closeout items are final sale. Don't refund them without Shop Manager approval (SOP-OPS-014). No cash refunds: card payments are refunded on the terminal, everything else by company check."
text_refund_no_credit: "This customer has no credit (unapplied payments) to refund."
text_refund_estimate: "The order being canceled. Its parts fill in the restocking fee, and the refund refers to it."
text_refund_parts: "The parts returned or canceled, before tax. The restocking fee is %{rate}% of this; labor carries no fee. Enter 0 to refund without a fee."
text_refund_method: "The way the order was paid: card payments are refunded on the card terminal (a partial refund, of the amount below); cash and check payments by company check."
text_refund_reason: "Goes on the refund in QuickBooks and on the canceled work orders."
text_refund_summary: "The restocking fee invoice is paid from the customer's credit, and the rest is refunded. Refund exactly this amount on the terminal or check."
text_refund_email_confirm: "Email the customer this refund's summary?"
text_refund_confirm: "Make the restocking fee invoice and record the refund in QuickBooks?"
text_refund_no_email: "The customer has no email in QuickBooks."
text_refund_balance: "Done. The customer's QuickBooks balance is now %{balance}."
text_refund_balance_unknown: "Done, but the customer's QuickBooks balance couldn't be read. Check it's $0.00 in QuickBooks."
text_refund_incomplete: "This refund is incomplete. See below which step failed, and finish it in QuickBooks."
text_refund_fee_line: "Restocking fee: %{rate}% × %{parts} parts%{on} = %{fee}"
text_refund_line: "Refund for deposit on E%{number}"
text_refund_line_credit: "Refund of customer credit"
text_refund_line_card: "(card refund on the terminal)"
text_refund_private_note: "Refund made in Redmine (SOP-OPS-014). Reason: %{reason}"
text_refund_issue_note: "Order canceled and refunded: %{reason}. Restocking fee %{fee}, refunded %{refund} by %{method}."
text_refund_issues_not_canceled: "Some work orders couldn't be set to canceled: %{issues}"
text_refund_no_canceled_status: "The work orders weren't canceled: pick the canceled status in the plugin settings."
text_refund_estimate_not_closed: "The estimate couldn't be marked Rejected in QuickBooks: %{error}"
text_refund_email_failed: "The customer wasn't emailed: %{error}"
text_refund_email_off: "Redmine's email delivery is turned off."
text_refund_email_subject: "Your refund from %{shop}: %{amount}"
text_refund_email_greeting: "Hello %{name},"
text_refund_email_intro: "We've processed the refund for %{order}."
text_refund_email_check: "It's being paid by company check (no. %{number})."
text_refund_email_card: "It's been refunded to the card you paid with. It can take a few business days to show on your statement."
text_refund_email_terms: "As in our posted terms, returned and canceled parts carry a restocking fee. Labor that wasn't done isn't charged."
text_restocking_fee_rate: "Of the parts returned or canceled (SOP-OPS-014: 30%)."
text_restocking_item: "The QuickBooks product/service on the restocking fee invoice (e.g. \"Restocking Fee\"). It sets the income account the fee is booked to."
text_refund_check_account: "The bank account refund checks are written from."
text_refund_card_account: "The account card refunds come out of (where card payments are deposited)."
text_refund_canceled_status: "Work orders of a canceled order are set to this status, with the reason as a note."
# Refunds of paid invoices: completed work, billed and paid in full (a QuickBooks Refund Receipt)
label_refund_invoice: "Invoice"
label_refund_invoice_number: "Invoice #%{number}"
label_refund_paid_invoice: "Paid invoice"
label_refund_invoice_lines: "Invoice #%{number} · %{date}"
label_refund_line: "Line"
label_refund_line_billed: "Billed"
label_refund_line_refunded: "Refunded before"
label_refund_line_quantity: "Qty to refund"
label_refund_line_amount: "Amount to refund"
label_refund_labor: "Labor"
label_refund_taxable: "Taxable"
label_refund_charge_fee: "Restocking fee"
label_refund_note_issues: "Note the refund on the invoice's work orders"
label_refund_lines_amount: "Lines refunded"
label_refund_discount: "Invoice discount (its share)"
label_refund_tax_estimate: "Sales tax (estimated)"
label_refund_tax: "Sales tax"
label_refund_fee_on_parts: "Restocking fee on parts"
label_refund_paid_on_invoice: "paid"
label_refund_no_fee: "None"
label_refund_open_receipt: "Refund receipt in QuickBooks"
label_refund_receipt: "Refund receipt"
text_refund_paid_invoice: "Completed work that's billed and paid in full: open its invoice to refund some or all of it (a refund receipt in QuickBooks). The rest of this page refunds customer credit, e.g. a canceled order's deposit."
text_refund_invoice_lines: "Tick the lines to refund. Change the quantity (parts returned) or the amount (a partial refund) as needed; a line can't be refunded for more than was billed, less what earlier refunds took."
text_refund_line_done: "Already refunded"
text_refund_charge_fee: "Charged on the parts refunded only; labor carries no fee. Leave it off when the parts aren't coming back, or there are none."
text_refund_invoice_reason: "Goes on the refund receipt in QuickBooks and on the invoice's work orders."
text_refund_invoice_summary: "QuickBooks works out the sales tax on the refund receipt, so the refund can differ from this estimate by a few cents. The refund's page shows the exact amount to refund on the terminal or check."
text_refund_invoice_confirm: "Record this refund receipt in QuickBooks?"
text_refund_invoice_earlier: "This invoice has been refunded before:"
text_refund_receipt_made: "Done. Refund receipt %{number} is recorded in QuickBooks. Refund exactly the amount below."
text_refund_receipt_number: "No. %{number}"
text_refund_receipt_memo: "Refund for invoice #%{number}"
text_refund_invoice_private_note: "Refund of invoice #%{number} made in Redmine (SOP-OPS-014). Reason: %{reason}"
text_refund_invoice_issue_note: "Refunded %{amount} on invoice #%{number} by %{method}: %{reason}"
text_refund_issues_not_noted: "The refund couldn't be noted on some work orders: %{issues}"
text_refund_email_terms_invoice: "As in our posted terms, returned parts carry a restocking fee."
error_refund_no_invoice: "Pick the invoice to refund."
error_refund_no_lines: "Tick at least one line to refund."
error_refund_line_gone: "A line to refund isn't on the invoice any more. Reload the page."
error_refund_line_quantity: "%{line}: the quantity must be more than 0 and no more than %{quantity}."
error_refund_line_amount: "%{line}: enter an amount to refund of more than $0.00."
error_refund_line_over: "%{line}: no more than %{amount} is left to refund."
error_refund_fee_over_lines: "The restocking fee (%{fee}) isn't less than what's refunded (%{amount})."
error_refund_invoice_customer: "That invoice is for another customer."
error_refund_invoice_not_paid: "Only an invoice that's paid in full can be refunded here. Take or refund the payment in QuickBooks."
error_refund_step_receipt: "The refund receipt couldn't be recorded in QuickBooks: %{error}. Nothing was refunded."
+18 -7
View File
@@ -33,11 +33,7 @@ post 'bill/:id', to: 'qbo#bill', as: :bill
get 'customers/view/:token', to: 'customers#view', as: :view
get 'customers/share/:id', to: 'customers#share', as: :share
#java script routes
get 'filter_estimates_by_customer' => 'customers#filter_estimates_by_customer'
get 'filter_invoices_by_customer' => 'customers#filter_invoices_by_customer'
resources :customers do
resources :customers, except: [:destroy] do
collection do
get :autocomplete
get :sync
@@ -68,8 +64,23 @@ 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
collection do
get :new_invoice
post :create_invoice
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
@@ -88,7 +99,7 @@ resources :items do
end
# QuickBooks income accounts
resources :accounts do
resources :accounts, only: [:index] do
collection do
patch :set_default
get :sync
+31
View File
@@ -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
+55
View File
@@ -0,0 +1,55 @@
#The MIT License (MIT)
#
#Copyright (c) 2026 rick barrette
#
#Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
#
#The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
#
#THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
# Customer refunds (SOP-OPS-014): the restocking fee invoice, the refund check or card refund, and what was
# done in QuickBooks and Redmine, so a refund can be looked up (and finished by hand if a step failed)
class CreateQboRefunds < ActiveRecord::Migration[7.0]
def up
return if table_exists?(:qbo_refunds)
create_table :qbo_refunds do |t|
t.bigint :customer_id, null: false
# The canceled order's estimate, if any
t.bigint :estimate_id
t.string :estimate_number
t.integer :user_id
t.date :txn_date
# check or card
t.string :method, null: false, limit: 10
t.string :check_number
t.text :reason
t.decimal :parts_amount, precision: 15, scale: 2, null: false, default: 0
t.decimal :fee_rate, precision: 6, scale: 2, null: false, default: 0
t.decimal :fee_amount, precision: 15, scale: 2, null: false, default: 0
# The customer's credit before the refund, and what was refunded
t.decimal :credit_amount, precision: 15, scale: 2, null: false, default: 0
t.decimal :refund_amount, precision: 15, scale: 2, null: false, default: 0
# The QuickBooks fee invoice and the refund check or expense
t.string :fee_invoice_id
t.string :fee_invoice_number
t.string :purchase_id
# The customer's QuickBooks balance afterwards
t.decimal :balance_after, precision: 15, scale: 2
t.boolean :estimate_closed, null: false, default: false
# The work orders set to canceled (JSON list of issue ids)
t.text :canceled_issue_ids
t.string :emailed_to
# done, or incomplete (a step failed: message says which)
t.string :status, null: false, default: 'incomplete', limit: 20
t.text :message
t.timestamps
end
add_index :qbo_refunds, :customer_id
end
def down
drop_table :qbo_refunds if table_exists?(:qbo_refunds)
end
end
@@ -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
+17
View File
@@ -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
+39
View File
@@ -0,0 +1,39 @@
#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.
# Refunds of paid invoices (completed, billed and paid-in-full work): a QuickBooks Refund Receipt for the lines
# refunded, with an optional restocking fee, alongside the refunds of customer credit (canceled orders)
class AddInvoiceRefunds < ActiveRecord::Migration[7.0]
def up
# credit: a canceled order's deposit (fee invoice + check/expense); invoice: a paid invoice (refund receipt)
add_column :qbo_refunds, :kind, :string, null: false, default: 'credit', limit: 10 unless column_exists?(:qbo_refunds, :kind)
add_column :qbo_refunds, :invoice_id, :bigint unless column_exists?(:qbo_refunds, :invoice_id)
add_column :qbo_refunds, :invoice_number, :string unless column_exists?(:qbo_refunds, :invoice_number)
# The Refund Receipt's number (its id is purchase_id)
add_column :qbo_refunds, :receipt_number, :string unless column_exists?(:qbo_refunds, :receipt_number)
# The refunded lines before the discount, fee and tax; the invoice discount's share; the tax refunded
add_column :qbo_refunds, :lines_amount, :decimal, precision: 15, scale: 2, null: false, default: 0 unless column_exists?(:qbo_refunds, :lines_amount)
add_column :qbo_refunds, :discount_amount, :decimal, precision: 15, scale: 2, null: false, default: 0 unless column_exists?(:qbo_refunds, :discount_amount)
add_column :qbo_refunds, :tax_amount, :decimal, precision: 15, scale: 2, null: false, default: 0 unless column_exists?(:qbo_refunds, :tax_amount)
# The lines refunded (JSON: key, description, quantity, amount, parts), so a line isn't refunded twice
add_column :qbo_refunds, :refunded_lines, :text unless column_exists?(:qbo_refunds, :refunded_lines)
# The work orders the refund was noted on (JSON list of issue ids)
add_column :qbo_refunds, :noted_issue_ids, :text unless column_exists?(:qbo_refunds, :noted_issue_ids)
add_index :qbo_refunds, :invoice_id unless index_exists?(:qbo_refunds, :invoice_id)
end
def down
remove_index :qbo_refunds, :invoice_id if index_exists?(:qbo_refunds, :invoice_id)
%i[kind invoice_id invoice_number receipt_number lines_amount discount_amount tax_amount refunded_lines
noted_issue_ids].each do |column|
remove_column :qbo_refunds, column if column_exists?(:qbo_refunds, column)
end
end
end
+14 -7
View File
@@ -14,7 +14,7 @@ Redmine::Plugin.register :redmine_qbo do
name 'Redmine QBO plugin'
author 'Rick Barrette'
description 'A pluging for Redmine to connect with QuickBooks Online: customers, time activities for billable hours when an issue is closed, and estimates, invoices and payments written in Redmine'
version '2026.11.11'
version '2026.11.24'
url 'https://github.com/rickbarrette/redmine_qbo'
author_url 'https://barrettefabrication.com'
settings default: {empty: true}, partial: 'qbo/settings'
@@ -28,9 +28,8 @@ Redmine::Plugin.register :redmine_qbo do
TimeEntry.safe_attributes :billed
# Global Permissions
# autocomplete and the filter_* actions feed the customer, estimate and invoice pickers on issue forms
permission :view_customers, { customers: [:index, :show, :autocomplete,
:filter_estimates_by_customer, :filter_invoices_by_customer] }, global: true
# autocomplete feeds the customer pickers (issue forms, estimates, invoices, payments)
permission :view_customers, { customers: [:index, :show, :autocomplete] }, global: true
permission :add_customers, { customers: [:new, :create] }, global: true
permission :edit_customers, { customers: [:edit, :update] }, global: true
permission :share_issues_with_customers, { customers: [:share] }, global: true
@@ -40,15 +39,23 @@ 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, returned parts and paid invoices (SOP-OPS-014): restocking fee, refund check
# or card refund
permission :issue_refunds, { qbo_refunds: [:new, :create, :new_invoice, :create_invoice, :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)
@@ -16,7 +16,6 @@ module RedmineQbo
# Load the javascript to support the autocomplete forms
def view_layouts_base_html_head(context = {})
safe_join([
javascript_include_tag( 'application.js', plugin: :redmine_qbo),
javascript_include_tag( 'autocomplete.js', plugin: :redmine_qbo),
javascript_include_tag( 'checkbox_controller.js', plugin: :redmine_qbo),
stylesheet_link_tag( 'autocomplete', plugin: :redmine_qbo)
-1
View File
@@ -15,7 +15,6 @@ module RedmineQbo
prepended do
belongs_to :customer
belongs_to :customer_token
belongs_to :estimate
has_and_belongs_to_many :invoices
+3
View File
@@ -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"
+12
View File
@@ -83,6 +83,11 @@ module RedmineQboBilling
user.allowed_to?(:receive_payments, nil, global: true)
end
# True when the user may refund customers' credit (SOP-OPS-014)
def self.refunder?(user = User.current)
user.allowed_to?(:issue_refunds, nil, global: true)
end
# True when the user may see customer payments (receiving them includes seeing them)
def self.payment_viewer?(user = User.current)
user.allowed_to?(:view_payments, nil, global: true) || payment_receiver?(user)
@@ -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)
+72 -25
View File
@@ -12,7 +12,9 @@
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
@@ -24,8 +26,9 @@ module RedmineQboBilling
# 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 payments].freeze
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, :project_ids
@@ -54,8 +57,9 @@ 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]] }
# 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.
@@ -150,13 +154,45 @@ module RedmineQboBilling
@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: }
@@ -193,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])
}
@@ -208,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] }
@@ -218,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)
@@ -229,27 +269,33 @@ 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
# { 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).index_with { |_| Array.new(bucket_list.size, 0.0) }
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
columns = {
estimates: [:estimates, 1], invoices: [:invoices, 1], payments: [:payments, 1],
estimate_hours: [:estimates, 2], issue_hours: [:issues, 1], invoice_hours: [:invoices, 2], spent_hours: [:time_entries, 1]
}
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] += MONEY.include?(key) ? to_d(row[col]).to_f : row[col].to_f
sums[key][i] += row[col].to_f
end
end
sums.transform_values { |values| values.map { |v| v.round(2) } }
@@ -266,8 +312,9 @@ module RedmineQboBilling
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: issues.pluck(:created_on, :estimated_hours).map { |t, h| [t.in_time_zone.to_date, h] },
time_entries: time_entries.pluck(:spent_on, :hours)
+32 -3
View File
@@ -24,6 +24,8 @@ module RedmineQboBilling
MISSING_FIELD_CACHE_TIME = 5.minutes
# Recent estimates also show which custom fields exist, for companies whose preferences don't list them
RECENT_ESTIMATES = 20
# QuickBooks' legacy sales form custom fields; its newer custom fields have larger DefinitionIds
LEGACY_FIELD_IDS = (1..3).freeze
# The sales person field is found loosely, e.g. "Sales Person", "Salesperson", "Sales Rep"
SALES_PERSON_NAME = /sales|\brep\b/i
@@ -32,11 +34,26 @@ module RedmineQboBilling
module_function
# All enabled sales form custom fields, in QuickBooks' order
# The sales form custom fields the plugin uses, in QuickBooks' order: all those found, except the ones
# hidden in the plugin settings. Everything else (the editor, the sales person, other plugins' VIN and
# mileage) goes through here, so a hidden field is never shown or filled in.
def custom_fields
hidden = hidden_field_ids
all_custom_fields.reject { |f| hidden.include?(f.id.to_i) }
end
# Every custom field found, hidden ones included (listed on the plugin settings page)
def all_custom_fields
Array(settings[:custom_fields]).map { |f| Field.new(f[:id], f[:name]) }
end
# Fields hidden in the plugin settings. QuickBooks doesn't tell apps which custom fields are inactive,
# and a field stays on its old estimates after it's turned off (e.g. a renamed "Sales Rep old"), so the
# plugin can't leave those out by itself.
def hidden_field_ids
Array((Setting.plugin_redmine_qbo || {})['hidden_custom_field_ids']).map(&:to_i).reject(&:zero?)
end
# The first enabled custom field whose name matches, e.g. a plugin's VIN field (/\bvin\b/i), or nil
def custom_field_matching(pattern)
custom_fields.detect { |f| f.name.to_s =~ pattern }
@@ -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
+50 -2
View File
@@ -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}"
+60 -13
View File
@@ -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
@@ -0,0 +1,97 @@
#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 invoice page posts: the paid invoice, the lines refunded (each with its quantity and
# amount), whether a restocking fee is charged on the parts among them, how the money goes back (card terminal
# or company check), and what else to do.
class InvoiceRefundForm
include ActiveModel::Model
include ActiveModel::Validations
ATTRIBUTES = %i[customer_id invoice_id txn_date method check_number reason charge_fee note_issues
email_customer].freeze
FLAGS = %i[charge_fee note_issues email_customer].freeze
# One invoice line as posted: refund ticked, the quantity and the amount refunded
LineChoice = Struct.new(:refund, :quantity, :amount, keyword_init: true) do
def refund?
refund.to_s == '1' || refund == true
end
def quantity_value
quantity.blank? ? nil : EstimateForm.decimal(quantity)
end
def amount_value
amount.blank? ? nil : EstimateForm.decimal(amount)
end
end
attr_accessor(*ATTRIBUTES)
# { line key => LineChoice }
attr_writer :lines
validate :validate_refund
# params: the refund's permitted params, lines as { key => { refund:, quantity:, amount: } }
def self.from_params(params)
params = params.to_h.stringify_keys
form = new(ATTRIBUTES.to_h { |attr| [attr, params[attr.to_s].to_s.strip] })
form.lines = (params['lines'] || {}).to_h.to_h do |key, line|
line = line.to_h.stringify_keys
[key.to_s, LineChoice.new(refund: line['refund'].to_s, quantity: line['quantity'].to_s.strip,
amount: line['amount'].to_s.strip.delete('$,'))]
end
form
end
def self.permitted
ATTRIBUTES + [{ lines: {} }]
end
def lines
@lines ||= {}
end
def line(key)
lines[key.to_s]
end
def chosen
lines.select { |_, line| line.refund? }
end
def txn_date_value
EstimateForm.date(txn_date)
end
def check?
method == 'check'
end
FLAGS.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_no_invoice)) if invoice_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?
errors.add(:base, I18n.t(:error_estimate_field_invalid, field: I18n.t(:label_refund_date))) if txn_date_value.nil?
errors.add(:base, I18n.t(:error_refund_no_lines)) if chosen.empty?
end
end
end
@@ -0,0 +1,348 @@
#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
# Refunds of completed work: an invoice that's billed and paid in full (SOP-OPS-014 for the restocking fee).
# QuickBooks' way to refund a paid sale is a Refund Receipt, which this makes:
#
# * the invoice lines refunded (all or part of each), with their product/service and tax code, so the income
# and the sales tax come back off the books the way they went on (QuickBooks works out the tax);
# * the invoice's discount, if it had one, in proportion to what's refunded;
# * the restocking fee, when it's charged, as a negative line with the restocking fee product/service:
# its rate (plugin setting) of the parts refunded. Labor carries no fee, and work with no parts has none;
# * paid out of the refund check or card refund bank account in the settings, by company check (its number)
# or a refund on the card terminal.
#
# The invoice itself stays as it is, paid. Each refund is recorded (QboRefund, kind invoice) with the lines it
# refunded, so a line can't be refunded for more than it was billed across several refunds. Then, as asked on
# the page, the refund is noted on the invoice's work orders and the customer is emailed a summary.
module InvoiceRefundWriter
Error = RefundWriter::Error
# An invoice line that can be refunded, with what earlier refunds already took of it
Line = Struct.new(:key, :item_id, :item_name, :description, :quantity, :rate, :amount, :taxable, :parts,
:refunded_quantity, :refunded_amount, keyword_init: true) do
def remaining_amount
[amount - refunded_amount, BigDecimal('0')].max
end
def remaining_quantity
quantity && [quantity - refunded_quantity, BigDecimal('0')].max
end
def refundable?
remaining_amount.positive?
end
def label
[item_name.presence, description.presence].compact.uniq.join(' · ')
end
end
# A line being refunded: the invoice line, the quantity (nil when only an amount is refunded) and the amount
Refunding = Struct.new(:line, :quantity, :amount, keyword_init: true)
# What a refund comes to: the lines, the invoice discount's share, the fee, the tax (estimated before
# QuickBooks works it out) and the refund
Plan = Struct.new(:refunding, :lines_amount, :parts_amount, :discount_rate, :discount, :fee_rate, :fee,
:tax_rate, :tax, :refund, keyword_init: true)
module_function
def settings
RefundWriter.settings
end
# Billed and paid in full: a total, and nothing left owing
def paid_in_full?(remote)
total = BigDecimal(remote&.total.to_s.presence || '0')
balance = BigDecimal(remote&.balance.to_s.presence || '0')
total.positive? && balance <= 0
end
# The customer's paid invoices to pick from on the Refund page, newest first: [[label, id], ...]
def invoice_choices(customer)
Invoice.where(customer_id: customer.id).where('balance <= 0 AND total_amount > 0')
.order(txn_date: :desc, id: :desc).limit(50).map do |invoice|
["##{invoice.doc_number} · #{invoice.txn_date} · #{RefundWriter.money(invoice.total_amount)}", invoice.id.to_s]
end
end
# The invoice's lines that can be refunded (bundles opened up into their lines), with what this invoice's
# earlier refunds took of each
def lines(remote, refunds: QboRefund.of_invoice(remote.id))
taken = Hash.new { |hash, key| hash[key] = [BigDecimal('0'), BigDecimal('0')] }
refunds.each do |refund|
refund.refunded_lines.each do |line|
taken[line.key][0] += BigDecimal(line.quantity.to_s.presence || '0')
taken[line.key][1] += line.amount.to_d
end
end
labor_ids = LaborItems.ids
sales_lines(Array(remote.line_items)).filter_map do |line, key|
detail = RefundWriter.sales_detail(line)
amount = BigDecimal(line.amount.to_s.presence || '0')
next unless amount.positive?
ref = detail&.item_ref
quantity = detail&.quantity.nil? ? nil : BigDecimal(detail.quantity.to_s)
quantity = nil unless quantity&.positive?
Line.new(key: key, item_id: ref&.value.to_s.presence, item_name: ref&.name.to_s, description: line.description.to_s,
quantity: quantity, rate: detail&.unit_price.nil? ? nil : BigDecimal(detail.unit_price.to_s),
amount: amount, taxable: detail&.tax_code_ref&.value.to_s == 'TAX',
parts: ref.present? && ref.value.present? && !LaborItems.match?(ref, ids: labor_ids),
refunded_quantity: taken[key][0], refunded_amount: taken[key][1])
end
end
# The sales lines with a key for each: its QuickBooks line id, or for a line in a bundle the bundle's id and
# its place in it
def sales_lines(lines, prefix = nil)
lines.each_with_index.flat_map do |line, index|
key = "#{prefix}#{line.id.presence || index + 1}"
if line.respond_to?(:group_line_detail) && line.group_line_detail
sales_lines(Array(line.group_line_detail.line_items), "#{key}.")
elsif RefundWriter.sales_detail(line)
[[line, key]]
else
[]
end
end
end
# The invoice's discount, as a share of its lines (0.1 for 10% off)
def discount_rate(remote)
discount = EstimateWriter.discount_total(remote).to_d
subtotal = sales_lines(Array(remote.line_items)).sum(BigDecimal('0')) { |line, _| BigDecimal(line.amount.to_s.presence || '0') }
return BigDecimal('0') unless discount.positive? && subtotal.positive?
[discount / subtotal, BigDecimal('1')].min
end
# The invoice's sales tax, as a share of its taxable lines after the discount, to estimate the tax refunded
def tax_rate(remote, invoice_lines = lines(remote, refunds: []))
tax = BigDecimal(remote.txn_tax_detail&.total_tax.to_s.presence || '0')
taxable = invoice_lines.select(&:taxable).sum(BigDecimal('0'), &:amount) * (1 - discount_rate(remote))
tax.positive? && taxable.positive? ? tax / taxable : BigDecimal('0')
end
# Works out the refund from the form's lines: [plan, errors]
def plan(remote, form, invoice_lines: lines(remote))
errors = []
by_key = invoice_lines.index_by(&:key)
refunding = form.chosen.filter_map do |key, choice|
line = by_key[key]
if line.nil?
errors << I18n.t(:error_refund_line_gone)
next
end
refunding_line(line, choice, errors)
end
lines_amount = refunding.sum(BigDecimal('0'), &:amount)
parts = refunding.select { |r| r.line.parts }.sum(BigDecimal('0'), &:amount)
rate = discount_rate(remote)
discount = (lines_amount * rate).round(2, BigDecimal::ROUND_HALF_UP)
fee_rate = RefundWriter.fee_rate
fee = form.charge_fee? ? RefundWriter.fee(parts, fee_rate) : BigDecimal('0')
tax_rate = tax_rate(remote, invoice_lines)
taxable = refunding.select { |r| r.line.taxable }.sum(BigDecimal('0'), &:amount) * (1 - rate)
tax = (taxable * tax_rate).round(2, BigDecimal::ROUND_HALF_UP)
refund = lines_amount - discount + tax - fee
if refunding.any? && fee >= lines_amount - discount
errors << I18n.t(:error_refund_fee_over_lines, fee: RefundWriter.money(fee), amount: RefundWriter.money(lines_amount - discount))
end
plan = Plan.new(refunding: refunding, lines_amount: lines_amount, parts_amount: parts, discount_rate: rate,
discount: discount, fee_rate: fee_rate, fee: fee, tax_rate: tax_rate, tax: tax,
refund: [refund, BigDecimal('0')].max)
[plan, errors.uniq]
end
# A line being refunded, from what was posted for it: the quantity and the amount (by default the quantity
# at the line's rate, or what's left of the line). Adds to errors when it can't be refunded.
def refunding_line(line, choice, errors)
name = line.label.presence || line.key
quantity = choice.quantity_value
quantity = nil if line.quantity.nil? || line.rate.nil?
amount = choice.amount_value
amount ||= quantity ? (quantity * line.rate).round(2) : line.remaining_amount
if quantity && (quantity <= 0 || quantity > line.remaining_quantity)
errors << I18n.t(:error_refund_line_quantity, line: name, quantity: RefundWriter.plain(line.remaining_quantity))
return nil
end
if amount.nil? || amount <= 0
errors << I18n.t(:error_refund_line_amount, line: name)
return nil
end
if amount > line.remaining_amount
errors << I18n.t(:error_refund_line_over, line: name, amount: RefundWriter.money(line.remaining_amount))
return nil
end
# A partial amount (not the quantity at the line's rate) is refunded as an amount alone, so it doesn't
# use up the line's quantity
quantity = nil if quantity && (quantity * line.rate).round(2) != amount
Refunding.new(line: line, quantity: quantity, amount: amount)
end
# The quantity to offer for a line: what's left of it, when that's what's left of its amount at its rate
def default_quantity(line)
quantity = line.remaining_quantity
return nil unless quantity&.positive? && line.rate
(quantity * line.rate).round(2) == line.remaining_amount ? quantity : nil
end
# Makes the refund receipt; returns the QboRefund (done, or incomplete with why 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
remote = gateway.invoice(form.invoice_id)
raise Error, I18n.t(:notice_invoice_not_found) unless remote
raise Error, I18n.t(:error_refund_invoice_customer) unless remote.customer_ref&.value.to_s == customer.id.to_s
raise Error, I18n.t(:error_refund_invoice_not_paid) unless paid_in_full?(remote)
plan, errors = plan(remote, form)
raise Error, errors.join(' ') if errors.any?
raise Error, I18n.t(:error_refund_no_lines) if plan.refunding.empty?
item = RefundWriter.fee_item
raise Error, I18n.t(:error_refund_no_fee_item) if plan.fee.positive? && item.nil?
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
paid = BigDecimal(remote.total.to_s) - BigDecimal(remote.balance.to_s.presence || '0')
record = QboRefund.create!(kind: 'invoice', customer_id: customer.id, invoice_id: remote.id,
invoice_number: remote.doc_number.to_s, user: user, txn_date: form.txn_date_value,
method: form.method, check_number: form.check? ? form.check_number : nil,
reason: form.reason, lines_amount: plan.lines_amount, discount_amount: plan.discount,
parts_amount: plan.parts_amount, fee_rate: plan.fee_rate, fee_amount: plan.fee,
tax_amount: plan.tax, credit_amount: paid, refund_amount: plan.refund,
refunded_lines: refunded_lines(plan), status: 'incomplete')
made = RefundWriter.step(record, :receipt) do
receipt = build_receipt(record, remote, plan, form, item, bank_account, gateway)
saved = gateway.create_refund_receipt(receipt)
raise Error, I18n.t(:error_refund_not_saved) unless saved&.id
tax = saved.txn_tax_detail&.total_tax
record.update!(purchase_id: saved.id.to_s, receipt_number: saved.doc_number.to_s,
refund_amount: saved.total.nil? ? plan.refund : BigDecimal(saved.total.to_s),
tax_amount: tax.nil? ? plan.tax : BigDecimal(tax.to_s))
end
return record unless made
warnings = []
warnings << note_issues(record, user) if form.note_issues?
warnings << RefundWriter.email_customer(record, customer, mailer) if form.email_customer?
record.update!(status: 'done', message: warnings.compact.join("\n").presence)
record
end
def refunded_lines(plan)
plan.refunding.map do |r|
QboRefund::RefundedLine.new(key: r.line.key, description: r.line.label, quantity: r.quantity,
amount: r.amount, parts: r.line.parts)
end
end
# The QuickBooks Refund Receipt: the lines refunded, the discount's share, the restocking fee
def build_receipt(record, remote, plan, form, fee_item, bank_account, gateway)
receipt = Quickbooks::Model::RefundReceipt.new
receipt.customer_ref = Quickbooks::Model::BaseReference.new(record.customer_id.to_s)
receipt.txn_date = record.txn_date
receipt.deposit_to_account_ref = Quickbooks::Model::BaseReference.new(bank_account.to_s)
method_id = gateway.payment_method_id(form.check? ? :check : :card)
receipt.payment_method_ref = Quickbooks::Model::BaseReference.new(method_id) if method_id
receipt.payment_ref_number = record.check_number if form.check?
receipt.bill_email = remote.bill_email if remote.bill_email&.address.present?
receipt.customer_memo = I18n.t(:text_refund_receipt_memo, number: record.invoice_number)
receipt.private_note = I18n.t(:text_refund_invoice_private_note, number: record.invoice_number, reason: record.reason)
receipt.apply_tax_after_discount = true if plan.discount.positive?
lines = plan.refunding.map { |r| receipt_line(r) }
lines << discount_line(plan) if plan.discount.positive?
lines << fee_line(record, fee_item) if plan.fee.positive?
lines.each_with_index { |line, index| line.line_num = index + 1 }
receipt.line_items = lines
receipt
end
# A refunded line: the invoice line's product/service and tax code. Its quantity and rate go with it when
# the amount is that quantity at the line's rate (refunding_line); a partial amount goes as an amount alone.
def receipt_line(refunding)
line = refunding.line
remote = Quickbooks::Model::Line.new
remote.description = line.description
remote.amount = refunding.amount
remote.sales_item! do |detail|
detail.item_ref = Quickbooks::Model::BaseReference.new(line.item_id) if line.item_id
if refunding.quantity
detail.quantity = refunding.quantity
detail.unit_price = line.rate
end
detail.tax_code_ref = Quickbooks::Model::BaseReference.new(line.taxable ? 'TAX' : 'NON')
end
remote
end
def discount_line(plan)
remote = Quickbooks::Model::Line.new
remote.amount = plan.discount
remote.discount! { |detail| detail.percent_based = false }
remote
end
# The restocking fee, kept back: a negative line, so the fee is income and the refund is less by it
def fee_line(record, item)
remote = Quickbooks::Model::Line.new
remote.amount = -record.fee_amount
remote.description = RefundWriter.fee_description(record.parts_amount, record.fee_rate, record.fee_amount,
nil, on: record.document_label)
remote.sales_item! do |detail|
detail.item_id = item.id
detail.quantity = 1
detail.unit_price = -record.fee_amount
detail.tax_code_ref = Quickbooks::Model::BaseReference.new('NON')
end
remote
end
# Notes the refund on the invoice's work orders (their status is left alone); returns a warning, or nil
def note_issues(record, user)
issues = Invoice.find_by(id: record.invoice_id)&.issues.to_a
return nil if issues.empty?
note = I18n.t(:text_refund_invoice_issue_note, amount: RefundWriter.money(record.refund_amount),
number: record.invoice_number, method: record.method_name,
reason: record.reason)
failed = []
noted = issues.filter_map do |issue|
issue.init_journal(user, note)
if issue.save
issue.id
else
failed << "##{issue.id} (#{issue.errors.full_messages.join(', ')})"
nil
end
end
record.update!(noted_issue_ids: noted)
failed.any? ? I18n.t(:text_refund_issues_not_noted, issues: failed.join('; ')) : nil
end
end
end
+26 -2
View File
@@ -34,8 +34,32 @@ 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
# The invoice list's short badge: "Paid", or "Paid +3d" when it was paid in full 3 days after its date
def short_label(status, paid_on: nil, invoice_date: nil)
days = days_to_pay(invoice_date, paid_on) if status == :paid
return I18n.t(:label_invoice_status_paid_days, days: days) if days&.positive?
label(status)
end
# The badge's tooltip: "Paid in full 11/19/2025" (nil unless it's paid with a known day)
def title(status, paid_on: nil)
I18n.t(:text_invoice_paid_in_full, date: I18n.l(paid_on)) if status == :paid && paid_on
end
# Days from the invoice's date to the day it was paid in full
def days_to_pay(invoice_date, paid_on)
return nil unless invoice_date && paid_on
(paid_on.to_date - invoice_date.to_date).to_i
end
def to_d(value)
+56 -6
View File
@@ -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)
+11 -3
View File
@@ -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 ||= []
+124 -28
View File
@@ -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|
+59
View File
@@ -0,0 +1,59 @@
#The MIT License (MIT)
#
#Copyright (c) 2026 rick barrette
#
#Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
#
#The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
#
#THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
module RedmineQboBilling
# What the Refund page posts (SOP-OPS-014): the canceled order's estimate, the parts the restocking fee is
# worked out on, how the money goes back (card terminal or company check), and what else to do in
# QuickBooks and Redmine.
class RefundForm
include ActiveModel::Model
include ActiveModel::Validations
ATTRIBUTES = %i[customer_id estimate_id txn_date parts_amount method check_number reason
close_estimate cancel_issues email_customer].freeze
attr_accessor(*ATTRIBUTES)
validate :validate_refund
def self.from_params(params)
params = params.to_h.stringify_keys
new(ATTRIBUTES.to_h { |attr| [attr, params[attr.to_s].to_s.strip] })
end
def parts_value
parts_amount.blank? ? BigDecimal('0') : EstimateForm.decimal(parts_amount)
end
def txn_date_value
EstimateForm.date(txn_date)
end
def check?
method == 'check'
end
%i[close_estimate cancel_issues email_customer].each do |flag|
define_method(:"#{flag}?") { send(flag).to_s == '1' || send(flag) == true }
end
private
def validate_refund
errors.add(:base, I18n.t(:error_estimate_needs_customer)) if customer_id.blank?
errors.add(:base, I18n.t(:error_refund_method)) unless QboRefund::METHODS.include?(method)
errors.add(:base, I18n.t(:error_refund_check_number)) if check? && check_number.blank?
errors.add(:base, I18n.t(:error_refund_reason)) if reason.blank?
value = parts_value
errors.add(:base, I18n.t(:error_refund_parts_amount)) if value.nil? || value.negative?
errors.add(:base, I18n.t(:error_estimate_field_invalid, field: I18n.t(:label_refund_date))) if txn_date_value.nil?
end
end
end
+140
View File
@@ -0,0 +1,140 @@
#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
# A paid invoice's refund (InvoiceRefundWriter)
def create_refund_receipt(receipt)
with_service('RefundReceipt') { |service| service.create(receipt) }
end
PAYMENT_METHOD_NAMES = { check: /\b(check|cheque)\b/i, card: /card|visa|mastercard|amex|discover/i }.freeze
# QuickBooks' payment method for a refund by :check or :card (the first whose name fits), or nil
def payment_method_id(kind)
pattern = PAYMENT_METHOD_NAMES[kind]
PaymentWriter.payment_methods.detect { |name, _| name.match?(pattern) }&.last
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
+141
View File
@@ -0,0 +1,141 @@
#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)],
@refund.invoice? ? [l(:label_refund_invoice), @refund.document_label] :
[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
if @refund.invoice?
invoice_lines(pdf)
else
money_row(pdf, l(:label_refund_credit), @refund.credit_amount)
end
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
# A paid invoice's refund: each line refunded, the discount's share and the sales tax
def invoice_lines(pdf)
@refund.refunded_lines.each do |line|
quantity = line.quantity.present? ? " (#{RefundWriter.plain(BigDecimal(line.quantity.to_s))})" : ''
money_row(pdf, "#{line.description.truncate(90)}#{quantity}", line.amount)
end
money_row(pdf, l(:label_refund_discount), -@refund.discount_amount.to_d) if @refund.discount_amount.to_d.positive?
money_row(pdf, l(:label_refund_tax), @refund.tax_amount)
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?
if @refund.invoice? && @refund.receipt_number.present?
row(pdf, l(:label_refund_receipt), l(:text_refund_receipt_number, number: @refund.receipt_number))
end
row(pdf, l(:label_refund_recorded_by), "#{@refund.user&.name} · #{format_time(@refund.created_at)}")
row(pdf, l(:label_refund_incomplete), @refund.message.to_s) unless @refund.done?
end
# For a refund check: the customer signs for it
def signature(pdf)
pdf.ln(14)
pdf.SetFontStyle('', 10)
pdf.RDMCell(110, 6, l(:label_refund_received_by), 'T', 0)
pdf.RDMCell(10, 6, '', 0, 0)
pdf.RDMCell(70, 6, l(:label_date), 'T', 1)
end
def method_text
@refund.check? ? "#{@refund.method_name} ##{@refund.check_number}" : @refund.method_name
end
def row(pdf, label, value)
pdf.SetFontStyle('B', 10)
pdf.RDMCell(50, 6, label.to_s, 0, 0)
pdf.SetFontStyle('', 10)
pdf.RDMMultiCell(WIDTH - 50, 6, value.to_s)
end
def money_row(pdf, label, amount, border: 0)
pdf.RDMCell(WIDTH - 40, 7, label.to_s, border, 0)
pdf.RDMCell(40, 7, RefundWriter.money(amount), border, 1, 'R')
end
def shop_name
reminders = defined?(RedmineQboReminders::Settings) ? RedmineQboReminders::Settings.current : nil
reminders&.[]('shop_name').to_s.presence || Setting.app_title
rescue StandardError
Setting.app_title
end
end
end
+329
View File
@@ -0,0 +1,329 @@
#The MIT License (MIT)
#
#Copyright (c) 2026 rick barrette
#
#Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
#
#The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
#
#THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
module RedmineQboBilling
# Customer refunds for canceled orders and returned parts (SOP-OPS-014), the way the SOP does them in QuickBooks:
#
# 1. A restocking fee invoice for 30% of the parts (labor carries no fee), its line showing the math, paid
# from the customer's credit (their deposit), oldest first.
# 2. The rest of the customer's credit is refunded: a company check, or a partial refund on the card terminal.
# 3. The refund is recorded in QuickBooks with the category Accounts Receivable, from the bank account in the
# settings, described "Refund for deposit on E1234": a Check for a check, an Expense for a card refund.
# 4. The credit left on the customer's payments is applied to that check or expense, so the deposit, the fee
# invoice and the refund reconcile and the customer's balance comes back to $0.00.
#
# Then, as asked on the page: the canceled order's estimate is marked Rejected in QuickBooks, its work orders are
# set to the canceled status with the reason as a note, and the customer is emailed a summary.
#
# Each refund is recorded (QboRefund). Steps 1 to 4 stop at the first failure, and the record says which step
# failed and what was already done, so it can be finished in QuickBooks. The later steps only add warnings.
module RefundWriter
class Error < StandardError; end
Credit = Struct.new(:payment_id, :date, :reference, :memo, :amount, keyword_init: true)
Preview = Struct.new(:credits, :credit_total, :parts_amount, :fee_rate, :fee, :refund, keyword_init: true)
CLOSED_ESTIMATE_STATUSES = %w[Closed Converted Rejected].freeze
CANCELED_STATUS_NAMES = %w[Canceled Cancelled].freeze
module_function
def settings
Setting.plugin_redmine_qbo || {}
rescue StandardError
{}
end
# The restocking fee rate in percent (plugin setting, SOP-OPS-014: 30)
def fee_rate
rate = BigDecimal(settings['restocking_fee_rate'].to_s.strip, exception: false)
rate.nil? || rate.negative? ? BigDecimal('30') : rate
end
# The product/service on the restocking fee invoice (plugin setting)
def fee_item
Item.find_by(id: settings['restocking_item_id']) if settings['restocking_item_id'].present?
end
def fee(parts, rate = fee_rate)
(parts.to_d * rate.to_d / 100).round(2, BigDecimal::ROUND_HALF_UP)
end
# The parts on an estimate: its lines that aren't labor (with the lines inside bundles), before tax
def parts_amount(estimate)
labor_ids = LaborItems.ids
parts_lines(Array(estimate&.line_items), labor_ids).sum(BigDecimal('0')) { |line| BigDecimal(line.amount.to_s.presence || '0') }
end
def parts_lines(lines, labor_ids)
lines.flat_map do |line|
if line.respond_to?(:group_line_detail) && line.group_line_detail
parts_lines(Array(line.group_line_detail.line_items), labor_ids)
elsif (ref = sales_detail(line)&.item_ref) && ref.value.present?
LaborItems.match?(ref, ids: labor_ids) ? [] : [line]
else
[]
end
end
end
# A sales line's detail: estimates and invoices name it SalesLineItemDetail (InvoiceLineItem), other
# transactions SalesItemLineDetail (Line)
def sales_detail(line)
if line.respond_to?(:sales_line_item_detail) then line.sales_line_item_detail
elsif line.respond_to?(:sales_item_line_detail) then line.sales_item_line_detail
end
end
# The customer's credit: their payments' unapplied money, oldest first
def credits(customer, gateway: RefundGateway.new)
gateway.unapplied_payments(customer.id).map do |payment|
Credit.new(payment_id: payment.id.to_s, date: payment.txn_date, reference: payment.payment_ref_number.to_s,
memo: payment.private_note.to_s, amount: BigDecimal(payment.unapplied_amount.to_s))
end
end
# The customer's estimates to pick the canceled order from, newest first: [[label, id], ...]
def estimate_choices(customer)
Estimate.where(customer_id: customer.id).order(txn_date: :desc, id: :desc).limit(50).map do |estimate|
total = estimate.respond_to?(:total_amount) && estimate.total_amount ? " · $#{format('%.2f', estimate.total_amount)}" : ''
["E#{estimate.doc_number} · #{estimate.txn_date}#{total}", estimate.id.to_s]
end
end
# What the page shows before the refund is made: the credit, the fee and what will be refunded
def preview(customer, parts:, gateway: RefundGateway.new)
list = credits(customer, gateway: gateway)
total = list.sum(BigDecimal('0'), &:amount)
rate = fee_rate
amount = fee(parts, rate)
Preview.new(credits: list, credit_total: total, parts_amount: parts.to_d, fee_rate: rate, fee: amount,
refund: [total - amount, BigDecimal('0')].max)
end
# "Restocking fee: 30% × $1,026.63 parts on E1068 = $308.00" (on: what the parts are on instead, e.g. "Invoice #1234")
def fee_description(parts, rate, amount, estimate_number, on: nil)
on = on.present? ? " on #{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
+5
View File
@@ -21,4 +21,9 @@ namespace :redmine_qbo do
puts "Checked #{estimates.size} estimate(s), created #{total} relation(s)."
end
desc "Delete customer share links that have expired or whose issue was deleted (also done whenever a link is made)"
task purge_customer_tokens: :environment do
puts "Deleted #{CustomerToken.purge_expired} customer share link(s)."
end
end
+194
View File
@@ -0,0 +1,194 @@
#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
# ---- Paid invoices ----
def invoice_setup
RedmineQboBilling::LaborItems.stubs(:ids).returns([])
@gateway.invoices << paid_invoice
end
def test_invoice_refund_page
invoice_setup
log_user('admin', 'admin')
get '/qbo_refunds/new_invoice?invoice_id=950'
assert_response :success
assert_select 'h2', text: /Invoice #1234/
assert_select 'input[type=checkbox][name=?][checked]', 'refund[lines][2][refund]'
assert_select 'input[name=?][value=?]', 'refund[lines][2][quantity]', '4'
assert_select 'input[name=?][value=?]', 'refund[lines][3][amount]', '80.00'
assert_select 'input[name=?][checked]', 'refund[charge_fee]'
# Everything ticked: $440.00 of lines, $14.00 tax, 30% of $200.00 parts
assert_select '#qbo-refund-lines-amount', text: '$440.00'
assert_select '#qbo-refund-tax', text: '$14.00'
assert_select '#qbo-refund-fee', text: '-$60.00'
assert_select '#qbo-refund-amount', text: '$394.00'
end
def test_unpaid_invoice_isnt_refunded
RedmineQboBilling::LaborItems.stubs(:ids).returns([])
@gateway.invoices << paid_invoice(balance: 50)
log_user('admin', 'admin')
get '/qbo_refunds/new_invoice?invoice_id=950'
assert_redirected_to '/qbo_invoices/950/edit'
end
def test_invoice_refund
invoice_setup
log_user('admin', 'admin')
post '/qbo_refunds/create_invoice', params: { refund: {
customer_id: CUSTOMER_ID, invoice_id: '950', method: 'card', txn_date: '2026-11-18', reason: 'Returned pads',
charge_fee: '0', note_issues: '1', email_customer: '0',
lines: { '1' => { refund: '0', quantity: '2', amount: '240.00' }, '2' => { refund: '1', quantity: '2', amount: '60.00' },
'3' => { refund: '0', quantity: '1', amount: '80.00' } }
} }
refund = QboRefund.last
assert_redirected_to "/qbo_refunds/#{refund.id}"
assert refund.done?, refund.message
assert_equal BigDecimal('64.20'), refund.refund_amount
follow_redirect!
assert_select 'p', text: /Refund receipt 3000 is recorded/
assert_select 'a[href*="app/refundreceipt?txnId=900"]'
assert_select 'a[href=?]', '/qbo_invoices/950/edit'
get '/qbo_refunds/new_invoice?invoice_id=950'
assert_select 'input[name=?][value=?]', 'refund[lines][2][quantity]', '2'
assert_select '.flash.warning a[href=?]', "/qbo_refunds/#{refund.id}"
get "/qbo_refunds/#{refund.id}/pdf"
assert_response :success
get "/customers/#{CUSTOMER_ID}"
assert_select 'a[href=?]', '/qbo_invoices/950/edit', text: 'Invoice #1234'
end
def test_invoice_refund_form_errors
invoice_setup
log_user('admin', 'admin')
post '/qbo_refunds/create_invoice', params: { refund: {
customer_id: CUSTOMER_ID, invoice_id: '950', method: 'check', check_number: '', txn_date: '2026-11-18', reason: '',
lines: { '2' => { refund: '1', quantity: '9' } }
} }
assert_response :unprocessable_entity
assert_select '#errorExplanation', text: /check number/
assert_select '#errorExplanation', text: /reason/
post '/qbo_refunds/create_invoice', params: { refund: {
customer_id: CUSTOMER_ID, invoice_id: '950', method: 'check', check_number: '1', txn_date: '2026-11-18', reason: 'x',
lines: { '2' => { refund: '1', quantity: '9' } }
} }
assert_response :unprocessable_entity
assert_select '#errorExplanation', text: /no more than 4/
assert_equal 0, QboRefund.count
assert_empty @gateway.receipts
end
def test_credit_refund_page_offers_paid_invoices
Invoice.where(id: 950).delete_all
Invoice.new(id: 950, doc_number: '1234', txn_date: Date.new(2026, 11, 2), customer_id: CUSTOMER_ID,
total_amount: 454, balance: 0).save!(validate: false)
log_user('admin', 'admin')
get "/qbo_refunds/new?customer_id=#{CUSTOMER_ID}"
assert_select '#qbo_refund_invoice option[value="950"]', text: /#1234/
ensure
Invoice.where(id: 950).delete_all
end
end
+242
View File
@@ -0,0 +1,242 @@
#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, :receipts
attr_accessor :auto_apply, :fail_on, :estimate_record, :balance
def initialize(payments: [], estimate: nil)
@payments = payments
@estimate_record = estimate
@invoices = []
@purchases = []
@applied = []
@rejected = []
@receipts = []
@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
# QuickBooks' refund receipt: tax at 7% on the taxable lines, after the discount's share
def create_refund_receipt(receipt)
raise Quickbooks::IntuitRequestException, 'QuickBooks is down' if fail_on == :receipt
sales = receipt.line_items.select { |l| l.detail_type.to_s == 'SalesItemLineDetail' }
discount = receipt.line_items.select { |l| l.detail_type.to_s == 'DiscountLineDetail' }.sum(BigDecimal('0')) { |l| l.amount.to_d }
lines = sales.sum(BigDecimal('0')) { |l| l.amount.to_d.positive? ? l.amount.to_d : 0 }
taxable = sales.select { |l| l.sales_item_line_detail.tax_code_ref&.value == 'TAX' }.sum(BigDecimal('0')) { |l| l.amount.to_d }
tax = (taxable * (lines.positive? ? 1 - discount / lines : 1) * BigDecimal('0.07')).round(2)
receipt.id = (900 + receipts.size).to_s
receipt.doc_number = (3000 + receipts.size).to_s
receipt.txn_tax_detail = Quickbooks::Model::TransactionTaxDetail.new
receipt.txn_tax_detail.total_tax = tax
receipt.total = sales.sum(BigDecimal('0')) { |l| l.amount.to_d } - discount + tax
receipts << receipt
receipt
end
def payment_method_id(kind)
{ check: '2', card: '3' }[kind]
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 sales_line(id, item_id, name, quantity, rate, taxable: true, description: '')
line = Quickbooks::Model::InvoiceLineItem.new
line.id = id.to_s
line.description = description
line.amount = (BigDecimal(quantity.to_s) * BigDecimal(rate.to_s)).round(2)
line.sales_item! do |d|
d.item_ref = Quickbooks::Model::BaseReference.new(item_id.to_s, name: name)
d.quantity = BigDecimal(quantity.to_s)
d.unit_price = BigDecimal(rate.to_s)
d.tax_code_ref = Quickbooks::Model::BaseReference.new(taxable ? 'TAX' : 'NON')
end
line
end
# Invoice #1234, paid in full: 2 h labor at $120 (not taxed), 4 brake pads at $30 and a $80 rotor (taxed at
# 7%: $14.00), $454.00 in all
def paid_invoice(id: 950, balance: 0, customer_id: CUSTOMER_ID, discount: nil)
invoice = Quickbooks::Model::Invoice.new
invoice.id = id.to_s
invoice.doc_number = '1234'
invoice.txn_date = Date.new(2026, 11, 2)
invoice.customer_ref = Quickbooks::Model::BaseReference.new(customer_id.to_s)
invoice.line_items = [sales_line(1, 1, 'Labor', 2, 120, taxable: false, description: 'Brake job'),
sales_line(2, 3, 'Brake Pads', 4, 30, description: 'Ceramic pads'),
sales_line(3, 4, 'Rotor', 1, 80, description: 'Front rotor')]
tax = BigDecimal('14')
if discount
line = Quickbooks::Model::InvoiceLineItem.new
line.amount = BigDecimal(discount.to_s)
line.discount_item! { |d| d.percent_based = false }
invoice.line_items = invoice.line_items + [line]
tax = (BigDecimal('200') * (1 - BigDecimal(discount.to_s) / 440) * BigDecimal('0.07')).round(2)
end
invoice.txn_tax_detail = Quickbooks::Model::TransactionTaxDetail.new
invoice.txn_tax_detail.total_tax = tax
invoice.total = BigDecimal('440') - BigDecimal((discount || 0).to_s) + tax
invoice.balance = BigDecimal(balance.to_s)
invoice
end
def invoice_refund_form(attributes = {})
form = RedmineQboBilling::InvoiceRefundForm.from_params(
{ customer_id: CUSTOMER_ID.to_s, invoice_id: '950', txn_date: '2026-11-18', method: 'check',
check_number: '5002', reason: 'Parts returned unused', charge_fee: '1', note_issues: '1',
email_customer: '1', lines: { '2' => { refund: '1', quantity: '4' }, '3' => { refund: '1', quantity: '1' } } }
.merge(attributes)
)
form
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
+82
View File
@@ -0,0 +1,82 @@
#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
def test_short_paid_badge
status = RedmineQboBilling::InvoiceStatus
nov18 = Date.new(2026, 11, 18)
assert_equal 'Paid', status.short_label(:paid, paid_on: nov18, invoice_date: nov18)
assert_equal 'Paid +1d', status.short_label(:paid, paid_on: nov18 + 1, invoice_date: nov18)
assert_equal 'Paid +34d', status.short_label(:paid, paid_on: nov18 + 34, invoice_date: nov18)
assert_equal 'Paid', status.short_label(:paid, paid_on: nil, invoice_date: nov18)
# A deposit taken before the invoice: paid in full on its date
assert_equal 'Paid', status.short_label(:paid, paid_on: nov18, invoice_date: nov18 + 2)
assert_equal 'Open', status.short_label(:open, paid_on: nov18 + 3, invoice_date: nov18)
assert_match(/\APaid in full \S+/, status.title(:paid, paid_on: nov18))
assert_nil status.title(:open, paid_on: nov18)
end
end
+48
View File
@@ -0,0 +1,48 @@
#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 CustomerTokenTest < ActiveSupport::TestCase
fixtures :projects, :users, :email_addresses, :members, :member_roles, :roles, :issues, :trackers,
:projects_trackers, :issue_statuses, :enabled_modules, :enumerations
def setup
CustomerToken.delete_all
User.current = User.find(1)
end
def token(issue_id, expires_at)
CustomerToken.create!(issue_id: issue_id, expires_at: expires_at)
end
def test_purge_expired
active = token(1, 1.week.from_now)
token(2, 1.day.ago)
token(3, 1.month.ago)
token(99_999, 1.week.from_now) # its issue was deleted
assert_equal 3, CustomerToken.purge_expired
assert_equal [active.id], CustomerToken.pluck(:id)
end
def test_a_new_share_link_clears_out_old_ones
token(2, 1.day.ago)
link = CustomerToken.get_token(Issue.find(1))
assert link.expires_at > Time.current
assert_equal [link.id], CustomerToken.pluck(:id)
end
def test_an_active_link_is_reused
active = token(1, 1.week.from_now)
token(2, 1.day.ago)
assert_equal active, CustomerToken.get_token(Issue.find(1))
assert_equal 2, CustomerToken.count # nothing new made, nothing cleared
end
end
+79
View File
@@ -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
+227
View File
@@ -0,0 +1,227 @@
#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 InvoiceRefundWriterTest < ActiveSupport::TestCase
include QboRefundTestHelper
Writer = RedmineQboBilling::InvoiceRefundWriter
def setup
User.current = User.find(1)
@customer = create_customer
Customer.any_instance.stubs(:email).returns('jane@example.com')
RedmineQboBilling::RefundWriter.stubs(:fee_item).returns(fee_item)
RedmineQboBilling::LaborItems.stubs(:ids).returns([])
@gateway = FakeGateway.new
@gateway.invoices << paid_invoice
end
def refund(form = invoice_refund_form, gateway: @gateway)
Writer.refund!(form, user: User.find(1), gateway: gateway, mailer: FakeMailer)
end
def receipt
@gateway.receipts.last
end
def test_lines
lines = Writer.lines(paid_invoice, refunds: [])
assert_equal %w[1 2 3], lines.map(&:key)
assert_equal [false, true, true], lines.map(&:parts)
assert_equal [false, true, true], lines.map(&:taxable)
assert_equal BigDecimal('120'), lines[1].amount
assert_equal BigDecimal('4'), lines[1].quantity
assert_equal 'Brake Pads · Ceramic pads', lines[1].label
end
def test_lines_inside_bundles
invoice = paid_invoice
bundle = Quickbooks::Model::InvoiceLineItem.new
bundle.id = '7'
bundle.amount = BigDecimal('150')
bundle.group_line_detail!
bundle.group_line_detail.line_items = [sales_line(nil, 1, 'Labor', 1, 100, taxable: false), sales_line(nil, 5, 'Shim Kit', 1, 50)]
invoice.line_items = invoice.line_items + [bundle]
lines = Writer.lines(invoice, refunds: [])
assert_equal %w[1 2 3 7.1 7.2], lines.map(&:key)
assert_equal [false, true], lines.last(2).map(&:parts)
end
def test_paid_in_full_only
assert Writer.paid_in_full?(paid_invoice)
assert_not Writer.paid_in_full?(paid_invoice(balance: 10))
end
# Returned parts by check: $200.00 of parts, a $60.00 fee (30%), $14.00 tax back: $154.00
def test_refund_parts_with_fee
record = refund
assert record.done?, record.message
assert record.invoice?
assert_equal '1234', record.invoice_number
assert_equal BigDecimal('200'), record.lines_amount
assert_equal BigDecimal('200'), record.parts_amount
assert_equal BigDecimal('60'), record.fee_amount
assert_equal BigDecimal('14'), record.tax_amount
assert_equal BigDecimal('154'), record.refund_amount
assert_equal BigDecimal('454'), record.credit_amount
assert_equal '900', record.purchase_id
assert_equal '3000', record.receipt_number
assert_equal %w[2 3], record.refunded_lines.map(&:key)
assert_equal '35', receipt.deposit_to_account_ref.value
assert_equal '2', receipt.payment_method_ref.value
assert_equal '5002', receipt.payment_ref_number
assert_equal CUSTOMER_ID.to_s, receipt.customer_ref.value
pads, rotor, fee = receipt.line_items
assert_equal '3', pads.sales_item_line_detail.item_ref.value
assert_equal BigDecimal('4'), pads.sales_item_line_detail.quantity
assert_equal BigDecimal('30'), pads.sales_item_line_detail.unit_price
assert_equal 'TAX', pads.sales_item_line_detail.tax_code_ref.value
assert_equal BigDecimal('80'), rotor.amount
assert_equal BigDecimal('-60'), fee.amount
assert_equal '55', fee.sales_item_line_detail.item_ref.value
assert_equal 'NON', fee.sales_item_line_detail.tax_code_ref.value
assert_equal 'Restocking fee: 30% × $200.00 parts on Invoice #1234 = $60.00', fee.description
assert_equal [[record.id, 'jane@example.com']], FakeMailer.sent
end
def test_fee_is_optional
record = refund(invoice_refund_form(charge_fee: '0'))
assert record.done?, record.message
assert_equal BigDecimal('0'), record.fee_amount
assert_equal BigDecimal('214'), record.refund_amount
assert_equal 2, receipt.line_items.size
end
# Work with no parts: no fee, even when it's ticked, and no fee product/service needed
def test_labor_only_has_no_fee
RedmineQboBilling::RefundWriter.stubs(:fee_item).returns(nil)
record = refund(invoice_refund_form(lines: { '1' => { refund: '1', quantity: '2' } }, method: 'card', check_number: ''))
assert record.done?, record.message
assert_equal BigDecimal('0'), record.parts_amount
assert_equal BigDecimal('0'), record.fee_amount
assert_equal BigDecimal('240'), record.refund_amount
assert_equal 1, receipt.line_items.size
assert_equal 'NON', receipt.line_items.first.sales_item_line_detail.tax_code_ref.value
assert_equal '3', receipt.payment_method_ref.value
assert_nil receipt.payment_ref_number
assert_nil record.check_number
end
# A goodwill refund of part of the labor: an amount alone, no quantity or rate
def test_partial_amount
record = refund(invoice_refund_form(lines: { '1' => { refund: '1', quantity: '2', amount: '100' } }))
assert record.done?, record.message
detail = receipt.line_items.first.sales_item_line_detail
assert_equal BigDecimal('100'), receipt.line_items.first.amount
assert_nil detail.quantity
assert_nil detail.unit_price
assert_equal '1', detail.item_ref.value
# It doesn't use up the 2 hours: what's left is $140.00, offered without a quantity
assert_nil record.refunded_lines.first.quantity
labor = Writer.lines(paid_invoice).first
assert_equal BigDecimal('2'), labor.remaining_quantity
assert_equal BigDecimal('140'), labor.remaining_amount
assert_nil Writer.default_quantity(labor)
assert_equal BigDecimal('4'), Writer.default_quantity(Writer.lines(paid_invoice)[1])
end
def test_a_line_isnt_refunded_twice
first = refund(invoice_refund_form(lines: { '2' => { refund: '1', quantity: '2' } }))
assert first.done?, first.message
assert_equal BigDecimal('60'), first.lines_amount
assert_equal BigDecimal('2'), receipt.line_items.first.sales_item_line_detail.quantity
lines = Writer.lines(paid_invoice)
assert_equal BigDecimal('2'), lines[1].remaining_quantity
assert_equal BigDecimal('60'), lines[1].remaining_amount
error = assert_raises(Writer::Error) { refund(invoice_refund_form(lines: { '2' => { refund: '1', quantity: '3' } })) }
assert_match(/no more than 2/, error.message)
error = assert_raises(Writer::Error) { refund(invoice_refund_form(lines: { '2' => { refund: '1', amount: '61' } })) }
assert_match(/\$60\.00 is left/, error.message)
assert refund(invoice_refund_form(lines: { '2' => { refund: '1', quantity: '2' } })).done?
end
def test_discount_share
@gateway.invoices.replace([paid_invoice(discount: 44)])
record = refund(invoice_refund_form(charge_fee: '0'))
assert record.done?, record.message
# 10% off the invoice: $20.00 of the $200.00 refunded
assert_equal BigDecimal('20'), record.discount_amount
discount = receipt.line_items.detect { |l| l.detail_type.to_s == 'DiscountLineDetail' }
assert_equal BigDecimal('20'), discount.amount
assert receipt.apply_tax_after_discount?
assert_equal BigDecimal('192.60'), record.refund_amount
end
def test_checks_before_making_anything
@gateway.invoices.replace([paid_invoice(balance: 100)])
assert_raises(Writer::Error) { refund }
@gateway.invoices.replace([paid_invoice(customer_id: 1)])
assert_raises(Writer::Error) { refund }
@gateway.invoices.replace([paid_invoice])
assert_raises(Writer::Error) { refund(invoice_refund_form(lines: { '9' => { refund: '1' } })) }
RedmineQboBilling::RefundWriter.stubs(:fee_item).returns(nil)
assert_raises(Writer::Error) { refund }
assert_equal 0, QboRefund.count
assert_empty @gateway.receipts
end
def test_records_when_quickbooks_fails
@gateway.fail_on = :receipt
record = refund
assert_not record.done?
assert_match(/refund receipt couldn't be recorded/i, record.message)
assert_nil record.purchase_id
assert_empty FakeMailer.sent
# A refund that made nothing doesn't use up the lines
assert_equal BigDecimal('120'), Writer.lines(paid_invoice)[1].remaining_amount
end
def test_notes_the_work_orders
Invoice.where(id: 950).delete_all
invoice = Invoice.new(id: 950, doc_number: '1234', txn_date: Date.new(2026, 11, 2), customer_id: CUSTOMER_ID,
total_amount: 454, balance: 0)
invoice.save!(validate: false)
invoice.issues << Issue.find(1)
status = Issue.find(1).status_id
record = refund
assert record.done?, record.message
assert_equal [1], record.noted_issue_ids
issue = Issue.find(1)
assert_equal status, issue.status_id
assert_equal 'Refunded $154.00 on invoice #1234 by Company check: Parts returned unused', issue.journals.last.notes
ensure
Invoice.where(id: 950).delete_all
end
def test_the_email
record = refund
message = QboRefundMailer.refund_summary(record, 'jane@example.com')
body = message.body.to_s
assert_includes body, "We've processed the refund for Invoice #1234."
assert_includes body, 'Brake Pads · Ceramic pads: $120.00'
assert_includes body, 'Lines refunded: $200.00'
assert_includes body, 'Sales tax: $14.00'
assert_includes body, 'Restocking fee (30% of parts): $60.00'
assert_includes body, 'Refund: $154.00'
assert_includes body, 'returned parts carry a restocking fee'
assert_not_includes body, "Labor that wasn't done"
end
def test_the_pdf
record = refund
document = RedmineQboBilling::RefundPdf.new(record)
assert document.render.start_with?('%PDF')
end
end
+177
View File
@@ -0,0 +1,177 @@
#The MIT License (MIT)
#
#Copyright (c) 2026 rick barrette
#
#Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
#
#The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
#
#THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
require File.expand_path('../test_helper', __dir__)
class RefundWriterTest < ActiveSupport::TestCase
include QboRefundTestHelper
Writer = RedmineQboBilling::RefundWriter
def setup
User.current = User.find(1)
@customer = create_customer
Customer.any_instance.stubs(:email).returns('jane@example.com')
Writer.stubs(:fee_item).returns(fee_item)
@gateway = FakeGateway.new(payments: [deposit(50, 300), deposit(51, '307.99', date: Date.new(2026, 11, 5))], estimate: estimate)
end
def refund(form = refund_form, gateway: @gateway)
Writer.refund!(form, user: User.find(1), gateway: gateway, mailer: FakeMailer)
end
def test_fee
assert_equal BigDecimal('92.40'), Writer.fee(BigDecimal('307.99'), 30)
assert_equal BigDecimal('0'), Writer.fee(0, 30)
end
def test_parts_amount_leaves_out_labor
assert_equal BigDecimal('307.99'), Writer.parts_amount(estimate)
end
def test_parts_inside_bundles
bundle = Quickbooks::Model::InvoiceLineItem.new
bundle.amount = BigDecimal('500')
bundle.group_line_detail!
bundle.group_line_detail.line_items = [item_line(1, 'Labor', 380), item_line(3, 'Brake Pads', 120)]
subtotal = Quickbooks::Model::InvoiceLineItem.new
subtotal.amount = BigDecimal('9999')
subtotal.detail_type = 'SubTotalLineDetail'
subtotal.sub_total_line_detail = Quickbooks::Model::SubTotalLineDetail.new
e = estimate
e.line_items = e.line_items + [bundle, subtotal]
assert_equal BigDecimal('427.99'), Writer.parts_amount(e)
end
def test_refund_by_check
record = refund
assert record.done?, record.message
# $92.40 fee (30% of $307.99) out of $607.99 credit: $515.59 refunded
assert_equal BigDecimal('92.40'), record.fee_amount
assert_equal BigDecimal('607.99'), record.credit_amount
assert_equal BigDecimal('515.59'), record.refund_amount
invoice = @gateway.invoices.first
line = invoice.line_items.first
assert_equal 'Restocking fee: 30% × $307.99 parts on E1068 = $92.40', line.description
assert_equal '55', line.sales_line_item_detail.item_ref.value
assert_equal BigDecimal('0'), invoice.balance
purchase = @gateway.purchases.first
assert_equal 'Check', purchase.payment_type
assert_equal '5001', purchase.doc_number
assert_equal '35', purchase.account_ref.value
assert_equal 'Customer', purchase.entity_ref.type
assert_equal CUSTOMER_ID.to_s, purchase.entity_ref.value
expense = purchase.line_items.first
assert_equal 'Refund for deposit on E1068', expense.description
assert_equal '84', expense.account_based_expense_line_detail.account_ref.value
assert_equal BigDecimal('515.59'), expense.amount
# Oldest deposit pays the fee first; what's left of both goes on the check
assert_equal [['50', BigDecimal('92.40'), invoice.id, 'Invoice'],
['50', BigDecimal('207.60'), purchase.id, 'Check'],
['51', BigDecimal('307.99'), purchase.id, 'Check']], @gateway.applied
assert @gateway.payments.all? { |p| p.unapplied_amount.zero? }
assert_equal BigDecimal('0'), record.balance_after
assert_equal ['598'], @gateway.rejected
assert record.estimate_closed?
assert_equal [[record.id, 'jane@example.com']], FakeMailer.sent
assert_equal 'jane@example.com', record.emailed_to
end
def test_card_refund_is_an_expense
record = refund(refund_form(method: 'card', check_number: ''))
assert record.done?, record.message
purchase = @gateway.purchases.first
assert_equal 'Cash', purchase.payment_type
assert_nil purchase.doc_number
assert_equal 'Refund for deposit on E1068 (card refund on the terminal)', purchase.line_items.first.description
assert_equal %w[Invoice Expense Expense], @gateway.applied.map(&:last)
assert_nil record.check_number
end
def test_credit_quickbooks_already_applied_to_the_fee
@gateway.auto_apply = true
record = refund
assert record.done?, record.message
assert_equal BigDecimal('515.59'), record.refund_amount
# The fee was paid once, by QuickBooks
assert_equal 1, @gateway.applied.count { |a| a.last == 'Invoice' }
end
def test_no_fee_refunds_everything
record = refund(refund_form(parts_amount: '0', estimate_id: ''))
assert record.done?, record.message
assert_empty @gateway.invoices
assert_equal BigDecimal('607.99'), record.refund_amount
assert_equal 'Refund of customer credit', @gateway.purchases.first.line_items.first.description
assert_empty @gateway.rejected
end
def test_checks_before_making_anything
assert_raises(Writer::Error) { refund(refund_form, gateway: FakeGateway.new(estimate: estimate)) }
assert_raises(Writer::Error) { refund(refund_form(parts_amount: '5000')) }
assert_raises(Writer::Error) { refund(refund_form, gateway: FakeGateway.new(payments: [deposit(50, 300)], estimate: estimate(customer_id: 1))) }
Writer.stubs(:fee_item).returns(nil)
assert_raises(Writer::Error) { refund }
assert_equal 0, QboRefund.count
assert_empty @gateway.invoices
end
def test_records_the_step_that_failed
@gateway.fail_on = :purchase
record = refund
assert_not record.done?
assert_match(/refund couldn't be recorded/i, record.message)
assert_equal 1, @gateway.invoices.size
assert record.fee_invoice_id.present?
assert_nil record.purchase_id
assert_empty FakeMailer.sent
assert_empty @gateway.rejected
end
def test_cancels_the_work_orders
issue = Issue.find(1)
issue.update_columns(estimate_id: 598) if Issue.column_names.include?('estimate_id')
canceled = IssueStatus.find(5) # Closed (fixtures)
Writer.stubs(:canceled_status).returns(canceled)
record = refund
assert record.done?, record.message
assert_includes record.canceled_issue_ids, 1
issue.reload
assert_equal canceled, issue.status
assert_match(/Order canceled and refunded: Customer canceled the order/, issue.journals.last.notes)
end
def test_warnings_dont_undo_the_refund
Customer.any_instance.stubs(:email).returns('')
Writer.stubs(:canceled_status).returns(nil)
record = refund
assert record.done?
assert_match(/no email/i, record.message)
assert_match(/canceled status/i, record.message)
end
def test_the_email
record = refund
ActionMailer::Base.deliveries.clear
message = QboRefundMailer.refund_summary(record, 'jane@example.com')
message.deliver_now
assert_equal ['jane@example.com'], message.to
assert_match(/Your refund from .*: \$515\.59/, message.subject)
body = message.body.to_s
assert_includes body, 'Hello Jane Customer,'
assert_includes body, "We've processed the refund for E1068."
assert_includes body, 'Parts: $307.99'
assert_includes body, 'Restocking fee (30% of parts): $92.40'
assert_includes body, 'Refund: $515.59'
assert_includes body, 'company check (no. 5001)'
end
end