mirror of
https://github.com/rickbarrette/redmine_qbo.git
synced 2026-11-19 10:40:36 -05:00
Compare commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
d07d99109b | ||
|
|
9fd6e90c81 | ||
|
|
14f0409395 | ||
|
|
9121e079a0 | ||
|
|
48a4185c16 | ||
|
|
71f31ccbed | ||
|
|
afca8eb6ea | ||
|
|
6ec8853508 | ||
|
|
b99887362f | ||
|
|
0dd3073841 | ||
|
|
e61217b719 | ||
|
|
b8ddf1c38b | ||
|
|
f1d81890de | ||
|
|
609ddb098a | ||
|
|
c4ab97b75e | ||
|
|
0523e8dd24 | ||
|
|
aacc2d645d | ||
|
|
cf3342bcc5 | ||
|
|
bab019a152 | ||
|
|
fd91bd6fa2 | ||
|
|
04a0eede5f | ||
|
|
ba40496421 | ||
|
|
57dc8127b0 | ||
|
|
9dc4b79355 | ||
|
|
8ae82f1423 | ||
|
|
b72c82fb2b | ||
|
|
b901e64149 | ||
|
|
7abb1aa06c | ||
|
|
dfd3a641db | ||
|
|
75e5aeb668 |
No files matched your search
@@ -6,3 +6,6 @@ gem 'roxml'
|
||||
gem 'will_paginate'
|
||||
gem 'rexml'
|
||||
gem 'combine_pdf'
|
||||
|
||||
# Double Metaphone sound-alike matching for customer search (CustomerSearchService)
|
||||
gem 'text', '~> 1.3'
|
||||
@@ -95,6 +95,94 @@ Customer records are automatically updated in the local database when changes oc
|
||||
|
||||
---
|
||||
|
||||
## Billing: Estimates, Invoices and Payments
|
||||
|
||||
* **New estimate** from the customer page: Create Estimate opens the Redmine editor. The customer page no longer links to QuickBooks' estimate or payment screens; the customer's name still opens their QuickBooks account page as a fallback.
|
||||
* **Edit** any estimate from the Edit link next to it on the customer page or the issue page.
|
||||
* **Duplicate** an estimate to start a similar one: same customer, lines, subtotals, VIN and messages, dated today, with the current user as sales person.
|
||||
* **Read-only once linked to an issue**: an estimate that an issue is linked to can be viewed, emailed and duplicated, but not changed, so the work doesn't drift from what was quoted. The list shows a View link for these instead of Edit.
|
||||
* **Create issues** from an estimate's labor lines (moved here from redmine_qbo_calendar): each line whose item matches an **estimate item code** (e.g. Labor) becomes an issue with the line's description as subject and its quantity as estimated hours. Pick the project, trackers, templates and shared custom fields first. Lines already turned into issues can't be created twice, and issues from the same estimate are related to each other. Opened from an appointment, the issues get the appointment's dates, technician and vehicle.
|
||||
* **Email** the estimate with QuickBooks' own estimate email, with **Save and send** or the Email link.
|
||||
* The page follows QuickBooks' estimate screen: customer, customer email, billing address, estimate date, expiration date, estimate number, then the product/service lines (#, product/service, description, qty, rate, amount, tax), the message displayed on the estimate, the memo, and the totals.
|
||||
* Lines work like QuickBooks: the product list opens when the box is clicked, picking a product fills in its description, rate and tax, typing an amount works out the rate, a spare empty line is always at the bottom, and lines are reordered by dragging them by the handle.
|
||||
* A line with a description but no product or rate is saved as a description-only line, e.g. the estimate notes on the first line.
|
||||
* **Add subtotal** puts a subtotal line after the last filled line. A subtotal totals the lines above it, back to the previous subtotal, and can be dragged like any line. It's saved the way QuickBooks saves subtotals from its own screen, as a line reading "Subtotal: $342.60" that prints where it was placed, so the PDF keeps its layout.
|
||||
* Sales tax is worked out by QuickBooks when the estimate is saved.
|
||||
|
||||
### Invoices
|
||||
|
||||
* **Create invoice** on an estimate's page makes an invoice from it (customer, lines, subtotals, VIN), like QuickBooks' "Create invoice". **Create invoice** on the customer page starts a blank one, and the Edit link next to each invoice on the customer page opens it.
|
||||
* **Import time & estimates** lists the customer's billable QuickBooks time (the time activities redmine_qbo makes from an issue's time entries) and their open estimates (e.g. the ones redmine_qbo_lineitems makes for parts that weren't quoted).
|
||||
* Tick the time to bill and, under **Replace these lines**, the lines it replaces (e.g. the estimate's labor lines). When products/services are set as **Replaced by imported time** in the plugin settings, only lines with one of them are offered there; with none set, every line is. The time goes where the first ticked line was and the ticked lines are removed, so the invoice reads in the same order.
|
||||
* Ticked estimates go right after the time for the same issue: a redmine_qbo_lineitems estimate starting "Added from: Install #116: …" lands after the time for #116, without that note line, since the time line already names the issue. Estimates with no matching time keep the note and go at the end.
|
||||
* **Undo import** puts the lines back until the invoice is saved.
|
||||
* **An estimate is billed once**: an estimate that's on an invoice (linked to one, or closed) or was rejected can't be made into an invoice or imported, and its page shows the invoice it's billed on. This is checked against QuickBooks again when the invoice is saved, so an estimate invoiced meanwhile (in another tab, by someone else, or in QuickBooks) stops the save.
|
||||
* Time lines are linked to their time activities, so QuickBooks marks the time as billed. Estimates the invoice was made from, or imported into it, are linked and closed when it's saved.
|
||||
* **VIN and mileage from the work orders**: the issues behind an invoice are the ones its time lines and lineitems estimates name. When they're imported, the VIN box takes their vehicle's VIN (with redmine_qbo_vehicles) and a **Mileage** box (shown when QuickBooks has a text custom field named like "Mileage") takes the highest value of the issues' Mileage custom field. With redmine_qbo_vehicles, an invoice whose work orders are for more than one vehicle isn't saved.
|
||||
* **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 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
|
||||
|
||||
* **Receive payment** on the customer page or on an unpaid invoice: the customer, payment date, payment method (QuickBooks' list: Cash, Check...), reference number (e.g. the check number), amount and a memo.
|
||||
* Tick open invoices to fill in the amount (their open balances added up) and pay just those; the header box ticks them all.
|
||||
* With none ticked, the payment is applied to the customer's open invoices **oldest first**, like QuickBooks does; the page shows how it will be split as the amount is typed, and it's worked out again from QuickBooks when saving. Anything more than the open balances stays as a credit.
|
||||
* Tick **Deposit** to keep the whole payment as a credit on the customer's account without paying any invoice (also what happens when there are no open invoices).
|
||||
* 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.
|
||||
|
||||
### QuickBooks custom fields
|
||||
|
||||
Nothing is configured in Redmine. The plugin reads QuickBooks' sales form settings, and the custom fields on the 20 most recently changed estimates, and finds the fields by name:
|
||||
|
||||
* A text field whose name contains **VIN** gets the VIN box. The customer's vehicles (from redmine_qbo_vehicles) are offered as choices.
|
||||
* A text field whose name contains **Sales** or **Rep** (e.g. "Sales Person", "Salesperson", "Sales Rep") gets the name of the Redmine user who creates the estimate. Editing an estimate keeps its sales person.
|
||||
|
||||
QuickBooks only shares its first three **text** custom fields with apps; dropdown custom fields can't be read or filled in. If your sales person field is a dropdown, change it to a text field in QuickBooks (Settings → Custom fields).
|
||||
|
||||
Newer QuickBooks custom fields (made under Settings → Custom fields) aren't listed in QuickBooks' settings, so the plugin asks QuickBooks for all custom fields on estimates and finds them on the most recently changed ones. If a new field isn't found, fill it in on one estimate in QuickBooks, then refresh.
|
||||
|
||||
The settings are read once an hour (every five minutes while the VIN or sales person field is missing). After adding or renaming a custom field in QuickBooks, an administrator can use **Refresh QuickBooks fields** on the estimate page, which also lists the fields QuickBooks shares. Newer QuickBooks custom fields (e.g. on Advanced and sandbox companies) may not be listed in its settings; they're found once they're filled in on at least one estimate.
|
||||
|
||||
Estimate numbers can't be typed. QuickBooks numbers new estimates; when its "Custom transaction numbers" setting is on, the next number is filled in when the estimate is created. The "default message shown on estimates" fills in the message on new estimates.
|
||||
|
||||
### Products/services and accounts
|
||||
|
||||
Administration → Items lists the QuickBooks product/service list (synced from QuickBooks, and pushed back when an item is added or edited here). Accounts are reached from there. The plugin settings show the counts, the default income account for new items, and Sync buttons. These moved here from redmine_qbo_lineitems with the same URLs.
|
||||
|
||||
### What is left to QuickBooks
|
||||
|
||||
* Estimates with bundles open read-only, so a bundle can't be broken apart by accident.
|
||||
* The sales person box is read-only: it shows who created the estimate.
|
||||
* Discounts on an estimate are kept as they are; they can't be edited here.
|
||||
* If an estimate was changed in QuickBooks after it was opened in Redmine, saving stops and asks to reload it, so nobody's changes are overwritten.
|
||||
|
||||
### Billing Settings and Permissions
|
||||
|
||||
1. Permissions
|
||||
|
||||
1. Navigate to Administration -> Roles and permissions.
|
||||
2. Assign these global permissions as needed:
|
||||
* **Write estimates**: create and edit estimates
|
||||
* **Email estimates**: email estimates to customers (Save and send, and the Email link)
|
||||
* **Create issues from estimates**: the Create issues page (was redmine_qbo_calendar's "Create issues from appointment estimates")
|
||||
* **View payments**: a customer's Payments list, the payment page and its PDF
|
||||
* **Receive payments**: the Receive payment page, plus everything View payments allows
|
||||
* **Write invoices**: create and edit invoices, and import time and estimates into them
|
||||
* **Email invoices**: email invoices to customers
|
||||
|
||||
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.
|
||||
* **Issues from estimates**: the estimate item codes (also an estimate's labor hours, which an appointment's hours can't be less than), the default project and the default tracker. Until saved here, redmine_qbo_calendar's old values are used.
|
||||
* **Replaced by imported time**: the products/services (e.g. Labor) whose invoice lines time can replace. Only those lines are offered under Replace these lines; leave empty to offer every line.
|
||||
* Item and account counts, the default income account, and Sync Items / Sync Accounts.
|
||||
|
||||
3. Writing an estimate
|
||||
|
||||
1. Open the customer and click **Create Estimate**.
|
||||
2. Fill in the lines. Type in the product/service box or click it to pick from the list.
|
||||
3. Click **Save**, or **Save and send** to email it to the customer email.
|
||||
|
||||
## Plugin Hooks
|
||||
|
||||
The plugin exposes several hooks for extending functionality through companion plugins.
|
||||
@@ -108,13 +196,19 @@ Available hooks:
|
||||
|
||||
|Type|Hook|Note
|
||||
|--|--|--|
|
||||
View Hook|:customer_actions_top, { customer: @customer }| Used to add action links to customer view
|
||||
View Hook|:customer_actions_bottom, { customer: @customer} | Used to add action links to customer view
|
||||
View Hook|:view_customers_show_contextual, { customer: @customer } | Used to add action links to the customer page's top-right action area (return links styled like Redmine's, e.g. `link_to sprite_icon('add', 'Label'), path, class: 'icon icon-add'`). Replaces `customer_actions_top` / `customer_actions_bottom`
|
||||
View Hook|:pdf_left, { issue: issue } | Used to add text to left side of PDF
|
||||
View Hook|:pdf_right, { issue: issue } | Used to add text to right side of PDF
|
||||
View Hook|:show_customer_view_right, { customer: customer } | Used to show partials on right side of customer view
|
||||
Hook| :qbo_additional_entities | Used to add additional entites to be processed by the WebhookProcessJob
|
||||
Hook| :qbo_full_sync | Used to add a Class to be called by the QboSyncDispatcher
|
||||
Hook|:qbo_billing_issue_values, { issues: } | Return `{ field => { issue_id => value } }` for the work orders behind an invoice, e.g. `{ vin: { 116 => "1C4..." } }` (redmine_qbo_vehicles). Importing time or estimates fills the VIN box when the work orders share one VIN, and the mileage box with the highest mileage (read from the issue custom field named "Mileage")
|
||||
Hook|:qbo_billing_validate, { document:, form:, issues: } | Return an error message (or several) to stop an estimate or invoice from saving, e.g. redmine_qbo_vehicles: one vehicle per invoice
|
||||
Hook|:qbo_billing_issue_defaults, { estimate:, params: } | Return `start_date`, `due_date`, `assignee`, `vehicle_id`, `project`, `description`, `return_path`, `return_label` for issues created from an estimate (redmine_qbo_calendar, when opened from an appointment)
|
||||
Hook|:qbo_billing_issues_created, { estimate:, issues:, params: } | Called after issues are created from an estimate
|
||||
View Hook|:view_qbo_estimate_contextual, { estimate_id:, customer_id:, vin:, doc_number: } | Adds links to an estimate page's action area (e.g. redmine_qbo_calendar's Add appointment)
|
||||
|
||||
Other plugins create estimates with `RedmineQboBilling::EstimateWriter.create_estimate(customer:, lines:, private_note:, vin:, mileage:, user:)`; each line is a hash of `description`, `item_id`, `quantity`, `rate` and `taxable`.
|
||||
|
||||
---
|
||||
|
||||
|
||||
@@ -0,0 +1,37 @@
|
||||
#The MIT License (MIT)
|
||||
#
|
||||
#Copyright (c) 2026 rick barrette
|
||||
#
|
||||
#Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
|
||||
#
|
||||
#The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
|
||||
#
|
||||
#THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
||||
|
||||
class AccountsController < ApplicationController
|
||||
layout 'admin'
|
||||
menu_item :redmine_qbo_items
|
||||
|
||||
# Accounts come from QuickBooks; choosing the default and syncing are admin-only
|
||||
before_action :require_admin
|
||||
|
||||
def index
|
||||
@accounts = Account.where(classification: 'Revenue').order(:name)
|
||||
end
|
||||
|
||||
def set_default
|
||||
account = Account.find_by(id: params[:default_account_id])
|
||||
|
||||
if account&.update(default: true)
|
||||
flash[:notice] = l(:notice_default_account_updated)
|
||||
else
|
||||
flash[:error] = l(:error_default_account_not_selected)
|
||||
end
|
||||
redirect_to accounts_path
|
||||
end
|
||||
|
||||
def sync
|
||||
Account.sync
|
||||
redirect_to :home, flash: { notice: I18n.t(:label_syncing) }
|
||||
end
|
||||
end
|
||||
@@ -8,7 +8,6 @@
|
||||
#
|
||||
#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.
|
||||
|
||||
# This controller class will handle map management
|
||||
class CustomersController < ApplicationController
|
||||
|
||||
include AuthHelper
|
||||
@@ -26,8 +25,12 @@ class CustomersController < ApplicationController
|
||||
include SortHelper
|
||||
helper :timelog
|
||||
|
||||
before_action :add_customer, only: :new
|
||||
before_action :view_customer, except: [:new, :view]
|
||||
# This tells Redmine to check global permissions for the current controller/action
|
||||
# customers#view is the public share-link page: it is authorized by its token, not by Redmine permissions
|
||||
before_action :authorize_global, except: [:view]
|
||||
before_action :add_customer, only: [:new, :create]
|
||||
before_action :view_customer, except: [:new, :create, :view, :share, :sync]
|
||||
before_action :require_admin, only: :sync
|
||||
skip_before_action :verify_authenticity_token, :check_if_login_required, only: [:view]
|
||||
|
||||
def address_to_s(address)
|
||||
@@ -60,13 +63,11 @@ class CustomersController < ApplicationController
|
||||
params.require(:customer).permit(:name, :email, :primary_phone, :mobile_phone, :phone_number, :notes)
|
||||
end
|
||||
|
||||
# Used for autocomplete form
|
||||
# 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
|
||||
term = ActiveRecord::Base.sanitize_sql_like(params[:q].to_s)
|
||||
|
||||
items = Customer.where("name LIKE :t OR phone_number LIKE :t OR mobile_phone_number LIKE :t", t: "%#{term}%")
|
||||
.order(:name)
|
||||
.limit(20)
|
||||
name_query = (params[:name] || params[:q] || params[:term]).to_s.strip
|
||||
items = CustomerSearchService.call(name: name_query, phone: params[:phone])
|
||||
|
||||
render json: items.map { |i|
|
||||
{ id: i.id, name: i.name, phone_number: i.phone_number, mobile_phone_number: i.mobile_phone_number }
|
||||
@@ -75,14 +76,28 @@ class CustomersController < ApplicationController
|
||||
|
||||
def create
|
||||
@customer = Customer.new(allowed_params)
|
||||
@customer.save
|
||||
log "Customer ##{@customer.id} created successfully."
|
||||
flash[:notice] = t :notice_customer_created
|
||||
redirect_to @customer
|
||||
|
||||
respond_to do |format|
|
||||
if @customer.save
|
||||
log "Customer ##{@customer.id} created successfully."
|
||||
format.html { redirect_to @customer, notice: l(:notice_successful_create) }
|
||||
format.json { render json: { id: @customer.id, name: @customer.name }, status: :created }
|
||||
else
|
||||
format.html { render :new }
|
||||
format.json { render json: { errors: @customer.errors.full_messages }, status: :unprocessable_entity }
|
||||
end
|
||||
end
|
||||
rescue => e
|
||||
log "Failed to create customer: #{e.message}"
|
||||
flash[:error] = e.message
|
||||
redirect_to new_customer_path
|
||||
respond_to do |format|
|
||||
format.html {
|
||||
flash[:error] = e.message
|
||||
redirect_to new_customer_path
|
||||
}
|
||||
format.json {
|
||||
render json: { errors: [e.message] }, status: :internal_server_error
|
||||
}
|
||||
end
|
||||
end
|
||||
|
||||
def edit
|
||||
@@ -104,7 +119,7 @@ class CustomersController < ApplicationController
|
||||
|
||||
def index
|
||||
if params[:search]
|
||||
@customers = Customer.search(params[:search]).order(:name).paginate(page: params[:page])
|
||||
@customers = CustomerSearchService.call(name: params[:search], limit: 200).paginate(page: params[:page])
|
||||
if only_one_non_zero?(@customers)
|
||||
redirect_to @customers.first
|
||||
end
|
||||
@@ -136,6 +151,10 @@ class CustomersController < ApplicationController
|
||||
|
||||
def new
|
||||
@customer = Customer.new
|
||||
|
||||
if request.xhr?
|
||||
render partial: 'form', layout: false, locals: { hide_submit: true, hide_toolbar: true }
|
||||
end
|
||||
end
|
||||
|
||||
def only_one_non_zero?(array)
|
||||
@@ -150,8 +169,10 @@ class CustomersController < ApplicationController
|
||||
end
|
||||
|
||||
def share
|
||||
issue = Issue.find(params[:id])
|
||||
issue = Issue.visible.find(params[:id])
|
||||
token = issue.share_token
|
||||
return render_403 unless token
|
||||
|
||||
redirect_to view_path(token.token)
|
||||
rescue ActiveRecord::RecordNotFound
|
||||
flash[:error] = t(:notice_issue_not_found)
|
||||
@@ -197,9 +218,14 @@ class CustomersController < ApplicationController
|
||||
|
||||
def update
|
||||
@customer = Customer.find_by_id(params[:id])
|
||||
@customer.update(allowed_params)
|
||||
flash[:notice] = t :notice_customer_updated
|
||||
redirect_to @customer
|
||||
return render_404 unless @customer
|
||||
|
||||
if @customer.update(allowed_params)
|
||||
flash[:notice] = t :notice_customer_updated
|
||||
redirect_to @customer
|
||||
else
|
||||
render :edit, status: :unprocessable_entity
|
||||
end
|
||||
rescue => e
|
||||
log "Failed to update customer: #{e.message}"
|
||||
flash[:error] = e.message
|
||||
@@ -212,7 +238,6 @@ class CustomersController < ApplicationController
|
||||
return render_403 unless @token
|
||||
@issue = @token.issue
|
||||
return render_403 unless @issue
|
||||
return render_403 unless @issue.customer_id == @token.issue.customer_id
|
||||
session[:token] = @token.token
|
||||
load_issue_data
|
||||
rescue ActiveRecord::RecordNotFound
|
||||
|
||||
@@ -10,7 +10,8 @@
|
||||
class EmployeesController < ApplicationController
|
||||
include AuthHelper
|
||||
|
||||
before_action :require_user, unless: -> { session[:token].nil? }
|
||||
# Syncing is admin-only
|
||||
before_action :require_admin
|
||||
|
||||
def sync
|
||||
Employee.sync
|
||||
|
||||
@@ -10,9 +10,14 @@
|
||||
class EstimatesController < ApplicationController
|
||||
include AuthHelper
|
||||
|
||||
before_action :require_user, unless: -> { session[:token].nil? }
|
||||
skip_before_action :verify_authenticity_token, :check_if_login_required, unless: -> { session[:token].nil? }
|
||||
# PDFs: logged-in users, or a customer with a share link (limited to their issue's estimate).
|
||||
# Redmine's own login check is replaced by require_login_or_customer_token for these actions.
|
||||
skip_before_action :check_if_login_required, only: [:show, :doc]
|
||||
before_action :require_login_or_customer_token, only: [:show, :doc]
|
||||
before_action :load_estimate, only: [:show, :doc]
|
||||
|
||||
# Syncing is admin-only
|
||||
before_action :require_admin, only: :sync
|
||||
|
||||
# Displays the estimate PDF in the browser or redirects with an error if not found.
|
||||
def doc
|
||||
@@ -34,6 +39,10 @@ class EstimatesController < ApplicationController
|
||||
# Loads the estimate based on ID or doc number, with a fallback to sync if not found locally.
|
||||
def load_estimate
|
||||
log "Attempting to load Estimate with params: #{params.inspect}"
|
||||
|
||||
# Share-link customers may only open the estimate attached to their issue (checked before any sync)
|
||||
return load_customer_estimate if customer_token_only?
|
||||
|
||||
@estimate = find_estimate || sync_and_find_estimate
|
||||
|
||||
unless @estimate
|
||||
@@ -41,6 +50,21 @@ class EstimatesController < ApplicationController
|
||||
end
|
||||
end
|
||||
|
||||
# For share-link customers: only the estimate attached to the token's issue, by ID or doc number.
|
||||
def load_customer_estimate
|
||||
estimate = customer_token.issue&.estimate
|
||||
requested =
|
||||
if params[:search].present?
|
||||
estimate && estimate.doc_number.to_s == params[:search].to_s
|
||||
else
|
||||
estimate && estimate.id.to_s == params[:id].to_s
|
||||
end
|
||||
|
||||
return render_403 unless requested
|
||||
|
||||
@estimate = estimate
|
||||
end
|
||||
|
||||
# Attempts to find the estimate locally by ID or doc number.
|
||||
def find_estimate
|
||||
return Estimate.find_by(doc_number: params[:search]) if params[:search].present?
|
||||
|
||||
@@ -10,14 +10,19 @@
|
||||
class InvoicesController < ApplicationController
|
||||
include AuthHelper
|
||||
|
||||
before_action :require_user, unless: -> { session[:token].nil? }
|
||||
skip_before_action :verify_authenticity_token, :check_if_login_required, unless: -> { session[:token].nil? }
|
||||
# PDFs: logged-in users, or a customer with a share link (limited to their issue's invoices).
|
||||
# Redmine's own login check is replaced by require_login_or_customer_token for this action.
|
||||
skip_before_action :check_if_login_required, only: :show
|
||||
before_action :require_login_or_customer_token, only: :show
|
||||
before_action :authorize_customer_invoices, only: :show
|
||||
|
||||
# Syncing is admin-only
|
||||
before_action :require_admin, only: :sync
|
||||
|
||||
# Displays the invoice PDF in the browser or redirects with an error if not found.
|
||||
def show
|
||||
log "Processing request for #{request.original_url}"
|
||||
|
||||
invoice_ids = Array(params[:invoice_ids] || params[:id])
|
||||
pdf, ref = PdfService.new(entity: Invoice).fetch_pdf(doc_ids: invoice_ids)
|
||||
|
||||
send_data pdf, filename: "invoice #{ref}.pdf", disposition: :inline, type: "application/pdf"
|
||||
@@ -34,6 +39,18 @@ class InvoicesController < ApplicationController
|
||||
|
||||
private
|
||||
|
||||
def invoice_ids
|
||||
@invoice_ids ||= Array(params[:invoice_ids] || params[:id]).map(&:to_s).reject(&:blank?)
|
||||
end
|
||||
|
||||
# Share-link customers may only open invoices attached to their issue
|
||||
def authorize_customer_invoices
|
||||
return true unless customer_token_only?
|
||||
|
||||
allowed = customer_token.issue&.invoice_ids.to_a.map(&:to_s)
|
||||
render_403 if invoice_ids.empty? || (invoice_ids - allowed).any?
|
||||
end
|
||||
|
||||
# Logs messages with a consistent prefix for easier debugging.
|
||||
def log(msg)
|
||||
Rails.logger.info "[InvoiceController] #{msg}"
|
||||
|
||||
@@ -0,0 +1,106 @@
|
||||
#The MIT License (MIT)
|
||||
#
|
||||
#Copyright (c) 2026 rick barrette
|
||||
#
|
||||
#Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
|
||||
#
|
||||
#The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
|
||||
#
|
||||
#THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
||||
|
||||
class ItemsController < ApplicationController
|
||||
layout 'admin'
|
||||
menu_item :redmine_qbo_items
|
||||
|
||||
# The item catalog is pushed to QuickBooks, so managing it is admin-only. The autocomplete feeds the
|
||||
# line item form on issues and is allowed with the "Add line items" or "Edit line items" permission.
|
||||
before_action :require_admin, except: :autocomplete
|
||||
before_action :authorize_global, only: :autocomplete
|
||||
before_action :find_item, only: [:show, :edit, :update, :destroy]
|
||||
|
||||
# Used for autocomplete form
|
||||
def autocomplete
|
||||
term = ActiveRecord::Base.sanitize_sql_like(params[:q].to_s)
|
||||
|
||||
items = Item.where("description LIKE :t OR name LIKE :t OR sku LIKE :t", t: "%#{term}%")
|
||||
.where(active: true)
|
||||
.order(:description)
|
||||
.limit(20)
|
||||
|
||||
render json: items.map { |i|
|
||||
{ id: i.id, name: i.name, sku: i.sku, description: i.description, price: i.unit_price }
|
||||
}
|
||||
end
|
||||
|
||||
def create
|
||||
@item = Item.new(item_params)
|
||||
|
||||
if @item.save
|
||||
redirect_to item_path(@item), notice: l(:notice_successful_create)
|
||||
else
|
||||
render :new, status: :unprocessable_entity
|
||||
end
|
||||
rescue => e
|
||||
log "Unexpected error creating item: #{e.message}"
|
||||
|
||||
# Regex now matches across line breaks
|
||||
existing_id = e.message[/Duplicate Name Exists Error:[\s\S]*Id=(\d+)/, 1]&.to_i
|
||||
|
||||
if existing_id
|
||||
flash[:error] = "Name already exists. Redirecting to existing item."
|
||||
redirect_to item_path(existing_id)
|
||||
else
|
||||
flash[:error] = e.message
|
||||
redirect_to new_item_path
|
||||
end
|
||||
end
|
||||
|
||||
def destroy
|
||||
@item.destroy
|
||||
redirect_to items_path, notice: l(:notice_successful_delete)
|
||||
end
|
||||
|
||||
def edit
|
||||
end
|
||||
|
||||
def index
|
||||
@items = Item.order(:name)
|
||||
end
|
||||
|
||||
def new
|
||||
@item = Item.new
|
||||
end
|
||||
|
||||
def show
|
||||
end
|
||||
|
||||
def sync
|
||||
Item.sync
|
||||
redirect_to :home, flash: { notice: I18n.t(:label_syncing) }
|
||||
end
|
||||
|
||||
def update
|
||||
if @item.update(item_params)
|
||||
redirect_to item_path(@item), notice: l(:notice_successful_update)
|
||||
else
|
||||
render :edit, status: :unprocessable_entity
|
||||
end
|
||||
end
|
||||
|
||||
private
|
||||
|
||||
def find_item
|
||||
@item = Item.find(params[:id])
|
||||
rescue ActiveRecord::RecordNotFound
|
||||
render_404
|
||||
end
|
||||
|
||||
def item_params
|
||||
params.require(:item).permit(:name, :description, :sku, :unit_price, :active, :account_id, :type, :taxable)
|
||||
end
|
||||
|
||||
def log(msg)
|
||||
Rails.logger.info "[ItemsController] #{msg}"
|
||||
end
|
||||
|
||||
end
|
||||
@@ -11,16 +11,31 @@
|
||||
class QboController < ApplicationController
|
||||
include AuthHelper
|
||||
|
||||
before_action :require_user, except: :webhook
|
||||
# Connecting to QuickBooks and syncing are admin-only. Billing needs the "Bill issues" permission.
|
||||
# The webhook is called by Intuit, not a user, and is verified by its signature instead.
|
||||
before_action :require_admin, except: [:webhook, :bill]
|
||||
before_action :require_login, only: :bill
|
||||
skip_before_action :verify_authenticity_token, :check_if_login_required, only: :webhook
|
||||
|
||||
# Session key for the OAuth "state" value, which ties the callback to the admin who started connecting
|
||||
OAUTH_STATE_SESSION_KEY = :qbo_oauth_state
|
||||
|
||||
# Initiates the OAuth authentication process by redirecting the user to the QuickBooks authorization URL. The callback URL is generated based on the application's settings and routes.
|
||||
def authenticate
|
||||
redirect_to QboOauthService.authorization_url(callback_url: callback_url)
|
||||
state = SecureRandom.urlsafe_base64(32)
|
||||
session[OAUTH_STATE_SESSION_KEY] = state
|
||||
redirect_to QboOauthService.authorization_url(callback_url: callback_url, state: state), allow_other_host: true
|
||||
end
|
||||
|
||||
# Handles the OAuth callback from QuickBooks. Exchanges the authorization code for access and refresh tokens, saves the connection details, and redirects to the sync page with a success notice. If any error occurs during the process, logs the error and redirects back to the plugin settings page with an error message.
|
||||
def oauth_callback
|
||||
# Only accept a callback for a connection this admin started (prevents swapping in another QBO company)
|
||||
expected_state = session.delete(OAUTH_STATE_SESSION_KEY).to_s
|
||||
unless expected_state.present? && ActiveSupport::SecurityUtils.secure_compare(expected_state, params[:state].to_s)
|
||||
log "OAuth callback rejected: state did not match"
|
||||
return redirect_to plugin_settings_path(:redmine_qbo), flash: { error: I18n.t(:notice_qbo_oauth_state_mismatch) }
|
||||
end
|
||||
|
||||
QboOauthService.exchange!(code: params[:code], callback_url: callback_url, realm_id: params[:realmId])
|
||||
|
||||
redirect_to qbo_sync_path, flash: { notice: I18n.t(:label_connected) }
|
||||
@@ -32,8 +47,10 @@ class QboController < ApplicationController
|
||||
|
||||
# Manual billing endpoint to trigger the billing process for a specific issue. Validates the issue and its associations, enqueues a job to bill the issue's time entries, and redirects back to the issue with a notice. If validation fails, redirects back with an error message.
|
||||
def bill
|
||||
issue = Issue.find_by(id: params[:id])
|
||||
raise I18n.t(:notice_error_issue_not_found) unless issue
|
||||
issue = Issue.visible.find_by(id: params[:id])
|
||||
return render_404 unless issue
|
||||
return deny_access unless User.current.allowed_to?(:bill_issues, issue.project)
|
||||
|
||||
raise I18n.t(:notice_billing_error_no_customer) unless issue.customer
|
||||
raise I18n.t(:notice_billing_error_no_employee) unless issue.assigned_to&.employee_id.present?
|
||||
raise I18n.t(:notice_billing_error_no_qbo) unless Qbo.exists?
|
||||
|
||||
@@ -0,0 +1,245 @@
|
||||
#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.
|
||||
|
||||
# Writes, edits and emails QuickBooks estimates from Redmine, on a page laid out like QuickBooks' estimate screen.
|
||||
class QboEstimatesController < ApplicationController
|
||||
|
||||
before_action :require_admin, only: :refresh_company
|
||||
before_action :authorize_global, except: :refresh_company
|
||||
before_action :require_sender_for_save_and_send, only: [:create, :update]
|
||||
before_action :load_issue_preview, only: [:issues_preview, :create_issues]
|
||||
|
||||
helper :projects
|
||||
helper :custom_fields
|
||||
|
||||
# Saving an estimate can take a few QuickBooks calls; any of them can fail with a message worth showing
|
||||
QBO_ERRORS = [RedmineQboBilling::EstimateWriter::Error, Quickbooks::IntuitRequestException,
|
||||
Quickbooks::InvalidModelException, Quickbooks::AuthorizationFailure,
|
||||
# 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>)
|
||||
def new
|
||||
if 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
|
||||
rescue *QBO_ERRORS => e
|
||||
flash[:error] = qbo_message(e)
|
||||
redirect_back_or_default home_path
|
||||
end
|
||||
|
||||
def create
|
||||
@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)
|
||||
finish_save(saved, l(:notice_estimate_saved_in_quickbooks, number: saved.doc_number))
|
||||
rescue *QBO_ERRORS => e
|
||||
show_error(e, :new)
|
||||
end
|
||||
|
||||
def edit
|
||||
@form = RedmineQboBilling::EstimateWriter.load(params[:id])
|
||||
@linked_issues = RedmineQboBilling::EstimateWriter.linked_issues(@form.id).visible.to_a
|
||||
rescue *QBO_ERRORS => e
|
||||
flash[:error] = qbo_message(e)
|
||||
redirect_back_or_default home_path
|
||||
end
|
||||
|
||||
def update
|
||||
@form = RedmineQboBilling::EstimateForm.from_params(estimate_params, id: params[:id])
|
||||
@form.sales_person = params.dig(:estimate, :sales_person).to_s
|
||||
return show_invalid(:edit) unless @form.valid?
|
||||
|
||||
saved = RedmineQboBilling::EstimateWriter.save(@form, user: User.current)
|
||||
finish_save(saved, l(:notice_estimate_saved_in_quickbooks, number: saved.doc_number))
|
||||
rescue RedmineQboBilling::EstimateWriter::Conflict => e
|
||||
@conflict = true
|
||||
show_error(e, :edit)
|
||||
rescue *QBO_ERRORS => e
|
||||
show_error(e, :edit)
|
||||
end
|
||||
|
||||
# Emails an estimate that's already saved (e.g. resending it)
|
||||
def send_email
|
||||
sent = RedmineQboBilling::EstimateWriter.send_email(params[:id], params[:email])
|
||||
flash[:notice] = l(:notice_estimate_sent, number: sent.doc_number, email: sent.bill_email&.address || params[:email])
|
||||
redirect_to edit_qbo_estimate_path(params[:id])
|
||||
rescue *QBO_ERRORS => e
|
||||
flash[:error] = qbo_message(e)
|
||||
redirect_to edit_qbo_estimate_path(params[:id])
|
||||
end
|
||||
|
||||
# Preview of the issues that can be created from the estimate's labor lines. Each line gets a tracker and
|
||||
# (optionally) a template before anything is created. Opened from an appointment, the appointment's dates,
|
||||
# technician and vehicle are used (redmine_qbo_calendar's :qbo_billing_issue_defaults).
|
||||
def issues_preview
|
||||
end
|
||||
|
||||
# Creates the issues selected on the preview page, all or nothing
|
||||
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)
|
||||
|
||||
if created.any?
|
||||
Redmine::Hook.call_hook(:qbo_billing_issues_created, { estimate: @estimate, issues: created, params: params })
|
||||
flash[:notice] = l(:notice_estimate_issues_created, count: created.size)
|
||||
redirect_to @return_path
|
||||
else
|
||||
# Rebuild the fields so the form keeps what was entered
|
||||
@field_set = RedmineQboBilling::IssueFieldSet.new(project: @target_project, trackers: @trackers,
|
||||
values: @custom_field_values)
|
||||
render :issues_preview, status: :unprocessable_entity
|
||||
end
|
||||
end
|
||||
|
||||
# Customer details for the editor when a customer is picked: email, billing address and vehicles (VINs)
|
||||
def customer_info
|
||||
customer = Customer.find_by(id: params[:customer_id])
|
||||
return render(json: {}, status: :not_found) unless customer
|
||||
|
||||
vehicles = customer.respond_to?(:vehicles) ? customer.vehicles.to_a : []
|
||||
render json: {
|
||||
id: customer.id,
|
||||
name: customer.name,
|
||||
email: RedmineQboBilling::EstimateWriter.customer_email(customer),
|
||||
billing_address: RedmineQboBilling::EstimateWriter.customer_address(customer),
|
||||
vehicles: vehicles.select { |v| v.vin.present? }.map { |v| { vin: v.vin, name: v.to_s } }
|
||||
}
|
||||
end
|
||||
|
||||
# Product/service search for the line table (the QuickBooks item list)
|
||||
def items
|
||||
|
||||
term = "%#{ActiveRecord::Base.sanitize_sql_like(params[:q].to_s.strip)}%"
|
||||
items = Item.where(active: true)
|
||||
.where("name LIKE :t OR sku LIKE :t OR description LIKE :t", t: term)
|
||||
.order(:name)
|
||||
.limit(25)
|
||||
|
||||
render json: items.map { |item|
|
||||
{ id: item.id, name: item.name, sku: item.sku, description: item.description,
|
||||
price: item.unit_price&.to_s, taxable: item.taxable != false }
|
||||
}
|
||||
end
|
||||
|
||||
# Re-reads the QuickBooks custom fields and estimate settings (e.g. after renaming a custom field)
|
||||
def refresh_company
|
||||
RedmineQboBilling::Company.refresh!
|
||||
flash[:notice] = l(:notice_estimate_settings_refreshed)
|
||||
redirect_back_or_default home_path
|
||||
end
|
||||
|
||||
private
|
||||
|
||||
# Everything the issues preview needs: the local estimate, defaults from other plugins, the target project,
|
||||
# its trackers, templates and custom fields
|
||||
def load_issue_preview
|
||||
@estimate = Estimate.find_by(id: params[:id])
|
||||
unless @estimate
|
||||
EstimateSyncService.new.sync_by_id(params[:id])
|
||||
@estimate = Estimate.find_by(id: params[:id])
|
||||
end
|
||||
return render_404 unless @estimate
|
||||
|
||||
@defaults = issue_defaults
|
||||
@builder = RedmineQboBilling::EstimateIssueBuilder.new(@estimate, defaults: @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
|
||||
chosen = @available_projects.detect { |p| p.id == params[:project_id].to_i } if params[:project_id].present?
|
||||
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
|
||||
return deny_access unless @target_project
|
||||
|
||||
@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)
|
||||
@rows ||= {}
|
||||
rescue *QBO_ERRORS => e
|
||||
flash[:error] = qbo_message(e)
|
||||
redirect_back_or_default home_path
|
||||
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 })
|
||||
(results.detect { |r| r.is_a?(Hash) && r.any? } || {}).symbolize_keys
|
||||
end
|
||||
|
||||
# The shared custom field values from the preview form: { custom_field_id => value }
|
||||
def submitted_custom_field_values
|
||||
values = params.dig(:issue, :custom_field_values)
|
||||
values.respond_to?(:to_unsafe_h) ? values.to_unsafe_h : {}
|
||||
end
|
||||
|
||||
def estimate_params
|
||||
params.require(:estimate).permit(
|
||||
:sync_token, :total_tax, :discount, :email_status, :txn_status,
|
||||
*RedmineQboBilling::EstimateForm::HEADER_ATTRIBUTES,
|
||||
lines: RedmineQboBilling::EstimateForm::Line::PARAMS
|
||||
)
|
||||
end
|
||||
|
||||
def save_and_send?
|
||||
params[:save_and_send].present?
|
||||
end
|
||||
|
||||
def require_sender_for_save_and_send
|
||||
deny_access if save_and_send? && !RedmineQboBilling.sender?
|
||||
end
|
||||
|
||||
# After saving: email it if asked, then reopen the saved estimate
|
||||
def finish_save(saved, notice)
|
||||
if save_and_send?
|
||||
begin
|
||||
sent = RedmineQboBilling::EstimateWriter.send_email(saved.id, @form.email)
|
||||
notice = l(:notice_estimate_saved_and_sent, number: sent.doc_number, email: sent.bill_email&.address || @form.email)
|
||||
rescue *QBO_ERRORS => e
|
||||
flash[:error] = l(:error_estimate_saved_not_sent, message: qbo_message(e))
|
||||
end
|
||||
end
|
||||
flash[:notice] = notice
|
||||
redirect_to edit_qbo_estimate_path(saved.id)
|
||||
end
|
||||
|
||||
def show_error(error, view)
|
||||
logger.warn "[RedmineQboBilling] #{error.class}: #{qbo_message(error)}"
|
||||
@form.errors.add(:base, qbo_message(error))
|
||||
show_invalid(view)
|
||||
end
|
||||
|
||||
# Shows the form again with what was typed. Empty rows are dropped so the line numbers in the
|
||||
# error messages match the table, and the billing address (display only) is looked up again.
|
||||
def show_invalid(view)
|
||||
@form.lines = @form.filled_lines
|
||||
customer = Customer.find_by(id: @form.customer_id) if @form.customer_id.present?
|
||||
@form.billing_address = RedmineQboBilling::EstimateWriter.customer_address(customer) if customer
|
||||
render view, status: :unprocessable_entity
|
||||
end
|
||||
|
||||
# QuickBooks errors carry their detail separately from the message
|
||||
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
|
||||
@@ -0,0 +1,142 @@
|
||||
#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.
|
||||
|
||||
# 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
|
||||
|
||||
before_action :authorize_global
|
||||
before_action :require_sender_for_save_and_send, only: [:create, :update]
|
||||
before_action :find_customer, only: :import_options
|
||||
|
||||
QBO_ERRORS = QboEstimatesController::QBO_ERRORS
|
||||
|
||||
# A blank invoice, or one made from an estimate (?estimate_id=<estimate id>)
|
||||
def new
|
||||
@form =
|
||||
if params[:estimate_id].present?
|
||||
RedmineQboBilling::InvoiceWriter.from_estimate(params[:estimate_id], user: User.current)
|
||||
else
|
||||
customer = Customer.find_by(id: params[:customer_id]) if params[:customer_id].present?
|
||||
RedmineQboBilling::InvoiceWriter.new_form(customer: customer, user: User.current)
|
||||
end
|
||||
rescue *QBO_ERRORS => e
|
||||
flash[:error] = qbo_message(e)
|
||||
redirect_back_or_default home_path
|
||||
end
|
||||
|
||||
def create
|
||||
@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)
|
||||
finish_save(saved, l(:notice_invoice_saved_in_quickbooks, number: saved.doc_number))
|
||||
rescue *QBO_ERRORS => e
|
||||
show_error(e, :new)
|
||||
end
|
||||
|
||||
def edit
|
||||
@form = RedmineQboBilling::InvoiceWriter.load(params[:id])
|
||||
rescue *QBO_ERRORS => e
|
||||
flash[:error] = qbo_message(e)
|
||||
redirect_back_or_default home_path
|
||||
end
|
||||
|
||||
def update
|
||||
@form = RedmineQboBilling::EstimateForm.from_params(invoice_params, id: params[:id], document: 'invoice')
|
||||
@form.sales_person = params.dig(:estimate, :sales_person).to_s
|
||||
return show_invalid(:edit) unless @form.valid?
|
||||
|
||||
saved = RedmineQboBilling::InvoiceWriter.save(@form, user: User.current)
|
||||
finish_save(saved, l(:notice_invoice_saved_in_quickbooks, number: saved.doc_number))
|
||||
rescue RedmineQboBilling::InvoiceWriter::Conflict => e
|
||||
@conflict = true
|
||||
show_error(e, :edit)
|
||||
rescue *QBO_ERRORS => e
|
||||
show_error(e, :edit)
|
||||
end
|
||||
|
||||
# Emails an invoice that's already saved (e.g. resending it)
|
||||
def send_email
|
||||
sent = RedmineQboBilling::InvoiceWriter.send_email(params[:id], params[:email])
|
||||
flash[:notice] = l(:notice_invoice_sent, number: sent.doc_number, email: sent.bill_email&.address || params[:email])
|
||||
redirect_to edit_qbo_invoice_path(params[:id])
|
||||
rescue *QBO_ERRORS => e
|
||||
flash[:error] = qbo_message(e)
|
||||
redirect_to edit_qbo_invoice_path(params[:id])
|
||||
end
|
||||
|
||||
# The customer's billable time and open estimates, for the Import panel
|
||||
def import_options
|
||||
render json: RedmineQboBilling::InvoiceWriter.import_options(@customer, issue_ids: Array(params[:issue_ids]))
|
||||
rescue *QBO_ERRORS => e
|
||||
render json: { error: qbo_message(e) }, status: :unprocessable_entity
|
||||
end
|
||||
|
||||
private
|
||||
|
||||
def find_customer
|
||||
@customer = Customer.find_by(id: params[:customer_id])
|
||||
render(json: { error: l(:error_estimate_needs_customer) }, status: :not_found) unless @customer
|
||||
end
|
||||
|
||||
def invoice_params
|
||||
params.require(:estimate).permit(
|
||||
:sync_token, :total_tax, :discount, :email_status, :txn_status, :balance,
|
||||
*RedmineQboBilling::EstimateForm::HEADER_ATTRIBUTES,
|
||||
linked_estimate_ids: [],
|
||||
lines: RedmineQboBilling::EstimateForm::Line::PARAMS
|
||||
)
|
||||
end
|
||||
|
||||
def save_and_send?
|
||||
params[:save_and_send].present?
|
||||
end
|
||||
|
||||
def require_sender_for_save_and_send
|
||||
deny_access if save_and_send? && !RedmineQboBilling.invoice_sender?
|
||||
end
|
||||
|
||||
# After saving: email it if asked, then reopen the saved invoice
|
||||
def finish_save(saved, notice)
|
||||
if save_and_send?
|
||||
begin
|
||||
sent = RedmineQboBilling::InvoiceWriter.send_email(saved.id, @form.email)
|
||||
notice = l(:notice_invoice_saved_and_sent, number: sent.doc_number, email: sent.bill_email&.address || @form.email)
|
||||
rescue *QBO_ERRORS => e
|
||||
flash[:error] = l(:error_estimate_saved_not_sent, message: qbo_message(e))
|
||||
end
|
||||
end
|
||||
flash[:notice] = notice
|
||||
redirect_to edit_qbo_invoice_path(saved.id)
|
||||
end
|
||||
|
||||
def show_error(error, view)
|
||||
logger.warn "[RedmineQboBilling] #{error.class}: #{qbo_message(error)}"
|
||||
@form.errors.add(:base, qbo_message(error))
|
||||
show_invalid(view)
|
||||
end
|
||||
|
||||
# Shows the form again with what was typed (see QboEstimatesController#show_invalid)
|
||||
def show_invalid(view)
|
||||
@form.lines = @form.filled_lines
|
||||
customer = Customer.find_by(id: @form.customer_id) if @form.customer_id.present?
|
||||
@form.billing_address = RedmineQboBilling::EstimateWriter.customer_address(customer) if customer
|
||||
render view, 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
|
||||
@@ -0,0 +1,104 @@
|
||||
#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.
|
||||
|
||||
# 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.
|
||||
class QboPaymentsController < ApplicationController
|
||||
|
||||
before_action :authorize_global
|
||||
|
||||
QBO_ERRORS = QboEstimatesController::QBO_ERRORS
|
||||
|
||||
# The customer's payments, newest first, read from QuickBooks
|
||||
def index
|
||||
@customer = Customer.find_by(id: params[:customer_id])
|
||||
return render_404 unless @customer
|
||||
|
||||
@payments = RedmineQboBilling::PaymentWriter.customer_payments(@customer)
|
||||
@totals = RedmineQboBilling::PaymentWriter.payment_totals(@payments)
|
||||
rescue *QBO_ERRORS => e
|
||||
@payments = []
|
||||
@totals = RedmineQboBilling::PaymentWriter.payment_totals([])
|
||||
flash.now[:error] = qbo_message(e)
|
||||
end
|
||||
|
||||
def new
|
||||
customer = Customer.find_by(id: params[:customer_id]) if params[:customer_id].present?
|
||||
@form = RedmineQboBilling::PaymentWriter.new_form(customer: customer, user: User.current)
|
||||
load_choices
|
||||
end
|
||||
|
||||
def create
|
||||
@form = RedmineQboBilling::PaymentForm.from_params(payment_params)
|
||||
return show_form unless @form.valid?
|
||||
|
||||
payment = RedmineQboBilling::PaymentWriter.save(@form)
|
||||
flash[:notice] = l(:notice_payment_saved, amount: view_context.number_to_currency(payment.total))
|
||||
redirect_to qbo_payment_path(payment.id)
|
||||
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)
|
||||
rescue *QBO_ERRORS => e
|
||||
flash[:error] = qbo_message(e)
|
||||
redirect_back_or_default home_path
|
||||
end
|
||||
|
||||
# QuickBooks' PDF of the payment, shown in the browser to print
|
||||
def pdf
|
||||
data = RedmineQboBilling::PaymentWriter.pdf(params[:id])
|
||||
send_data data, type: 'application/pdf', disposition: 'inline', filename: "payment-#{params[:id].to_i}.pdf"
|
||||
rescue *QBO_ERRORS => e
|
||||
flash[:error] = qbo_message(e)
|
||||
redirect_to qbo_payment_path(params[:id])
|
||||
end
|
||||
|
||||
# The customer's open invoices, oldest first, so the page can show how the payment will be applied
|
||||
def open_invoices
|
||||
customer = Customer.find_by(id: params[:customer_id])
|
||||
return render(json: [], status: :not_found) unless customer
|
||||
|
||||
render json: RedmineQboBilling::PaymentWriter.open_invoices(customer)
|
||||
rescue *QBO_ERRORS => e
|
||||
render json: { error: qbo_message(e) }, status: :unprocessable_entity
|
||||
end
|
||||
|
||||
private
|
||||
|
||||
def payment_params
|
||||
params.require(:payment).permit(*RedmineQboBilling::PaymentForm::ATTRIBUTES, 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) : []
|
||||
rescue *QBO_ERRORS => e
|
||||
@open_invoices = []
|
||||
flash.now[:error] = qbo_message(e)
|
||||
end
|
||||
|
||||
def show_form
|
||||
load_choices
|
||||
render :new, status: :unprocessable_entity
|
||||
end
|
||||
|
||||
def qbo_message(error)
|
||||
detail = error.respond_to?(:detail) ? error.detail.to_s : ''
|
||||
message = error.message.to_s
|
||||
detail.present? && !message.include?(detail) ? "#{message}: #{detail}" : message
|
||||
end
|
||||
end
|
||||
+37
-23
@@ -10,47 +10,61 @@
|
||||
|
||||
module AuthHelper
|
||||
|
||||
def require_user
|
||||
return unless session[:token].nil?
|
||||
if !User.current.logged?
|
||||
flash[:error] = t :notice_forbidden
|
||||
render_403
|
||||
end
|
||||
# The active customer share token stored in the session by customers#view, if any.
|
||||
def customer_token
|
||||
return @customer_token if defined?(@customer_token)
|
||||
|
||||
@customer_token = session[:token].present? ? CustomerToken.active.find_by(token: session[:token]) : nil
|
||||
end
|
||||
|
||||
|
||||
# True when the visitor is a customer using a share link rather than a logged-in user.
|
||||
def customer_token_only?
|
||||
!User.current.logged? && customer_token.present?
|
||||
end
|
||||
|
||||
# Logged-in users pass. Customers with an active share link pass too (each controller then limits them
|
||||
# to their own issue's documents). Everyone else is sent to the login page.
|
||||
def require_login_or_customer_token
|
||||
return true if User.current.logged?
|
||||
return true if customer_token
|
||||
|
||||
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(params[:project_id])
|
||||
project = Project.find_by(id: params[:project_id])
|
||||
return false if project.nil?
|
||||
return true if User.current.allowed_to?(action, project)
|
||||
false
|
||||
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
|
||||
render_403
|
||||
end
|
||||
end
|
||||
|
||||
def globaly_allowed_to?( action)
|
||||
|
||||
# True if the user has the permission through any of their roles (or is an admin)
|
||||
def globaly_allowed_to?(action)
|
||||
return false if User.current.nil?
|
||||
|
||||
projects = Project.all
|
||||
projects.each { |p|
|
||||
if User.current.allowed_to?(action, p)
|
||||
return true
|
||||
end
|
||||
}
|
||||
false
|
||||
User.current.allowed_to?(action, nil, global: true)
|
||||
end
|
||||
|
||||
|
||||
end
|
||||
@@ -17,23 +17,36 @@ class BillIssueTimeJob < ActiveJob::Base
|
||||
issue = Issue.find(issue_id)
|
||||
|
||||
log "Starting billing for issue ##{issue.id}"
|
||||
failure = nil
|
||||
|
||||
issue.with_lock do
|
||||
unbilled_entries = issue.time_entries.where(billed: [false, nil]).lock
|
||||
unbilled_entries = issue.time_entries.where(billed: [false, nil]).lock.includes(:activity).to_a
|
||||
return if unbilled_entries.blank?
|
||||
|
||||
totals = aggregate_hours(unbilled_entries)
|
||||
return if totals.blank?
|
||||
log "Aggregated hours for billing: #{totals.inspect}"
|
||||
|
||||
qbo = QboConnectionService.current!
|
||||
qbo.perform_authenticated_request do |access_token|
|
||||
create_time_activities(issue, totals, access_token, qbo)
|
||||
# Activities already sent to QBO (or deliberately skipped) in this run. If QBO fails part way, or the
|
||||
# token refresh re-runs the block, finished activities are not sent again.
|
||||
done = []
|
||||
begin
|
||||
qbo = QboConnectionService.current!
|
||||
qbo.perform_authenticated_request do |access_token|
|
||||
create_time_activities(issue, totals, access_token, qbo, done)
|
||||
end
|
||||
rescue => e
|
||||
failure = e
|
||||
end
|
||||
|
||||
# Only mark billed AFTER successful QBO creation
|
||||
unbilled_entries.update_all(billed: true)
|
||||
# Mark billed only the entries whose activity was finished, and commit that even if a later
|
||||
# activity failed, so a retry only sends what's left
|
||||
finished = unbilled_entries.select { |entry| done.include?(entry.activity&.name) }
|
||||
TimeEntry.where(id: finished.map(&:id)).update_all(billed: true) if finished.any?
|
||||
end
|
||||
|
||||
raise failure if failure
|
||||
|
||||
log "Completed billing for issue ##{issue.id}"
|
||||
Qbo.update_time_stamp
|
||||
rescue => e
|
||||
@@ -45,25 +58,34 @@ class BillIssueTimeJob < ActiveJob::Base
|
||||
|
||||
# Aggregate time entries by activity name and sum their hours
|
||||
def aggregate_hours(entries)
|
||||
entries.includes(:activity)
|
||||
.group_by { |e| e.activity&.name }
|
||||
entries.group_by { |e| e.activity&.name }
|
||||
.transform_values { |rows| rows.sum(&:hours) }
|
||||
.compact
|
||||
end
|
||||
|
||||
# Create TimeActivity records in QBO for each activity type with the appropriate hours and link them to the issue's assigned employee and customer
|
||||
def create_time_activities(issue, totals, access_token, qbo)
|
||||
# Adds each activity name to done once it has been created in QBO (or skipped because it can't be billed).
|
||||
def create_time_activities(issue, totals, access_token, qbo, done)
|
||||
log "Creating TimeActivity records in QBO for issue ##{issue.id}"
|
||||
|
||||
time_service = Quickbooks::Service::TimeActivity.new( company_id: qbo.realm_id, access_token: access_token)
|
||||
item_service = Quickbooks::Service::Item.new( company_id: qbo.realm_id, access_token: access_token )
|
||||
|
||||
totals.each do |activity_name, hours_float|
|
||||
next if activity_name.blank?
|
||||
next if hours_float.to_f <= 0
|
||||
next if done.include?(activity_name)
|
||||
|
||||
# Not billable: skipped, and marked billed as before
|
||||
if activity_name.blank? || hours_float.to_f <= 0
|
||||
done << activity_name
|
||||
next
|
||||
end
|
||||
|
||||
item = find_item(item_service, activity_name)
|
||||
next unless item
|
||||
unless item
|
||||
log "No QBO item named #{activity_name.inspect}; skipping"
|
||||
done << activity_name
|
||||
next
|
||||
end
|
||||
|
||||
hours, minutes = convert_hours(hours_float)
|
||||
|
||||
@@ -82,6 +104,7 @@ class BillIssueTimeJob < ActiveJob::Base
|
||||
log "Creating TimeActivity for #{activity_name} (#{hours}h #{minutes}m)"
|
||||
|
||||
time_service.create(time_entry)
|
||||
done << activity_name
|
||||
end
|
||||
end
|
||||
|
||||
|
||||
@@ -0,0 +1,41 @@
|
||||
#The MIT License (MIT)
|
||||
#
|
||||
#Copyright (c) 2026 rick barrette
|
||||
#
|
||||
#Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
|
||||
#
|
||||
#The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
|
||||
#
|
||||
#THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
||||
|
||||
class Account < QboBaseModel
|
||||
has_many :items
|
||||
validates_presence_of :id, :name
|
||||
self.primary_key = :id
|
||||
qbo_sync push: false
|
||||
before_save :clear_other_defaults, if: :default?
|
||||
|
||||
# Returns the account marked as default
|
||||
def self.get_default
|
||||
find_by(default: true)
|
||||
end
|
||||
|
||||
# Returns QBO Refrence object for the account
|
||||
def ref
|
||||
r = Quickbooks::Model::BaseReference.new
|
||||
r.value = id
|
||||
r.name = name
|
||||
return r
|
||||
end
|
||||
|
||||
def to_s
|
||||
name
|
||||
end
|
||||
|
||||
private
|
||||
|
||||
def clear_other_defaults
|
||||
Account.where.not(id: id).update_all(default: false)
|
||||
end
|
||||
|
||||
end
|
||||
@@ -21,8 +21,8 @@ class Customer < QboBaseModel
|
||||
self.primary_key = :id
|
||||
qbo_sync push: true
|
||||
|
||||
# Normalize the local database column :name
|
||||
normalizes :name, with: ->(name) { name.to_s.strip.titleize }
|
||||
# Normalize the local database column :name (capitalize each word, keep acronyms like LLC as typed)
|
||||
normalizes :name, with: ->(name) { RedmineQbo::TitleCase.call(name.to_s.strip) }
|
||||
|
||||
acts_as_searchable columns: %w[name phone_number mobile_phone_number ],
|
||||
scope: ->(_context) { left_joins(:project) },
|
||||
|
||||
@@ -0,0 +1,68 @@
|
||||
#The MIT License (MIT)
|
||||
#
|
||||
#Copyright (c) 2026 rick barrette
|
||||
#
|
||||
#Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
|
||||
#
|
||||
#The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
|
||||
#
|
||||
#THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
||||
|
||||
class Item < QboBaseModel
|
||||
belongs_to :account, optional: true
|
||||
|
||||
validates_presence_of :id, :description
|
||||
validates :unit_price, numericality: { greater_than_or_equal_to: 0 }
|
||||
self.primary_key = :id
|
||||
self.inheritance_column = :_type_disabled
|
||||
qbo_sync push: true
|
||||
after_initialize :set_defaults, if: :new_record?
|
||||
before_destroy :make_inactive
|
||||
|
||||
# Updates Both local & remote DB account ref (a blank or unknown account leaves QBO's ref unchanged)
|
||||
def account_id=(id)
|
||||
account = Account.find_by(id: id) if id.present?
|
||||
details.income_account_ref = account.ref if account
|
||||
super
|
||||
end
|
||||
|
||||
# Updates Both local & remote DB description
|
||||
def description=(s)
|
||||
details.description = s
|
||||
super
|
||||
end
|
||||
|
||||
# Updates Both local & remote DB name
|
||||
def name=(s)
|
||||
details.name = s
|
||||
super
|
||||
end
|
||||
|
||||
def make_inactive
|
||||
details.active = false
|
||||
push_to_qbo
|
||||
end
|
||||
|
||||
def set_defaults
|
||||
self.taxable = true if taxable.nil?
|
||||
end
|
||||
|
||||
# Updates Both local & remote DB sku
|
||||
def sku=(s)
|
||||
details.sku = s
|
||||
super
|
||||
end
|
||||
|
||||
# Updates Both local & remote DB type
|
||||
def type=(s)
|
||||
details.type = s.to_s
|
||||
super
|
||||
end
|
||||
|
||||
# Updates Both local & remote DB price
|
||||
def unit_price=(s)
|
||||
details.unit_price = s
|
||||
super
|
||||
end
|
||||
|
||||
end
|
||||
@@ -0,0 +1,19 @@
|
||||
#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.
|
||||
|
||||
# Link between a QuickBooks estimate line and the issue created from it (see EstimateIssueBuilder)
|
||||
class QboEstimateLineIssue < ActiveRecord::Base
|
||||
belongs_to :issue
|
||||
|
||||
validates :estimate_id, :line_id, presence: true
|
||||
validates :line_id, uniqueness: { scope: :estimate_id }
|
||||
|
||||
before_create { self.created_on ||= Time.current }
|
||||
end
|
||||
@@ -0,0 +1,23 @@
|
||||
#The MIT License (MIT)
|
||||
#
|
||||
#Copyright (c) 2026 rick barrette
|
||||
#
|
||||
#Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
|
||||
#
|
||||
#The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
|
||||
#
|
||||
#THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
||||
|
||||
class AccountSyncService < SyncServiceBase
|
||||
|
||||
private
|
||||
|
||||
# Specify the local model this service syncs
|
||||
def self.model_class
|
||||
Account
|
||||
end
|
||||
|
||||
map_attribute :active, :active?
|
||||
map_attributes :classification, :description, :id, :name
|
||||
|
||||
end
|
||||
@@ -0,0 +1,233 @@
|
||||
#The MIT License (MIT)
|
||||
#
|
||||
#Copyright (c) 2016 - 2026 rick barrette
|
||||
#
|
||||
#Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
|
||||
#
|
||||
#The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
|
||||
#
|
||||
#THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
||||
|
||||
require 'csv'
|
||||
require 'did_you_mean'
|
||||
require 'text'
|
||||
|
||||
# Finds customers by name and/or phone, tolerant of the ways duplicates sneak in:
|
||||
# - nicknames: "Bill Smith" finds "William Smith", "Bob" finds "Robert" (about 2,800 pairs, see data/nicknames)
|
||||
# - sound-alikes: "Jon" finds "John", "Smyth" finds "Smith", "Cathy" finds "Kathy" (Double Metaphone)
|
||||
# - typos: "Willaim Smtih" finds "William Smith"
|
||||
# - word order: "Smith, William" finds "William Smith"
|
||||
# - partial: "will smi" finds "William Smith" while typing
|
||||
# - phone: any 4+ digits, in any format, matched against both phone numbers
|
||||
#
|
||||
# Results are ranked best match first. Only id, name and phone numbers are loaded, and the prepared
|
||||
# search data is cached until a customer changes, so searching stays fast as the customer list grows.
|
||||
class CustomerSearchService
|
||||
DEFAULT_LIMIT = 20
|
||||
|
||||
# Lowest score (0..1) a customer needs to be returned
|
||||
MIN_SCORE = 0.72
|
||||
|
||||
# Bundled nickname data (Apache 2.0, see data/nicknames/README.md)
|
||||
NICKNAMES_CSV = File.expand_path('../../data/nicknames/names.csv', __dir__)
|
||||
|
||||
# Groups missing from the bundled data. Add more here: every name in a group matches every other.
|
||||
EXTRA_NICKNAME_GROUPS = [
|
||||
%w[william liam],
|
||||
%w[alexander xander],
|
||||
%w[alexandra lexi],
|
||||
%w[theodore theo],
|
||||
%w[christopher kit]
|
||||
].freeze
|
||||
|
||||
# Words that don't help tell customers apart
|
||||
STOP_WORDS = %w[and the llc inc co corp company].freeze
|
||||
|
||||
# Returns matching Customer records, best match first.
|
||||
def self.call(name: nil, phone: nil, limit: DEFAULT_LIMIT)
|
||||
ids = rank(candidates, name: name, phone: phone, limit: limit).map(&:first)
|
||||
return Customer.none if ids.empty?
|
||||
|
||||
Customer.where(id: ids).in_order_of(:id, ids)
|
||||
end
|
||||
|
||||
# Prepared search rows for every customer, cached until any customer changes. Kept in this process's
|
||||
# memory as well, so each keystroke doesn't reload it from the Rails cache.
|
||||
def self.candidates
|
||||
key = ['customer_search_candidates', 2, Customer.count, Customer.maximum(:updated_at).to_i]
|
||||
cached_key, cached_rows = @candidates
|
||||
return cached_rows if cached_key == key
|
||||
|
||||
rows = Rails.cache.fetch(key, expires_in: 12.hours) do
|
||||
prepare(Customer.pluck(:id, :name, :phone_number, :mobile_phone_number))
|
||||
end
|
||||
@candidates = [key, rows]
|
||||
rows
|
||||
end
|
||||
|
||||
# [[id, name, phone, mobile], ...] -> [[id, name, phone_digits, tokens, sound_codes], ...]
|
||||
def self.prepare(rows)
|
||||
rows.map do |id, name, phone_number, mobile_number|
|
||||
words = tokens(name)
|
||||
phones = [phone_number, mobile_number].compact.map { |n| n.to_s.gsub(/\D/, '') }.reject(&:empty?)
|
||||
[id, name.to_s, phones, words, words.map { |w| sound_codes(w) }]
|
||||
end
|
||||
end
|
||||
|
||||
# Pure ranking over prepared rows (no database), so it can be tested on its own.
|
||||
# Returns [[id, score], ...] best first. A query of mostly digits is also treated as a phone number.
|
||||
def self.rank(prepared, name: nil, phone: nil, limit: DEFAULT_LIMIT)
|
||||
name = name.to_s.strip
|
||||
phone_digits = phone.to_s.gsub(/\D/, '')
|
||||
|
||||
# "401-555-1234" typed into the name box is a phone search
|
||||
name_digits = name.gsub(/\D/, '')
|
||||
if phone_digits.empty? && name_digits.length >= 4 && name_digits.length >= name.gsub(/\s/, '').length * 0.7
|
||||
phone_digits = name_digits
|
||||
name = ''
|
||||
end
|
||||
|
||||
query_words = tokens(name)
|
||||
return [] if query_words.empty? && phone_digits.length < 4
|
||||
|
||||
query = query_words.map { |w| [w, sound_codes(w)] }
|
||||
memo = {} # word-pair scores for this search; customer names repeat words a lot ("smith", "john")
|
||||
|
||||
scored = prepared.filter_map do |id, customer_name, phones, words, codes|
|
||||
score = [
|
||||
phone_digits.length >= 4 ? phone_score(phone_digits, phones) : 0.0,
|
||||
query.any? ? name_score(query, words, codes, memo) : 0.0
|
||||
].max
|
||||
[id, score, customer_name] if score >= MIN_SCORE
|
||||
end
|
||||
|
||||
scored.sort_by { |id, score, customer_name| [-score, customer_name.downcase, id] }
|
||||
.first(limit)
|
||||
.map { |id, score, _| [id, score.round(3)] }
|
||||
end
|
||||
|
||||
# Lowercase words with accents and punctuation removed: "O'Brien-Smith, José" -> ["obrien", "smith", "jose"]
|
||||
def self.tokens(text)
|
||||
normalized = text.to_s.unicode_normalize(:nfkd).gsub(/\p{Mn}/, '').downcase
|
||||
normalized = normalized.gsub(/['’]/, '').gsub(/[^a-z0-9]+/, ' ')
|
||||
words = normalized.split
|
||||
meaningful = words - STOP_WORDS
|
||||
meaningful.empty? ? words : meaningful
|
||||
end
|
||||
|
||||
# Double Metaphone codes (primary and alternate) for a word; empty for very short or numeric words
|
||||
def self.sound_codes(word)
|
||||
return [] if word.length < 3 || word.match?(/\d/)
|
||||
|
||||
Text::Metaphone.double_metaphone(word).compact.reject(&:empty?).uniq
|
||||
end
|
||||
|
||||
def self.phone_score(digits, phones)
|
||||
phones.map do |number|
|
||||
if number == digits || number.end_with?(digits) && digits.length >= 7 then 1.0
|
||||
elsif number.include?(digits) then 0.9
|
||||
else 0.0
|
||||
end
|
||||
end.max || 0.0
|
||||
end
|
||||
|
||||
# Each query word is matched to its best word in the customer's name; the score is the average.
|
||||
# A query word with no match at all halves the score, so "bill jones" won't match "william smith".
|
||||
def self.name_score(query, words, codes, memo = {})
|
||||
return 0.0 if words.empty?
|
||||
|
||||
best = query.map do |q_word, q_codes|
|
||||
scores = (memo[q_word] ||= {})
|
||||
words.each_with_index.map do |c_word, i|
|
||||
scores.fetch(c_word) { scores[c_word] = word_score(q_word, q_codes, c_word, codes[i]) }
|
||||
end.max
|
||||
end
|
||||
score = best.sum / best.size
|
||||
score *= 0.5 if best.any?(&:zero?)
|
||||
|
||||
return score if score >= 0.9 # already a strong match; skip the whole-name comparison
|
||||
|
||||
# Also compare the names with spaces removed, for "Mc Donald" vs "McDonald". Only worth it when the
|
||||
# strings could reach the 0.92 bar at all: same first letter and nearly the same length.
|
||||
query_joined = query.map(&:first).join
|
||||
name_joined = words.join
|
||||
return score unless query_joined[0] == name_joined[0] && (query_joined.length - name_joined.length).abs <= 2
|
||||
|
||||
joined = DidYouMean::JaroWinkler.distance(query_joined, name_joined)
|
||||
[score, joined >= 0.92 ? joined * 0.9 : 0.0].max
|
||||
end
|
||||
|
||||
def self.word_score(query, query_codes, candidate, candidate_codes)
|
||||
return 1.0 if query == candidate
|
||||
return 0.95 if nicknames?(query, candidate)
|
||||
return 0.9 if query.length >= 2 && candidate.start_with?(query) # still typing: "wil" -> "william"
|
||||
return 0.85 if query.length >= 2 && nickname_prefix?(query, candidate) # "bil" -> "william" via "bill"
|
||||
|
||||
similarity = DidYouMean::JaroWinkler.distance(query, candidate)
|
||||
|
||||
# Sounds the same ("jon"/"john", "smyth"/"smith"). The similarity check keeps unrelated words that
|
||||
# happen to share a code (e.g. "john" and "ann" via the Spanish-J alternate) from matching.
|
||||
return 0.88 if similarity >= 0.7 && (query_codes & candidate_codes).any?
|
||||
|
||||
return 0.8 if query.length >= 4 && candidate.include?(query) # "donald" in "mcdonald"
|
||||
return 0.7 if query.length == 1 && candidate.start_with?(query) # an initial
|
||||
|
||||
# Typos. Short words need to be closer to count.
|
||||
threshold = [query.length, candidate.length].min <= 4 ? 0.9 : 0.85
|
||||
similarity >= threshold ? similarity * 0.9 : 0.0
|
||||
end
|
||||
|
||||
# Nickname matching treats the data as connections between names (the file lists both directions,
|
||||
# e.g. "william -> bill" and "bill -> william"). Two names match if they are connected directly, or both
|
||||
# connect to a LONGER name they're short for: "bill" and "will" via "william". Requiring the shared
|
||||
# name to be longer stops unrelated full names linking through a short one: "bill" is listed for both
|
||||
# William and Robert, but that doesn't make William match Robert.
|
||||
def self.nicknames?(a, b)
|
||||
related_names(a).include?(b)
|
||||
end
|
||||
|
||||
# A partly typed nickname of the candidate's name, e.g. "bil" for "william" (via "bill")
|
||||
def self.nickname_prefix?(query, candidate)
|
||||
related_names(candidate).any? { |name| name.start_with?(query) }
|
||||
end
|
||||
|
||||
# All names interchangeable with name, cached per process
|
||||
def self.related_names(name)
|
||||
cache = (@related_names_cache ||= {})
|
||||
cache[name] ||= begin
|
||||
graph = nickname_graph
|
||||
direct = graph.fetch(name, EMPTY)
|
||||
through_full_names = direct.select { |full| full.length > name.length }.flat_map do |full|
|
||||
graph.fetch(full, EMPTY).select { |other| other.length < full.length }
|
||||
end
|
||||
((direct + through_full_names).uniq - [name]).freeze
|
||||
end
|
||||
end
|
||||
|
||||
EMPTY = [].freeze
|
||||
|
||||
# name => [connected names], built once per process from the bundled data plus EXTRA_NICKNAME_GROUPS
|
||||
def self.nickname_graph
|
||||
@nickname_graph ||= begin
|
||||
graph = Hash.new { |h, k| h[k] = [] }
|
||||
connect = lambda do |a, b|
|
||||
next if a.empty? || b.empty? || a == b
|
||||
|
||||
graph[a] << b
|
||||
graph[b] << a
|
||||
end
|
||||
|
||||
if File.exist?(NICKNAMES_CSV)
|
||||
CSV.foreach(NICKNAMES_CSV, headers: true) do |row|
|
||||
connect.call(row['name1'].to_s.strip.downcase, row['name2'].to_s.strip.downcase)
|
||||
end
|
||||
end
|
||||
|
||||
EXTRA_NICKNAME_GROUPS.each do |group|
|
||||
group.combination(2) { |a, b| connect.call(a, b) }
|
||||
end
|
||||
|
||||
graph.transform_values { |names| names.uniq.freeze }.to_h.freeze
|
||||
end
|
||||
end
|
||||
end
|
||||
@@ -0,0 +1,26 @@
|
||||
#The MIT License (MIT)
|
||||
#
|
||||
#Copyright (c) 2026 rick barrette
|
||||
#
|
||||
#Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
|
||||
#
|
||||
#The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
|
||||
#
|
||||
#THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
||||
|
||||
class ItemService < ServiceBase
|
||||
|
||||
private
|
||||
|
||||
def build_qbo_remote
|
||||
log "Building new QBO Item"
|
||||
# New items default to a non-inventory item in the default income account; the item form then
|
||||
# sets the type and account the user chose.
|
||||
item = Quickbooks::Model::Item.new
|
||||
item.type = Quickbooks::Model::Item::NON_INVENTORY_TYPE
|
||||
default_account = Account.get_default
|
||||
item.income_account_ref = default_account.ref if default_account
|
||||
item
|
||||
end
|
||||
|
||||
end
|
||||
@@ -0,0 +1,35 @@
|
||||
#The MIT License (MIT)
|
||||
#
|
||||
#Copyright (c) 2026 rick barrette
|
||||
#
|
||||
#Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
|
||||
#
|
||||
#The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
|
||||
#
|
||||
#THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
||||
|
||||
class ItemSyncService < SyncServiceBase
|
||||
|
||||
private
|
||||
|
||||
# Specify the local model this service syncs
|
||||
def self.model_class
|
||||
Item
|
||||
end
|
||||
|
||||
# Specify a page size of 20, as the API only returns 20 items at a time.
|
||||
def self.page_size
|
||||
20
|
||||
end
|
||||
|
||||
map_attribute :active, :active?
|
||||
map_attribute :taxable, :taxable?
|
||||
# Items without an income account (e.g. categories), or whose account hasn't synced yet, get none
|
||||
# instead of failing the whole sync; the next sync fills it in.
|
||||
map_attribute :account do |remote|
|
||||
account_id = remote.income_account_ref&.value
|
||||
account_id.present? ? Account.find_by(id: account_id.to_i) : nil
|
||||
end
|
||||
map_attributes :description, :id, :name, :sku, :type, :unit_price
|
||||
|
||||
end
|
||||
@@ -12,11 +12,12 @@ class QboOauthService
|
||||
|
||||
# Generates the QuickBooks OAuth authorization URL with the specified callback URL.
|
||||
# The URL includes necessary parameters such as response type, state, and scope.
|
||||
def self.authorization_url(callback_url:)
|
||||
# The state value must be stored by the caller and checked when the callback arrives.
|
||||
def self.authorization_url(callback_url:, state:)
|
||||
client.auth_code.authorize_url(
|
||||
redirect_uri: callback_url,
|
||||
response_type: "code",
|
||||
state: SecureRandom.hex(12),
|
||||
state: state,
|
||||
scope: "com.intuit.quickbooks.accounting"
|
||||
)
|
||||
end
|
||||
|
||||
@@ -0,0 +1,37 @@
|
||||
<h2><%= l(:label_accounts) %></h2>
|
||||
|
||||
<%= form_tag set_default_accounts_path, method: :patch do %>
|
||||
<div class="autoscroll">
|
||||
<table class="list accounts">
|
||||
<thead>
|
||||
<tr>
|
||||
<th style="width:50px;"><%= l(:label_default) %></th>
|
||||
<th><%= l(:field_name) %></th>
|
||||
<th><%= l(:field_description) %></th>
|
||||
<th><%= l(:field_classification) %></th>
|
||||
<th class="center"><%= l(:field_active) %></th>
|
||||
</tr>
|
||||
</thead>
|
||||
|
||||
<tbody>
|
||||
<% @accounts.each do |account| %>
|
||||
<tr class="<%= cycle("odd", "even") %>">
|
||||
<td class="center">
|
||||
<%= radio_button_tag "default_account_id", account.id, account.default %>
|
||||
</td>
|
||||
<td class="name"><strong><%= account.name %></strong></td>
|
||||
<td class="description"><%= truncate(account.description, length: 80) %></td>
|
||||
<td class="classification"><%= account.classification %></td>
|
||||
<td class="active center">
|
||||
<%= checked_image account.active %>
|
||||
</td>
|
||||
</tr>
|
||||
<% end %>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
|
||||
<p class="buttons">
|
||||
<%= submit_tag l(:button_save), class: 'button-small' %>
|
||||
</p>
|
||||
<% end %>
|
||||
@@ -1,15 +0,0 @@
|
||||
<%= call_hook :customer_actions_top, { customer: @customer } %>
|
||||
|
||||
<%= link_to t(:label_create_estimate), "https://qbo.intuit.com/app/estimate?nameId=#{@customer.id}", target: :_blank %>
|
||||
|
||||
<br/>
|
||||
<br/>
|
||||
|
||||
<%= link_to t(:label_create_payment), "https://qbo.intuit.com/app/recvpayment?nameId=#{@customer.id}", target: :_blank %>
|
||||
|
||||
<br/>
|
||||
<br/>
|
||||
|
||||
<%= call_hook :customer_actions_bottom, { customer: @customer } %>
|
||||
|
||||
<%= button_to t(:label_edit_customer), edit_customer_path(@customer), method: :get%>
|
||||
@@ -2,59 +2,55 @@
|
||||
<tbody>
|
||||
|
||||
<tr>
|
||||
<th><%=t(:label_name)%></th>
|
||||
<th><%= t(:label_name) %></th>
|
||||
<td><%= customer.name %></td>
|
||||
</tr>
|
||||
|
||||
<tr>
|
||||
<th><%=t(:label_email)%></th>
|
||||
<th><%= t(:label_email) %></th>
|
||||
<td><%= customer.email %></td>
|
||||
</tr>
|
||||
|
||||
<tr>
|
||||
<th><%=t(:label_primary_phone)%></th>
|
||||
<th><%= t(:label_primary_phone) %></th>
|
||||
<td><%= number_to_phone(customer&.primary_phone&.gsub(/[^\d]/, '').to_i, area_code: true) %></td>
|
||||
</tr>
|
||||
|
||||
<tr>
|
||||
<th><%=t(:label_mobile_phone)%></th>
|
||||
<th><%= t(:label_mobile_phone) %></th>
|
||||
<td><%= number_to_phone(customer&.mobile_phone&.gsub(/[^\d]/, '').to_i, area_code: true) %></td>
|
||||
</tr>
|
||||
|
||||
<tr>
|
||||
<th><%=t(:label_billing_address)%></th>
|
||||
<td><pre><%= @billing_address %></pre></td>
|
||||
</tr>
|
||||
|
||||
<tr>
|
||||
<th><%=t(:label_shipping_address)%></th>
|
||||
<td><pre><%= @shipping_address %></pre></td>
|
||||
<tr>
|
||||
<th><%= t(:label_billing_address) %></th>
|
||||
<td><pre><%= @billing_address %></pre></td>
|
||||
</tr>
|
||||
|
||||
<tr>
|
||||
<th><%=t(:label_account_balance)%></th>
|
||||
<td>$<%= customer.balance %></td>
|
||||
<th><%= t(:label_shipping_address) %></th>
|
||||
<td><pre><%= @shipping_address %></pre></td>
|
||||
</tr>
|
||||
|
||||
<tr>
|
||||
<th colspan="2"><h4><%=t(:field_notes)%></hr></th>
|
||||
<th><%= t(:label_account_balance) %></th>
|
||||
<td>$<%= customer.balance %></td>
|
||||
</tr>
|
||||
|
||||
<% if customer.notes.present? %>
|
||||
<tr>
|
||||
<th colspan="2"><h4><%= t(:field_notes) %></h4></th>
|
||||
</tr>
|
||||
|
||||
<tr>
|
||||
<td colspan="2">
|
||||
<pre id="note-display" style="text-align: left; white-space: pre-wrap; font-family: inherit;">
|
||||
<%= customer.notes %>
|
||||
</pre>
|
||||
</td>
|
||||
</tr>
|
||||
|
||||
<script>
|
||||
const preElement = document.getElementById('note-display');
|
||||
// This takes the text, trims the edges, and puts it back
|
||||
preElement.textContent = preElement.textContent.trim();
|
||||
</script>
|
||||
<tr>
|
||||
<td colspan="2">
|
||||
<div class="wiki">
|
||||
<%= textilizable(customer, :notes) %>
|
||||
</div>
|
||||
</td>
|
||||
</tr>
|
||||
<% end %>
|
||||
|
||||
</tbody>
|
||||
</table>
|
||||
<br/>
|
||||
<br/>
|
||||
<br/>
|
||||
@@ -1,59 +1,30 @@
|
||||
<div class="row">
|
||||
<div class="span6 columns">
|
||||
<fieldset>
|
||||
<%#
|
||||
Customer form, in Redmine's form style. Also loaded by redmine_qbo_calendar's quick-create popup
|
||||
(hide_submit / hide_toolbar), which relies on the form tag being here and the name field's
|
||||
customer_name id.
|
||||
%>
|
||||
<%= labelled_form_for @customer do |f| %>
|
||||
<%= error_messages_for 'customer' %>
|
||||
|
||||
<%= form_for @customer do |f| %>
|
||||
|
||||
<div class="clearfix">
|
||||
<%=t(:label_display_name)%>
|
||||
<div class="input">
|
||||
<%= f.text_field :name, required: true, class: "customer-name", autocomplete: "off", data: { autocomplete_url: "/customers/autocomplete" } %>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="clearfix">
|
||||
<%=t(:label_primary_phone)%>
|
||||
<div class="input">
|
||||
<%= f.telephone_field :primary_phone, autocomplete: "off" %>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="clearfix">
|
||||
<%=t(:label_mobile_phone)%>:
|
||||
<div class="input">
|
||||
<%= f.telephone_field :mobile_phone, autocomplete: "off" %>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="clearfix">
|
||||
<%=t(:label_email)%>:
|
||||
<div class="input">
|
||||
<%= f.email_field :email, autocomplete: "off" %>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="clearfix">
|
||||
<%=t(:field_notes)%>:
|
||||
<div class="input">
|
||||
<p>
|
||||
<%= content_tag :span, id: "issue_description_and_toolbar" do %>
|
||||
<%= f.text_area :notes,
|
||||
cols: 60,
|
||||
rows: 10,
|
||||
accesskey: accesskey(:edit),
|
||||
class: 'wiki-edit',
|
||||
no_label: true %>
|
||||
<% end %>
|
||||
</p>
|
||||
<%= wikitoolbar_for :issue_description %>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="actions">
|
||||
<%= f.submit %>
|
||||
</div>
|
||||
<div class="box tabular">
|
||||
<p>
|
||||
<%= f.text_field :name, label: :label_display_name, required: true, size: 60,
|
||||
class: 'customer-name', autocomplete: 'off',
|
||||
data: { autocomplete_url: '/customers/autocomplete' } %>
|
||||
</p>
|
||||
<p><%= f.telephone_field :primary_phone, label: :label_primary_phone, size: 20, autocomplete: 'off' %></p>
|
||||
<p><%= f.telephone_field :mobile_phone, label: :label_mobile_phone, size: 20, autocomplete: 'off' %></p>
|
||||
<p><%= f.email_field :email, label: :label_email, size: 60, autocomplete: 'off' %></p>
|
||||
<p>
|
||||
<%= f.text_area :notes, label: :field_notes, rows: 8, class: 'wiki-edit', id: 'customer_notes' %>
|
||||
<% unless local_assigns[:hide_toolbar] %>
|
||||
<%= wikitoolbar_for 'customer_notes' %>
|
||||
<% end %>
|
||||
|
||||
</fieldset>
|
||||
</p>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<% unless local_assigns[:hide_submit] %>
|
||||
<%= submit_tag @customer.new_record? ? l(:button_create) : l(:button_save) %>
|
||||
<%= link_to l(:button_cancel), @customer.new_record? ? customers_path : customer_path(@customer) %>
|
||||
<% end %>
|
||||
<% end %>
|
||||
@@ -0,0 +1,59 @@
|
||||
<%#
|
||||
Adds the estimate and vehicle ticked on the customer page to the "New issue" link
|
||||
(#dynamic-new-issue-link in the contextual area). One of each can be ticked.
|
||||
%>
|
||||
<script>
|
||||
function handleSingleSelect(event, className) {
|
||||
if (event.target.checked) {
|
||||
// Uncheck all other checkboxes of the same type
|
||||
document.querySelectorAll('.' + className).forEach(cb => {
|
||||
if (cb !== event.target) {
|
||||
cb.checked = false;
|
||||
}
|
||||
});
|
||||
}
|
||||
updateLink();
|
||||
}
|
||||
|
||||
// Bind single-select behavior to checkboxes once the DOM is loaded
|
||||
document.addEventListener('DOMContentLoaded', function() {
|
||||
document.querySelectorAll('.estimate-checkbox').forEach(cb => {
|
||||
cb.addEventListener('change', (e) => handleSingleSelect(e, 'estimate-checkbox'));
|
||||
});
|
||||
document.querySelectorAll('.vehicle-checkbox').forEach(cb => {
|
||||
cb.addEventListener('change', (e) => handleSingleSelect(e, 'vehicle-checkbox'));
|
||||
});
|
||||
});
|
||||
|
||||
function updateLink() {
|
||||
const 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');
|
||||
}
|
||||
|
||||
// Build base URL object
|
||||
let url = new URL(link.dataset.baseUrl, window.location.origin);
|
||||
|
||||
// 1. Handle Single Estimate
|
||||
const checkedEstimate = document.querySelector('.estimate-checkbox:checked');
|
||||
if (checkedEstimate) {
|
||||
url.searchParams.set('issue[estimate_id]', checkedEstimate.value);
|
||||
} else {
|
||||
url.searchParams.delete('issue[estimate_id]');
|
||||
}
|
||||
|
||||
// 2. Handle Single Vehicle
|
||||
const checkedVehicle = document.querySelector('.vehicle-checkbox:checked');
|
||||
if (checkedVehicle) {
|
||||
url.searchParams.set('issue[vehicle_id]', checkedVehicle.value);
|
||||
} else {
|
||||
url.searchParams.delete('issue[vehicle_id]');
|
||||
}
|
||||
|
||||
// Update the link's href attribute
|
||||
link.setAttribute('href', url.toString());
|
||||
}
|
||||
</script>
|
||||
@@ -2,5 +2,7 @@
|
||||
<%= text_field_tag :search, params[:search], class: "customer-name", placeholder: t(:label_search_customers), autocomplete: "off", data: { autocomplete_url: "/customers/autocomplete" } %>
|
||||
<%= submit_tag t(:label_search) %>
|
||||
<% end %>
|
||||
<%= button_to t(:label_new_customer), new_customer_path, method: :get%>
|
||||
<% if User.current.allowed_to?(:add_customers, nil, global: true) %>
|
||||
<%= button_to t(:label_new_customer), new_customer_path, method: :get%>
|
||||
<% end %>
|
||||
<%= button_to(t(:label_sync), qbo_sync_path, method: :get) if User.current.admin?%>
|
||||
@@ -1,3 +1,5 @@
|
||||
<h1><%=t(:label_edit_customer)%></h1>
|
||||
<br/>
|
||||
<h2><%= link_to l(:label_customers), customers_path %> » <%= link_to @customer.to_s, customer_path(@customer) %></h2>
|
||||
|
||||
<%= render partial: 'customers/form' %>
|
||||
|
||||
<% html_title(l(:label_edit_customer)) -%>
|
||||
@@ -1,3 +1,5 @@
|
||||
<h2><%=t(:label_new_customer)%></h2>
|
||||
<br/>
|
||||
<h2><%= link_to l(:label_customers), customers_path %> » <%= l(:label_new_customer) %></h2>
|
||||
|
||||
<%= render partial: 'customers/form' %>
|
||||
|
||||
<% html_title(l(:label_new_customer)) -%>
|
||||
@@ -1,3 +1,29 @@
|
||||
<div class="contextual">
|
||||
<%# New issue for this customer; picks up the estimate / vehicle ticked on this page %>
|
||||
<%= link_to sprite_icon('add', l(:label_new_issue)), new_issue_path(issue: { customer_id: @customer.id }),
|
||||
id: 'dynamic-new-issue-link', class: 'icon icon-add', target: :_blank %>
|
||||
<%# Plugins add their customer actions here (e.g. redmine_qbo_calendar's Add appointment) %>
|
||||
<%= call_hook :view_customers_show_contextual, { customer: @customer } %>
|
||||
<%# Estimates, invoices and payments are handled here, each shown to users with its permission. The customer's
|
||||
name below links to their QuickBooks account page as a fallback. %>
|
||||
<% if RedmineQboBilling.writer? %>
|
||||
<%= render partial: 'qbo_estimates/customer_link', locals: { customer: @customer } %>
|
||||
<% end %>
|
||||
<% if RedmineQboBilling.invoice_writer? %>
|
||||
<%= render partial: 'qbo_invoices/customer_link', locals: { customer: @customer } %>
|
||||
<% end %>
|
||||
<% if RedmineQboBilling.payment_viewer? %>
|
||||
<%= link_to sprite_icon('list', l(:label_payments)), qbo_payments_path(customer_id: @customer.id), class: 'icon icon-list' %>
|
||||
<% end %>
|
||||
<% 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 User.current.allowed_to?(:edit_customers, nil, global: true) %>
|
||||
<%= link_to sprite_icon('edit', l(:button_edit)), edit_customer_path(@customer),
|
||||
class: 'icon icon-edit', accesskey: accesskey(:edit) %>
|
||||
<% end %>
|
||||
</div>
|
||||
|
||||
<h2><%=t(:field_customer)%> #<%= @customer.id %> - <%= link_to @customer.to_s, "https://#{RedmineQbo.sandbox_mode? ? "sandbox" : "app"}.qbo.intuit.com/app/customerdetail?nameId=#{@customer.id}", target: :_blank %> </h2>
|
||||
<div class="issue">
|
||||
|
||||
@@ -9,17 +35,7 @@
|
||||
|
||||
<!-- Customer Info -->
|
||||
|
||||
<div class="splitcontent">
|
||||
<div class="splitcontentleft">
|
||||
<h4><%=t(:field_customer)%>:</h4>
|
||||
<%= render partial: 'customers/details', locals: {customer: @customer} %>
|
||||
</div>
|
||||
|
||||
<div class="splitcontentleft">
|
||||
<h4><%=t(:label_actions)%>:</h4>
|
||||
<%= render partial: 'customers/actions', locals: {customer: @customer} %>
|
||||
</div>
|
||||
</div>
|
||||
<%= render partial: 'customers/details', locals: {customer: @customer} %>
|
||||
|
||||
|
||||
<!-- QBO Info -->
|
||||
@@ -51,3 +67,5 @@
|
||||
|
||||
<h3><%=@closed_issues.count%> <%=t(:label_closed_issues)%> - <%= @closed_hours.round(1)%> <%=t(:label_hours)%></h3>
|
||||
<%= render partial: 'issues/list_simple', locals: {issues: @closed_issues} %>
|
||||
|
||||
<%= render partial: 'customers/new_issue_link_script' %>
|
||||
@@ -2,11 +2,12 @@
|
||||
|
||||
<% estimates.sort.reverse.each do |estimate| %>
|
||||
<div class="row">
|
||||
<%= check_box_tag "estimate_ids[]", estimate.id, false, onchange: "updateLink()", data: { url: estimate_path(estimate), text: "Estimate ##{estimate.to_s}" }, class: "estimate-checkbox appointment" %>
|
||||
<%= check_box_tag "estimate_ids[]", estimate.id, false, onchange: "updateLink()", data: { text: "Estimate ##{estimate.doc_number}" }, class: "estimate-checkbox appointment" %>
|
||||
<b><%= link_to "##{estimate.doc_number}", estimate_path(estimate), target: :_blank %></b> <%= estimate.txn_date %>
|
||||
<%= render partial: 'qbo_estimates/estimate_actions', locals: { estimate: estimate } if RedmineQboBilling.writer? %>
|
||||
</div>
|
||||
<% end %>
|
||||
|
||||
<% else %>
|
||||
<p><%=t(:label_no_estimates)%>.</p>
|
||||
<% end %>
|
||||
<% end %>
|
||||
@@ -14,6 +14,7 @@
|
||||
<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 %>
|
||||
<%= render partial: 'qbo_invoices/invoice_actions', locals: { invoice: invoice } if RedmineQboBilling.invoice_writer? %>
|
||||
</div>
|
||||
<% end %>
|
||||
|
||||
|
||||
@@ -7,7 +7,10 @@
|
||||
|
||||
<div class="estimate_id attribute">
|
||||
<div class="label"><span><%=t(:field_estimate)%></span>:</div>
|
||||
<div class="value"><%= estimate_link %></div>
|
||||
<div class="value">
|
||||
<%= estimate_link %>
|
||||
<%= render partial: 'qbo_estimates/estimate_actions', locals: { estimate: issue.estimate } if issue.estimate && RedmineQboBilling.writer? %>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="invoice_id attribute">
|
||||
|
||||
@@ -0,0 +1,50 @@
|
||||
<%= labelled_form_for @item do |f| %>
|
||||
<%= error_messages_for 'item' %>
|
||||
|
||||
<div class="box tabular">
|
||||
<p>
|
||||
<%= f.text_field :name, required: true, size: 60 %>
|
||||
</p>
|
||||
|
||||
<p>
|
||||
<%= f.text_field :sku, size: 30 %>
|
||||
</p>
|
||||
|
||||
<p>
|
||||
<%= f.text_area :description, rows: 4, class: 'wiki-edit' %>
|
||||
</p>
|
||||
|
||||
<p>
|
||||
<%= f.text_field :unit_price,
|
||||
class: "price-field",
|
||||
inputmode: "decimal",
|
||||
autocomplete: "off"%>
|
||||
</p>
|
||||
|
||||
<p>
|
||||
<%= f.check_box :taxable %>
|
||||
</p>
|
||||
|
||||
<p>
|
||||
<%= f.label :account_id, l(:label_account) %>
|
||||
<%= f.collection_select :account_id,
|
||||
Account.where(classification: 'Revenue').order(:name),
|
||||
:id,
|
||||
:name,
|
||||
{ selected: @item.account_id || Account.get_default&.id, include_blank: true } %>
|
||||
</p>
|
||||
|
||||
<p>
|
||||
<%= f.select :type,
|
||||
Quickbooks::Model::Item::ITEM_TYPES.map { |t| [t, t] },
|
||||
{ selected: @item.type || Quickbooks::Model::Item::NON_INVENTORY_TYPE } %>
|
||||
</p>
|
||||
|
||||
<p>
|
||||
<%= f.check_box :active %>
|
||||
</p>
|
||||
</div>
|
||||
|
||||
<%= submit_tag l(:button_save) %>
|
||||
<%= link_to l(:button_cancel), items_path if controller.action_name == 'edit' %>
|
||||
<% end %>
|
||||
@@ -0,0 +1,3 @@
|
||||
<h2><%=t(:label_edit_item)%></h2>
|
||||
|
||||
<%= render "form" %>
|
||||
@@ -0,0 +1,56 @@
|
||||
<div class="contextual">
|
||||
<%= link_to l(:label_item_new), new_item_path, class: 'icon icon-add' %>
|
||||
</div>
|
||||
|
||||
<h2><%= l(:label_items) %></h2>
|
||||
|
||||
<% if @items.any? %>
|
||||
<div class="autoscroll">
|
||||
<table class="list items">
|
||||
<thead>
|
||||
<tr>
|
||||
<th><%= l(:field_name) %></th>
|
||||
<th><%= l(:field_sku) %></th>
|
||||
<th><%= l(:field_description) %></th>
|
||||
<th><%= l(:field_unit_price) %></th>
|
||||
<th class="center"><%= l(:field_taxable) %></th>
|
||||
<th class="center"><%= l(:field_active) %></th>
|
||||
<th></th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<% @items.each do |item| %>
|
||||
<tr class="<%= cycle("odd", "even") %>">
|
||||
<td class="name"><%= link_to item.name, item_path(item) %></td>
|
||||
<td class="sku"><%= item.sku %></td>
|
||||
<td class="description"><%= truncate(item.description, length: 60) %></td>
|
||||
<td class="unit_price"><%= number_to_currency(item.unit_price) %></td>
|
||||
<td class="taxable center">
|
||||
<% if item.taxable %>
|
||||
<span class="icon icon-ok" style="color: green;"><%= l(:general_text_Yes) %></span>
|
||||
<% else %>
|
||||
<span class="icon icon-not-ok" style="color: #999;"><%= l(:general_text_No) %></span>
|
||||
<% end %>
|
||||
</td>
|
||||
<td class="active center">
|
||||
<% if item.active %>
|
||||
<span class="icon icon-ok" style="color: green;"><%= l(:general_text_Yes) %></span>
|
||||
<% else %>
|
||||
<span class="icon icon-not-ok" style="color: #999;"><%= l(:general_text_No) %></span>
|
||||
<% end %>
|
||||
</td>
|
||||
<td class="buttons">
|
||||
<%= link_to l(:button_edit), edit_item_path(item), class: 'icon icon-edit' %>
|
||||
<%= link_to l(:button_delete), item_path(item),
|
||||
method: :delete,
|
||||
data: { confirm: l(:text_are_you_sure) },
|
||||
class: 'icon icon-del' %>
|
||||
</td>
|
||||
</tr>
|
||||
<% end %>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
<% else %>
|
||||
<p class="nodata"><%= l(:label_no_data) %></p>
|
||||
<% end %>
|
||||
@@ -0,0 +1,5 @@
|
||||
<h2><%=t(:label_item_new)%></h2>
|
||||
|
||||
<%= render "form" %>
|
||||
|
||||
<%= link_to t(:label_back), items_path %>
|
||||
@@ -0,0 +1,44 @@
|
||||
<div class="contextual">
|
||||
<%= link_to l(:button_edit), edit_item_path(@item), class: 'icon icon-edit' %>
|
||||
<%= link_to l(:button_back), items_path, class: 'icon icon-list' %>
|
||||
</div>
|
||||
|
||||
<h2><%= t(:item) %># <%= @item.id %> <%= @item.name %></h2>
|
||||
|
||||
<div class="issue details"> <div class="attributes">
|
||||
<div class="splitcontent">
|
||||
<div class="splitcontentleft">
|
||||
<p><strong><%=t(:field_sku)%>:</strong> <%= @item.sku.presence || "-" %></p>
|
||||
<p><strong><%=t(:label_type)%>:</strong> <%= @item.type.presence || "-" %></p>
|
||||
<p><strong><%=t(:field_unit_price)%>:</strong> <%= number_to_currency(@item.unit_price) %></p>
|
||||
</div>
|
||||
|
||||
<div class="splitcontentleft">
|
||||
<p><strong><%=t(:label_account)%>:</strong> <%= @item.account&.name || "-" %></p>
|
||||
<p>
|
||||
<strong><%=t(:field_taxable)%>:</strong>
|
||||
<% if @item.taxable %>
|
||||
<span class="icon icon-ok" style="color: green;"><%=t(:yes)%></span>
|
||||
<% else %>
|
||||
<span class="icon icon-not-ok" style="color: #999;"><%=t(:no)%></span>
|
||||
<% end %>
|
||||
</p>
|
||||
<p>
|
||||
<strong><%=t(:label_active)%>:</strong>
|
||||
<% if @item.active %>
|
||||
<span class="icon icon-ok" style="color: green;"><%=t(:yes)%></span>
|
||||
<% else %>
|
||||
<span class="icon icon-not-ok" style="color: #999;"><%=t(:no)%></span>
|
||||
<% end %>
|
||||
</p>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<hr />
|
||||
|
||||
<p><strong><%=t(:label_description)%>:</strong></p>
|
||||
<div class="wiki" style="padding-left: 20px;">
|
||||
<%= @item.description.presence || "<em>No description provided</em>".html_safe %>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
@@ -0,0 +1,83 @@
|
||||
<div class="box tabular settings">
|
||||
<p>
|
||||
<label for="settings_expiration_days"><%= l(:label_estimate_expiration_days) %></label>
|
||||
<%= number_field_tag 'settings[expiration_days]', @settings['expiration_days'], id: 'settings_expiration_days',
|
||||
min: 0, step: 1, size: 6 %>
|
||||
<em class="info"><%= l(:text_estimate_expiration_days) %></em>
|
||||
</p>
|
||||
<p>
|
||||
<label for="settings_replaceable_item_ids"><%= l(:label_replaceable_items) %></label>
|
||||
<%= hidden_field_tag 'settings[replaceable_item_ids][]', '', id: nil %>
|
||||
<%= select_tag 'settings[replaceable_item_ids][]',
|
||||
options_from_collection_for_select(Item.where(active: true).order(:name), :id, :name,
|
||||
Array(@settings['replaceable_item_ids']).map(&:to_s)),
|
||||
multiple: true, size: 8, id: 'settings_replaceable_item_ids' %>
|
||||
<em class="info"><%= l(:text_replaceable_items) %></em>
|
||||
</p>
|
||||
</div>
|
||||
|
||||
<%# Issues from estimates (moved from redmine_qbo_calendar; its old values are shown until these are saved) %>
|
||||
<% issue_builder = RedmineQboBilling::EstimateIssueBuilder %>
|
||||
<fieldset class="box tabular">
|
||||
<legend><%= l(:label_estimate_issue_settings) %></legend>
|
||||
<p>
|
||||
<label for="settings_issue_item_codes"><%= l(:label_estimate_item_codes) %></label>
|
||||
<%= text_area_tag 'settings[issue_item_codes]', issue_builder.item_codes.join("\n"), rows: 5, cols: 30, id: 'settings_issue_item_codes' %>
|
||||
<em class="info"><%= l(:text_estimate_item_codes_info) %></em>
|
||||
</p>
|
||||
<p>
|
||||
<label for="settings_issue_default_project_id"><%= l(:label_default_project) %></label>
|
||||
<%= select_tag 'settings[issue_default_project_id]',
|
||||
project_tree_options_for_select(Project.active.sorted, selected: Project.find_by(id: issue_builder.default_project_id)),
|
||||
include_blank: true, id: 'settings_issue_default_project_id' %>
|
||||
<em class="info"><%= l(:text_default_project_info) %></em>
|
||||
</p>
|
||||
<p>
|
||||
<label for="settings_issue_default_tracker_id"><%= l(:label_default_tracker) %></label>
|
||||
<%= select_tag 'settings[issue_default_tracker_id]',
|
||||
options_from_collection_for_select(Tracker.sorted, :id, :name, issue_builder.default_tracker_id),
|
||||
include_blank: true, id: 'settings_issue_default_tracker_id' %>
|
||||
<em class="info"><%= l(:text_default_tracker_info) %></em>
|
||||
</p>
|
||||
</fieldset>
|
||||
|
||||
<%# QuickBooks product/service list and income accounts (moved from redmine_qbo_lineitems) %>
|
||||
<div class="box tabular">
|
||||
<p>
|
||||
<label><strong><%= t(:label_item_count) %></strong></label>
|
||||
<%= Item.count %>
|
||||
<em style="color: #777; font-size: 0.9em; margin-left: 8px;">
|
||||
(@ <%= Item.last_sync %>)
|
||||
</em>
|
||||
</p>
|
||||
<p>
|
||||
<label><strong><%= t(:label_account_count) %></strong></label>
|
||||
<%= Account.count %>
|
||||
<em style="color: #777; font-size: 0.9em; margin-left: 8px;">
|
||||
(@ <%= Account.last_sync %>)
|
||||
</em>
|
||||
</p>
|
||||
<p>
|
||||
<label><strong><%= t(:label_last_sync) %> (QBO)</strong></label>
|
||||
<%= Qbo.exists? ? Qbo.last_sync : l(:label_never_synced) %>
|
||||
</p>
|
||||
<p>
|
||||
<label><strong><%= t(:label_default_account) %></strong></label>
|
||||
<%= Account.get_default %>
|
||||
</p>
|
||||
</div>
|
||||
|
||||
<fieldset class="box">
|
||||
<legend><%= l(:label_management_and_sync) %></legend>
|
||||
|
||||
<div style="margin-bottom: 15px;">
|
||||
<%= link_to t(:label_sync_now_items), sync_items_path, class: 'button icon icon-reload' %>
|
||||
<%= link_to t(:label_sync_now_accounts), sync_accounts_path, class: 'button icon icon-reload' %>
|
||||
</div>
|
||||
|
||||
<div>
|
||||
<%= link_to t(:label_items), items_path, class: 'icon icon-list' %>
|
||||
<span style="margin: 0 10px; color: #ccc;">|</span>
|
||||
<%= link_to t(:label_accounts), accounts_path, class: 'icon icon-list' %>
|
||||
</div>
|
||||
</fieldset>
|
||||
@@ -48,13 +48,13 @@
|
||||
<p>
|
||||
<label><%= t(:label_invoice_count) %></label>
|
||||
<%= Invoice.count %>
|
||||
<em style="color: #777; font-size: 0.9em; margin-left: 8px;">(@ <%= Item.last_sync %>)</em>
|
||||
<em style="color: #777; font-size: 0.9em; margin-left: 8px;">(@ <%= Invoice.last_sync %>)</em>
|
||||
</p>
|
||||
|
||||
<p>
|
||||
<label><%= t(:label_estimate_count) %></label>
|
||||
<%= Estimate.count %>
|
||||
<em style="color: #777; font-size: 0.9em; margin-left: 8px;">(@ <%= Account.last_sync %>)</em>
|
||||
<em style="color: #777; font-size: 0.9em; margin-left: 8px;">(@ <%= Estimate.last_sync %>)</em>
|
||||
</p>
|
||||
|
||||
<p>
|
||||
@@ -76,4 +76,8 @@
|
||||
<%= link_to t(:label_sync_now_invoices), invoices_sync_path, class: 'button icon icon-reload' %>
|
||||
<%= link_to t(:label_sync_now_estimate), estimates_sync_path, class: 'button icon icon-reload' %>
|
||||
</div>
|
||||
</fieldset>
|
||||
</fieldset>
|
||||
|
||||
<%# Billing: estimates, issues from estimates, invoices, the product/service list and accounts %>
|
||||
<h3><%= l(:label_billing_settings) %></h3>
|
||||
<%= render partial: 'qbo/billing_settings', locals: { settings: settings } %>
|
||||
@@ -1,6 +1,9 @@
|
||||
<% if User.current.logged? %>
|
||||
|
||||
<%= render partial: 'customers/sidebar' %>
|
||||
<% if User.current.allowed_to?(:view_customers, nil, global: true) %>
|
||||
<%= render partial: 'customers/sidebar' %>
|
||||
<% end %>
|
||||
|
||||
<%= render partial: 'estimates/sidebar' %>
|
||||
|
||||
<% end %>
|
||||
@@ -0,0 +1,2 @@
|
||||
<%= link_to sprite_icon('document', l(:label_create_estimate)), new_qbo_estimate_path(customer_id: customer.id),
|
||||
class: 'icon icon-document' %>
|
||||
@@ -0,0 +1,8 @@
|
||||
<%# Estimates linked to an issue are read-only here, so they get a View link instead of Edit %>
|
||||
<% if estimate.issues.exists? %>
|
||||
<%= link_to sprite_icon('zoom-in', l(:button_view_estimate)), edit_qbo_estimate_path(estimate.id),
|
||||
class: 'icon-only icon-zoom-in qbo-estimate-edit-link', title: l(:button_view_estimate) %>
|
||||
<% else %>
|
||||
<%= link_to sprite_icon('edit', l(:button_edit)), edit_qbo_estimate_path(estimate.id),
|
||||
class: 'icon-only icon-edit qbo-estimate-edit-link', title: l(:button_edit_estimate) %>
|
||||
<% end %>
|
||||
@@ -0,0 +1,304 @@
|
||||
<%
|
||||
company = RedmineQboBilling::Company
|
||||
sales_field = company.sales_person_field
|
||||
vin_field = company.vin_field
|
||||
mileage_field = company.mileage_field
|
||||
customer = Customer.find_by(id: form.customer_id) if form.customer_id.present?
|
||||
vehicles = customer.respond_to?(:vehicles) ? customer.vehicles.select { |v| v.vin.present? } : []
|
||||
# When QuickBooks' settings couldn't be read at all, the page header says so instead of each field
|
||||
settings_read = company.settings.present?
|
||||
# The same editor writes estimates and invoices
|
||||
invoice = form.invoice?
|
||||
sender = invoice ? RedmineQboBilling.invoice_sender? : RedmineQboBilling.sender?
|
||||
cancel_path = customer ? customer_path(customer) : home_path
|
||||
form_url =
|
||||
if invoice
|
||||
form.persisted? ? qbo_invoice_path(form.id) : qbo_invoices_path
|
||||
else
|
||||
form.persisted? ? qbo_estimate_path(form.id) : qbo_estimates_path
|
||||
end
|
||||
%>
|
||||
|
||||
<%= form_tag(form_url,
|
||||
method: form.persisted? ? :patch : :post,
|
||||
id: 'qbo-estimate-form',
|
||||
class: "qbo-estimate qbo-document-#{form.document}",
|
||||
data: {
|
||||
document: form.document,
|
||||
import_url: (import_options_qbo_invoices_path if invoice),
|
||||
replaceable_item_ids: (RedmineQboBilling::InvoiceWriter.replaceable_item_ids if invoice),
|
||||
items_url: items_qbo_estimates_path,
|
||||
customer_info_url: customer_info_qbo_estimates_path,
|
||||
saved_subtotal: (form.persisted? ? form.subtotal.to_s('F') : ''),
|
||||
saved_tax: form.total_tax.to_s,
|
||||
discount: form.discount.to_s,
|
||||
# New estimates: moving the estimate date moves the default expiration date with it
|
||||
expiration_days: (form.persisted? || invoice ? 0 : RedmineQboBilling::EstimateWriter.expiration_days),
|
||||
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 '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 %>
|
||||
<%= hidden_field_tag 'estimate[txn_status]', form.txn_status, id: nil %>
|
||||
<%# Shown again if the page is redisplayed; the saved value is worked out when saving %>
|
||||
<%= 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 %>
|
||||
<%# 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| %>
|
||||
<%= hidden_field_tag 'estimate[linked_estimate_ids][]', estimate_id, id: nil %>
|
||||
<% end %>
|
||||
</span>
|
||||
<% end %>
|
||||
|
||||
<fieldset class="qbo-estimate-sheet"<%= ' disabled'.html_safe if form.locked %>>
|
||||
|
||||
<%# Customer, email and the big amount, like the top of QuickBooks' estimate screen %>
|
||||
<div class="qbo-estimate-top">
|
||||
<div class="qbo-estimate-row">
|
||||
<div class="qbo-field qbo-field-customer">
|
||||
<label for="qbo_estimate_customer_name"><%= l(:label_customer) %></label>
|
||||
<%= text_field_tag 'estimate[customer_name]', form.customer_name,
|
||||
id: 'qbo_estimate_customer_name', class: 'customer-name', autocomplete: 'off',
|
||||
placeholder: l(:label_choose_a_customer), data: { autocomplete_url: '/customers/autocomplete' } %>
|
||||
<%= hidden_field_tag 'estimate[customer_id]', form.customer_id, id: 'customer_id' %>
|
||||
</div>
|
||||
<div class="qbo-field qbo-field-email">
|
||||
<label for="qbo_estimate_email"><%= l(:label_customer_email) %></label>
|
||||
<%= text_field_tag 'estimate[email]', form.email, id: 'qbo_estimate_email', autocomplete: 'off',
|
||||
placeholder: l(:text_separate_emails_with_comma) %>
|
||||
</div>
|
||||
</div>
|
||||
<div class="qbo-estimate-amount">
|
||||
<span class="qbo-estimate-amount-label"><%= l(:label_amount) %></span>
|
||||
<span class="qbo-estimate-amount-value" id="qbo-estimate-amount"><%= number_to_currency(form.total || form.subtotal) %></span>
|
||||
<% if invoice && form.balance && form.total && form.balance.to_d != form.total.to_d %>
|
||||
<span class="qbo-estimate-amount-label"><%= l(:label_invoice_balance, balance: number_to_currency(form.balance)) %></span>
|
||||
<% end %>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="qbo-estimate-row qbo-estimate-details">
|
||||
<div class="qbo-field qbo-field-address">
|
||||
<span class="qbo-label"><%= l(:label_billing_address) %></span>
|
||||
<div class="qbo-address" id="qbo-estimate-address"><%= form.billing_address.to_s %></div>
|
||||
</div>
|
||||
<div class="qbo-field qbo-field-date">
|
||||
<label for="qbo_estimate_txn_date"><%= l(invoice ? :label_invoice_date : :label_estimate_date) %></label>
|
||||
<%= date_field_tag 'estimate[txn_date]', form.txn_date, id: 'qbo_estimate_txn_date' %>
|
||||
</div>
|
||||
<div class="qbo-field qbo-field-date">
|
||||
<% if invoice %>
|
||||
<label for="qbo_estimate_due_date"><%= l(:label_due_date) %></label>
|
||||
<%# Left empty, QuickBooks works it out from the customer's terms %>
|
||||
<%= date_field_tag 'estimate[due_date]', form.due_date, id: 'qbo_estimate_due_date' %>
|
||||
<% else %>
|
||||
<label for="qbo_estimate_expiration_date"><%= l(:label_expiration_date) %></label>
|
||||
<%= date_field_tag 'estimate[expiration_date]', form.expiration_date, id: 'qbo_estimate_expiration_date' %>
|
||||
<% end %>
|
||||
</div>
|
||||
<div class="qbo-field qbo-field-number">
|
||||
<label for="qbo_estimate_doc_number"><%= l(invoice ? :label_invoice_no : :label_estimate_no) %></label>
|
||||
<%# Not editable: QuickBooks numbers estimates. Posted only so the page can show it again. %>
|
||||
<%= hidden_field_tag 'estimate[doc_number]', form.doc_number, id: nil %>
|
||||
<%= text_field_tag nil, form.doc_number.presence, id: 'qbo_estimate_doc_number', readonly: true, tabindex: -1,
|
||||
placeholder: l(:text_assigned_by_quickbooks) %>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="qbo-estimate-row qbo-estimate-details">
|
||||
<div class="qbo-field qbo-field-sales-person">
|
||||
<label for="qbo_estimate_sales_person"><%= sales_field&.name || l(:label_sales_person) %></label>
|
||||
<%= text_field_tag nil, form.sales_person, id: 'qbo_estimate_sales_person', readonly: true, tabindex: -1 %>
|
||||
<% if settings_read && !sales_field %>
|
||||
<em class="info"><%= l(:text_no_sales_person_field) %></em>
|
||||
<% end %>
|
||||
</div>
|
||||
<div class="qbo-field qbo-field-vin">
|
||||
<label for="qbo_estimate_vin"><%= vin_field&.name || l(:label_vin) %></label>
|
||||
<%= text_field_tag 'estimate[vin]', form.vin, id: 'qbo_estimate_vin', list: 'qbo-estimate-vins', maxlength: 31,
|
||||
autocomplete: 'off', spellcheck: false, disabled: vin_field.nil? %>
|
||||
<datalist id="qbo-estimate-vins">
|
||||
<% vehicles.each do |vehicle| %>
|
||||
<option value="<%= vehicle.vin %>"><%= vehicle.to_s %></option>
|
||||
<% end %>
|
||||
</datalist>
|
||||
<% if settings_read && !vin_field %>
|
||||
<em class="info"><%= l(:text_no_vin_field) %></em>
|
||||
<% end %>
|
||||
</div>
|
||||
<%# Mileage only shows when QuickBooks has a text field named like "Mileage" %>
|
||||
<% if mileage_field %>
|
||||
<div class="qbo-field qbo-field-mileage">
|
||||
<label for="qbo_estimate_mileage"><%= mileage_field.name %></label>
|
||||
<%= text_field_tag 'estimate[mileage]', form.mileage, id: 'qbo_estimate_mileage', maxlength: 31,
|
||||
inputmode: 'numeric', autocomplete: 'off' %>
|
||||
</div>
|
||||
<% end %>
|
||||
<% if settings_read && (sales_field.nil? || vin_field.nil?) && User.current.admin? %>
|
||||
<div class="qbo-field qbo-field-refresh">
|
||||
<%= 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_quickbooks_custom_fields_found,
|
||||
fields: company.custom_fields.map { |f| "#{f.name} (##{f.id})" }.join(', ').presence || l(:label_none)) %>
|
||||
</em>
|
||||
</div>
|
||||
<% end %>
|
||||
</div>
|
||||
|
||||
<%# Product/service lines %>
|
||||
<div class="qbo-estimate-lines-wrap">
|
||||
<table class="qbo-estimate-lines" id="qbo-estimate-lines">
|
||||
<thead>
|
||||
<tr>
|
||||
<th class="qbo-line-handle"></th>
|
||||
<th class="qbo-line-number">#</th>
|
||||
<th class="qbo-line-item"><%= l(:label_product_service) %></th>
|
||||
<th class="qbo-line-description"><%= l(:field_description) %></th>
|
||||
<th class="qbo-line-qty"><%= l(:label_qty) %></th>
|
||||
<th class="qbo-line-rate"><%= l(:label_rate) %></th>
|
||||
<th class="qbo-line-amount"><%= l(:label_amount) %></th>
|
||||
<th class="qbo-line-tax"><%= l(:label_tax) %></th>
|
||||
<th class="qbo-line-remove"></th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<% form.lines.each_with_index do |line, index| %>
|
||||
<%= render partial: (line.subtotal? ? 'qbo_estimates/subtotal_line' : 'qbo_estimates/line'),
|
||||
locals: { line: line, key: index, number: index + 1 } %>
|
||||
<% end %>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
|
||||
<template id="qbo-estimate-line-template">
|
||||
<%= render partial: 'qbo_estimates/line', locals: { line: RedmineQboBilling::EstimateForm::Line.new(taxable: true), key: '__KEY__', number: '' } %>
|
||||
</template>
|
||||
<template id="qbo-estimate-subtotal-template">
|
||||
<%= render partial: 'qbo_estimates/subtotal_line', locals: { line: RedmineQboBilling::EstimateForm::Line.new, key: '__KEY__', number: '' } %>
|
||||
</template>
|
||||
|
||||
<p class="qbo-estimate-line-buttons">
|
||||
<button type="button" class="qbo-button" id="qbo-estimate-add-lines"><%= l(:button_add_lines) %></button>
|
||||
<button type="button" class="qbo-button" id="qbo-estimate-add-subtotal"><%= l(:button_add_subtotal) %></button>
|
||||
<button type="button" class="qbo-button" id="qbo-estimate-clear-lines"
|
||||
data-confirm-text="<%= l(:text_clear_all_lines_confirmation) %>"><%= l(:button_clear_all_lines) %></button>
|
||||
<% if invoice %>
|
||||
<button type="button" class="qbo-button" id="qbo-import-open"><%= l(:button_import_time_estimates) %></button>
|
||||
<button type="button" class="qbo-button" id="qbo-import-undo" hidden><%= l(:button_undo_import) %></button>
|
||||
<% end %>
|
||||
</p>
|
||||
|
||||
<% if invoice %>
|
||||
<%# Import: billable QuickBooks time (replacing the lines ticked) and open estimates. Filled by the script. %>
|
||||
<div class="qbo-import-panel" id="qbo-import-panel" hidden
|
||||
data-loading-text="<%= l(:label_loading) %>" data-none-text="<%= l(:label_none) %>"
|
||||
data-need-customer-text="<%= l(:error_estimate_needs_customer) %>"
|
||||
data-many-vehicles-text="<%= l(:text_invoice_many_vehicles) %>">
|
||||
<div class="qbo-import-columns">
|
||||
<section class="qbo-import-time">
|
||||
<h4><%= l(:label_billable_time) %></h4>
|
||||
<table class="qbo-import-table" id="qbo-import-time">
|
||||
<thead>
|
||||
<tr>
|
||||
<th><input type="checkbox" class="qbo-import-all" data-target="qbo-import-time" aria-label="<%= l(:button_check_all) %>"></th>
|
||||
<th><%= l(:label_date) %></th>
|
||||
<th><%= l(:label_product_service) %></th>
|
||||
<th><%= l(:field_description) %></th>
|
||||
<th class="qbo-num"><%= l(:label_hours) %></th>
|
||||
<th class="qbo-num"><%= l(:label_amount) %></th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody></tbody>
|
||||
</table>
|
||||
</section>
|
||||
<section class="qbo-import-replace">
|
||||
<h4><%= l(:label_replace_lines) %></h4>
|
||||
<p><em class="info"><%= l(:text_replace_lines) %></em></p>
|
||||
<ul id="qbo-import-replace"></ul>
|
||||
</section>
|
||||
</div>
|
||||
<section class="qbo-import-estimates">
|
||||
<h4><%= l(:label_open_estimates) %></h4>
|
||||
<table class="qbo-import-table" id="qbo-import-estimates">
|
||||
<thead>
|
||||
<tr>
|
||||
<th><input type="checkbox" class="qbo-import-all" data-target="qbo-import-estimates" aria-label="<%= l(:button_check_all) %>"></th>
|
||||
<th><%= l(:label_estimate) %></th>
|
||||
<th><%= l(:label_date) %></th>
|
||||
<th><%= l(:field_description) %></th>
|
||||
<th class="qbo-num"><%= l(:label_estimate_total) %></th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody></tbody>
|
||||
</table>
|
||||
</section>
|
||||
<p class="qbo-import-buttons">
|
||||
<button type="button" class="qbo-button qbo-button-primary" id="qbo-import-add"><%= l(:button_add_to_invoice) %></button>
|
||||
<button type="button" class="qbo-button" id="qbo-import-close"><%= l(:button_cancel) %></button>
|
||||
<span class="qbo-import-status" id="qbo-import-status"></span>
|
||||
</p>
|
||||
</div>
|
||||
<% end %>
|
||||
|
||||
<div class="qbo-estimate-bottom">
|
||||
<div class="qbo-estimate-notes">
|
||||
<div class="qbo-field">
|
||||
<label for="qbo_estimate_customer_memo"><%= l(invoice ? :label_message_on_invoice : :label_message_on_estimate) %></label>
|
||||
<%= text_area_tag 'estimate[customer_memo]', form.customer_memo, id: 'qbo_estimate_customer_memo', rows: 4, maxlength: 1000 %>
|
||||
</div>
|
||||
<div class="qbo-field">
|
||||
<label for="qbo_estimate_private_note"><%= l(:label_memo) %></label>
|
||||
<%= text_area_tag 'estimate[private_note]', form.private_note, id: 'qbo_estimate_private_note', rows: 4, maxlength: 4000,
|
||||
placeholder: l(:text_memo_is_private) %>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<table class="qbo-estimate-totals">
|
||||
<tr>
|
||||
<th><%= l(:label_subtotal) %></th>
|
||||
<td id="qbo-estimate-subtotal"><%= number_to_currency(form.subtotal) %></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<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>
|
||||
</tr>
|
||||
<% end %>
|
||||
<tr>
|
||||
<th><%= l(:label_sales_tax) %></th>
|
||||
<td id="qbo-estimate-tax"
|
||||
data-pending-text="<%= l(:text_tax_calculated_by_quickbooks) %>"><%= form.total_tax ? number_to_currency(form.total_tax) : l(:text_tax_calculated_by_quickbooks) %></td>
|
||||
</tr>
|
||||
<tr class="qbo-estimate-total">
|
||||
<th><%= l(:label_estimate_total) %></th>
|
||||
<td id="qbo-estimate-total"><%= number_to_currency(form.total || form.subtotal) %></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div>
|
||||
</fieldset>
|
||||
|
||||
<%# Action bar, like the bar along the bottom of QuickBooks' estimate screen %>
|
||||
<div class="qbo-estimate-actions">
|
||||
<%= 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">
|
||||
<%= 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) } %>
|
||||
<% end %>
|
||||
</span>
|
||||
<% end %>
|
||||
</div>
|
||||
<% end %>
|
||||
|
||||
<%= render partial: 'qbo_estimates/styles' %>
|
||||
<%= render partial: 'qbo_estimates/script' %>
|
||||
@@ -0,0 +1,80 @@
|
||||
<%# Title with the customer breadcrumb, errors, and warnings shared by the estimate and invoice pages %>
|
||||
<%
|
||||
customer = Customer.find_by(id: form.customer_id) if form.customer_id.present?
|
||||
invoice = form.invoice?
|
||||
%>
|
||||
<h2>
|
||||
<%= link_to l(:label_customers), customers_path %>
|
||||
»
|
||||
<% if customer %>
|
||||
<%= link_to customer.name, customer_path(customer) %>
|
||||
»
|
||||
<% end %>
|
||||
<% if form.persisted? %>
|
||||
<%= l(invoice ? :label_invoice : :label_estimate) %> #<%= form.doc_number %>
|
||||
<% if form.sent? %>
|
||||
<span class="qbo-estimate-status qbo-estimate-status-sent"><%= l(:label_estimate_sent) %></span>
|
||||
<% end %>
|
||||
<% if invoice && form.locked == :paid %>
|
||||
<% fully_paid = form.balance.to_d.zero? %>
|
||||
<span class="qbo-estimate-status qbo-estimate-status-<%= fully_paid ? 'closed' : 'accepted' %>"><%= l(fully_paid ? :label_invoice_paid : :label_invoice_partially_paid) %></span>
|
||||
<% elsif !invoice && form.txn_status.present? && form.txn_status != 'Pending' %>
|
||||
<span class="qbo-estimate-status qbo-estimate-status-<%= form.txn_status.downcase %>"><%= form.txn_status %></span>
|
||||
<% end %>
|
||||
<% else %>
|
||||
<%= l(invoice ? :label_new_invoice : :label_new_estimate) %>
|
||||
<% end %>
|
||||
</h2>
|
||||
|
||||
<%= error_messages_for form %>
|
||||
|
||||
<% if @conflict %>
|
||||
<p class="warning">
|
||||
<%= l(:text_estimate_reload) %>
|
||||
<%= link_to l(:button_reload_estimate), invoice ? edit_qbo_invoice_path(form.id) : edit_qbo_estimate_path(form.id) %>
|
||||
</p>
|
||||
<% end %>
|
||||
|
||||
<% if !invoice && Array(form.invoiced_on).any? %>
|
||||
<div class="warning qbo-estimate-notice">
|
||||
<%= l(:text_estimate_billed_on) %>
|
||||
<ul>
|
||||
<% form.invoiced_on.each do |invoice_id, number| %>
|
||||
<li><%= link_to "#{l(:label_invoice)} ##{number}", RedmineQboBilling.invoice_writer? ? edit_qbo_invoice_path(invoice_id) : invoice_path(invoice_id) %></li>
|
||||
<% end %>
|
||||
</ul>
|
||||
</div>
|
||||
<% end %>
|
||||
|
||||
<% if form.duplicated_from.present? %>
|
||||
<div class="flash notice"><%= l(:text_estimate_duplicated_from, number: form.duplicated_from) %></div>
|
||||
<% end %>
|
||||
<% if form.converted_from.present? %>
|
||||
<div class="flash notice"><%= l(:text_invoice_from_estimate, number: form.converted_from) %></div>
|
||||
<% end %>
|
||||
|
||||
<% if form.locked == :linked %>
|
||||
<div class="warning qbo-estimate-notice">
|
||||
<%= l(:error_estimate_linked_to_issues) %>
|
||||
<ul>
|
||||
<% Array(@linked_issues).each do |issue| %>
|
||||
<li><%= link_to_issue(issue, truncate: 60) %></li>
|
||||
<% end %>
|
||||
</ul>
|
||||
</div>
|
||||
<% elsif form.locked == :paid %>
|
||||
<p class="warning"><%= l(:error_invoice_paid) %></p>
|
||||
<% elsif form.locked == :bundles %>
|
||||
<p class="warning"><%= l(invoice ? :error_invoice_has_bundles : :error_estimate_has_bundles) %></p>
|
||||
<% elsif !invoice && %w[Converted Closed].include?(form.txn_status.to_s) && Array(form.invoiced_on).empty? %>
|
||||
<p class="warning"><%= l(:text_estimate_closed) %></p>
|
||||
<% end %>
|
||||
|
||||
<% if RedmineQboBilling::Company.settings.empty? %>
|
||||
<p class="warning">
|
||||
<%= l(:text_quickbooks_settings_unavailable) %>
|
||||
<% if User.current.admin? %>
|
||||
<%= link_to l(:button_refresh_quickbooks_fields), refresh_company_qbo_estimates_path, method: :post %>
|
||||
<% end %>
|
||||
</p>
|
||||
<% end %>
|
||||
@@ -0,0 +1,38 @@
|
||||
<%# One row of the line table. key is the row's params key; rows are posted in table order. %>
|
||||
<% name = "estimate[lines][#{key}]" %>
|
||||
<tr class="qbo-line<%= ' qbo-line-unmatched' if line.unmatched_item? %><%= ' qbo-line-time' if line.time_activity_id.present? %>">
|
||||
<td class="qbo-line-handle" title="<%= l(:label_drag_to_reorder) %>"><%= sprite_icon('reorder') %></td>
|
||||
<td class="qbo-line-number"><%= number %></td>
|
||||
<td class="qbo-line-item" data-label="<%= l(:label_product_service) %>">
|
||||
<%= hidden_field_tag "#{name}[id]", line.id, id: nil %>
|
||||
<%= hidden_field_tag "#{name}[item_id]", line.item_id, id: nil, class: 'qbo-line-item-id' %>
|
||||
<%# Invoices: the QuickBooks time activity this line bills %>
|
||||
<%= hidden_field_tag "#{name}[time_activity_id]", line.time_activity_id, id: nil, class: 'qbo-line-time-id' %>
|
||||
<%= text_field_tag "#{name}[item_name]", line.item_name, id: nil, class: 'qbo-line-item-name',
|
||||
autocomplete: 'off', aria: { label: l(:label_product_service) } %>
|
||||
</td>
|
||||
<td class="qbo-line-description" data-label="<%= l(:field_description) %>">
|
||||
<span class="qbo-line-time-badge" title="<%= l(:text_line_bills_time) %>"><%= l(:label_time_badge) %></span>
|
||||
<%= text_area_tag "#{name}[description]", line.description, id: nil, rows: 1, class: 'qbo-line-description-input',
|
||||
aria: { label: l(:field_description) } %>
|
||||
</td>
|
||||
<td class="qbo-line-qty" data-label="<%= l(:label_qty) %>">
|
||||
<%= text_field_tag "#{name}[quantity]", line.quantity, id: nil, class: 'qbo-line-qty-input', inputmode: 'decimal',
|
||||
autocomplete: 'off', aria: { label: l(:label_qty) } %>
|
||||
</td>
|
||||
<td class="qbo-line-rate" data-label="<%= l(:label_rate) %>">
|
||||
<%= text_field_tag "#{name}[rate]", line.rate, id: nil, class: 'qbo-line-rate-input', inputmode: 'decimal',
|
||||
autocomplete: 'off', aria: { label: l(:label_rate) } %>
|
||||
</td>
|
||||
<td class="qbo-line-amount" data-label="<%= l(:label_amount) %>">
|
||||
<%# Typing an amount works out the rate, like QuickBooks; only qty and rate are posted %>
|
||||
<input type="text" class="qbo-line-amount-input" inputmode="decimal" autocomplete="off" aria-label="<%= l(:label_amount) %>">
|
||||
</td>
|
||||
<td class="qbo-line-tax" data-label="<%= l(:label_tax) %>">
|
||||
<%= hidden_field_tag "#{name}[taxable]", '0', id: nil %>
|
||||
<%= check_box_tag "#{name}[taxable]", '1', line.taxable?, id: nil, class: 'qbo-line-taxable', aria: { label: l(:label_tax) } %>
|
||||
</td>
|
||||
<td class="qbo-line-remove">
|
||||
<button type="button" class="qbo-line-remove-button" title="<%= l(:button_delete) %>"><%= sprite_icon('del') %></button>
|
||||
</td>
|
||||
</tr>
|
||||
@@ -0,0 +1,593 @@
|
||||
<%# Inline so the page never depends on precompiled plugin assets %>
|
||||
<%= javascript_tag do %>
|
||||
$(function () {
|
||||
var $form = $('#qbo-estimate-form');
|
||||
if (!$form.length) return;
|
||||
|
||||
var $tbody = $('#qbo-estimate-lines tbody');
|
||||
var template = document.getElementById('qbo-estimate-line-template').innerHTML;
|
||||
var subtotalTemplate = document.getElementById('qbo-estimate-subtotal-template').innerHTML;
|
||||
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'));
|
||||
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();
|
||||
var dirty = false;
|
||||
|
||||
// ---- numbers ----
|
||||
function parseNumber(value) {
|
||||
var text = String(value == null ? '' : value).replace(/[$,\s]/g, '');
|
||||
if (text === '') return null;
|
||||
var n = Number(text);
|
||||
return isFinite(n) ? n : NaN;
|
||||
}
|
||||
function round(n, places) { var f = Math.pow(10, places); return Math.round(n * f) / f; }
|
||||
function plain(n, places) { return String(round(n, places)); }
|
||||
|
||||
// ---- rows ----
|
||||
function rows() { return $tbody.children('tr.qbo-line'); }
|
||||
|
||||
function isSubtotal($row) { return $row.hasClass('qbo-line-subtotal'); }
|
||||
|
||||
function rowIsBlank($row) {
|
||||
if (isSubtotal($row)) return false;
|
||||
return !$row.find('.qbo-line-item-id').val() && !$row.find('.qbo-line-item-name').val().trim() &&
|
||||
!$row.find('.qbo-line-description-input').val().trim() && !$row.find('.qbo-line-rate-input').val().trim();
|
||||
}
|
||||
|
||||
function addRow() {
|
||||
var $row = $(template.replace(/__KEY__/g, String(nextKey++)));
|
||||
$tbody.append($row);
|
||||
setupRow($row);
|
||||
renumber();
|
||||
return $row;
|
||||
}
|
||||
|
||||
// QuickBooks keeps a spare empty line at the bottom; filling it adds another
|
||||
function ensureSpareRow() {
|
||||
var $last = rows().last();
|
||||
if (!$last.length || !rowIsBlank($last)) addRow();
|
||||
}
|
||||
|
||||
function renumber() {
|
||||
rows().each(function (i) { $(this).find('.qbo-line-number').text(i + 1); });
|
||||
}
|
||||
|
||||
function autoGrow(textarea) {
|
||||
textarea.style.height = 'auto';
|
||||
textarea.style.height = (textarea.scrollHeight + 2) + 'px';
|
||||
}
|
||||
|
||||
// Works out the line amount from qty x rate (qty defaults to 1, like QuickBooks)
|
||||
function lineAmount($row) {
|
||||
var rate = parseNumber($row.find('.qbo-line-rate-input').val());
|
||||
if (rate === null || isNaN(rate)) return null;
|
||||
var qty = parseNumber($row.find('.qbo-line-qty-input').val());
|
||||
if (qty === null) qty = 1;
|
||||
if (isNaN(qty)) return null;
|
||||
return round(qty * rate, 2);
|
||||
}
|
||||
|
||||
function recalc() {
|
||||
var subtotal = 0, taxable = 0, section = 0;
|
||||
rows().each(function () {
|
||||
var $row = $(this);
|
||||
// A subtotal row totals the lines since the previous subtotal
|
||||
if (isSubtotal($row)) {
|
||||
$row.find('.qbo-line-subtotal-amount').text(money.format(round(section, 2)));
|
||||
section = 0;
|
||||
return;
|
||||
}
|
||||
var amount = lineAmount($row);
|
||||
var $amount = $row.find('.qbo-line-amount-input');
|
||||
if (!$amount.is(':focus')) $amount.val(amount === null ? '' : amount.toFixed(2));
|
||||
if (amount !== null) {
|
||||
subtotal += amount;
|
||||
section += amount;
|
||||
if ($row.find('.qbo-line-taxable').is(':checked')) taxable += amount;
|
||||
}
|
||||
});
|
||||
subtotal = round(subtotal, 2);
|
||||
|
||||
// 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 total = round(subtotal - discount, 2);
|
||||
if (savedTax !== null && savedSubtotal !== null && Math.abs(subtotal - savedSubtotal) < 0.005) {
|
||||
$tax.text(money.format(savedTax)).removeClass('qbo-pending');
|
||||
total = round(total + savedTax, 2);
|
||||
} else {
|
||||
$tax.text($tax.data('pendingText')).addClass('qbo-pending');
|
||||
}
|
||||
|
||||
$('#qbo-estimate-subtotal').text(money.format(subtotal));
|
||||
$('#qbo-estimate-taxable-subtotal').text(money.format(round(taxable, 2)));
|
||||
$('#qbo-estimate-total').text(money.format(total));
|
||||
$('#qbo-estimate-amount').text(money.format(total));
|
||||
}
|
||||
|
||||
// ---- product/service search ----
|
||||
function setupItemSearch($input) {
|
||||
$input.autocomplete({
|
||||
appendTo: 'body',
|
||||
minLength: 0,
|
||||
delay: 150,
|
||||
source: function (request, response) {
|
||||
$.getJSON($form.data('itemsUrl'), { q: request.term })
|
||||
.done(function (items) {
|
||||
response(items.map(function (item) {
|
||||
return { label: item.name, value: item.name, item: item };
|
||||
}));
|
||||
})
|
||||
.fail(function () { response([]); });
|
||||
},
|
||||
select: function (event, ui) {
|
||||
var $row = $input.closest('tr');
|
||||
var item = ui.item.item;
|
||||
var $description = $row.find('.qbo-line-description-input');
|
||||
var previous = $row.data('itemDescription');
|
||||
|
||||
$input.val(item.name);
|
||||
$row.find('.qbo-line-item-id').val(item.id);
|
||||
$row.removeClass('qbo-line-unmatched');
|
||||
// Keep a description the user typed; replace one that came from the previous product
|
||||
if (!$description.val().trim() || $description.val() === previous) {
|
||||
$description.val(item.description || '');
|
||||
autoGrow($description[0]);
|
||||
}
|
||||
$row.data('itemDescription', item.description || '');
|
||||
if (item.price !== null && item.price !== undefined && item.price !== '') {
|
||||
$row.find('.qbo-line-rate-input').val(plain(parseFloat(item.price), 5));
|
||||
tidyNumbers($row);
|
||||
}
|
||||
if (!$row.find('.qbo-line-qty-input').val().trim()) $row.find('.qbo-line-qty-input').val('1');
|
||||
$row.find('.qbo-line-taxable').prop('checked', item.taxable !== false);
|
||||
changed();
|
||||
return false;
|
||||
}
|
||||
});
|
||||
|
||||
$input.autocomplete('instance')._renderItem = function (ul, entry) {
|
||||
var item = entry.item;
|
||||
var $div = $('<div>');
|
||||
if (item.price !== null && item.price !== undefined && item.price !== '') {
|
||||
$('<span class="qbo-item-option-price">').text(money.format(parseFloat(item.price))).appendTo($div);
|
||||
}
|
||||
$('<strong>').text(item.name).appendTo($div);
|
||||
var meta = [item.sku, item.description].filter(function (s) { return s; }).join(' · ');
|
||||
if (meta) $('<div class="qbo-item-option-meta">').text(meta.length > 90 ? meta.slice(0, 90) + '…' : meta).appendTo($div);
|
||||
return $('<li>').append($div).appendTo(ul);
|
||||
};
|
||||
|
||||
// Like QuickBooks, the list opens when the box is clicked
|
||||
$input.on('focus', function () {
|
||||
if (!$input.val()) $input.autocomplete('search', '');
|
||||
});
|
||||
|
||||
// Typing a different name unlinks the product until one is picked from the list
|
||||
$input.on('input', function () {
|
||||
var $row = $input.closest('tr');
|
||||
$row.find('.qbo-line-item-id').val('');
|
||||
$row.toggleClass('qbo-line-unmatched', $input.val().trim() !== '');
|
||||
});
|
||||
}
|
||||
|
||||
function setupRow($row) {
|
||||
if (isSubtotal($row) || $row.data('qboSetup')) return;
|
||||
$row.data('qboSetup', true);
|
||||
setupItemSearch($row.find('.qbo-line-item-name'));
|
||||
$row.find('.qbo-line-description-input').each(function () { autoGrow(this); });
|
||||
$row.data('itemDescription', $row.find('.qbo-line-item-id').val() ? $row.find('.qbo-line-description-input').val() : null);
|
||||
}
|
||||
|
||||
function changed() {
|
||||
dirty = true;
|
||||
recalc();
|
||||
ensureSpareRow();
|
||||
}
|
||||
|
||||
// ---- line events ----
|
||||
$tbody.on('input', '.qbo-line-qty-input, .qbo-line-rate-input, .qbo-line-description-input, .qbo-line-item-name', changed);
|
||||
$tbody.on('change', '.qbo-line-taxable', changed);
|
||||
$tbody.on('input', '.qbo-line-description-input', function () { autoGrow(this); });
|
||||
|
||||
// Typing an amount works out the rate from the quantity
|
||||
$tbody.on('input', '.qbo-line-amount-input', function () {
|
||||
var $row = $(this).closest('tr');
|
||||
var amount = parseNumber($(this).val());
|
||||
if (amount === null || isNaN(amount)) return;
|
||||
var qty = parseNumber($row.find('.qbo-line-qty-input').val());
|
||||
if (qty === null || isNaN(qty) || qty === 0) qty = 1;
|
||||
$row.find('.qbo-line-rate-input').val(plain(amount / qty, 5));
|
||||
changed();
|
||||
});
|
||||
|
||||
// Rates show cents (1120 -> 1120.00) unless they need more places; quantities stay plain
|
||||
function tidyNumbers($row) {
|
||||
$row.find('.qbo-line-qty-input, .qbo-line-rate-input').each(function () {
|
||||
var n = parseNumber(this.value);
|
||||
if (n === null || isNaN(n)) return;
|
||||
var isRate = $(this).hasClass('qbo-line-rate-input');
|
||||
this.value = isRate && round(n, 2) === round(n, 5) ? n.toFixed(2) : plain(n, 5);
|
||||
});
|
||||
}
|
||||
$tbody.on('blur', '.qbo-line-rate-input, .qbo-line-qty-input, .qbo-line-amount-input', function () {
|
||||
tidyNumbers($(this).closest('tr'));
|
||||
recalc();
|
||||
});
|
||||
|
||||
$tbody.on('click', '.qbo-line-remove-button', function () {
|
||||
var $row = $(this).closest('tr');
|
||||
if (rows().length > 1) {
|
||||
$row.remove();
|
||||
} else {
|
||||
$row.find('input[type=text], textarea, .qbo-line-item-id').val('');
|
||||
$row.removeClass('qbo-line-unmatched');
|
||||
}
|
||||
renumber();
|
||||
changed();
|
||||
});
|
||||
|
||||
$('#qbo-estimate-add-lines').on('click', function () {
|
||||
for (var i = 0; i < 4; i++) addRow();
|
||||
dirty = true;
|
||||
});
|
||||
|
||||
// A subtotal goes after the last filled line, above the spare empty rows
|
||||
$('#qbo-estimate-add-subtotal').on('click', function () {
|
||||
var $subtotal = $(subtotalTemplate.replace(/__KEY__/g, String(nextKey++)));
|
||||
var $filled = rows().filter(function () { return !rowIsBlank($(this)); });
|
||||
if ($filled.length) { $filled.last().after($subtotal); } else { $tbody.prepend($subtotal); }
|
||||
renumber();
|
||||
changed();
|
||||
});
|
||||
|
||||
$('#qbo-estimate-clear-lines').on('click', function () {
|
||||
if (!window.confirm($(this).data('confirmText'))) return;
|
||||
rows().remove();
|
||||
addRow(); addRow();
|
||||
changed();
|
||||
});
|
||||
|
||||
// Drag lines by the handle to reorder them; they're saved in table order
|
||||
$tbody.sortable({
|
||||
handle: '.qbo-line-handle',
|
||||
axis: 'y',
|
||||
items: '> tr.qbo-line',
|
||||
placeholder: 'qbo-line-placeholder',
|
||||
helper: function (event, tr) {
|
||||
var $originals = tr.children();
|
||||
var $helper = tr.clone();
|
||||
$helper.children().each(function (i) { $(this).width($originals.eq(i).outerWidth()); });
|
||||
return $helper;
|
||||
},
|
||||
start: function (event, ui) { ui.placeholder.html('<td colspan="9"></td>'); },
|
||||
// Moving a line or a subtotal changes what each subtotal covers
|
||||
update: function () { renumber(); changed(); }
|
||||
});
|
||||
|
||||
// ---- customer ----
|
||||
var $email = $('#qbo_estimate_email');
|
||||
var $vin = $('#qbo_estimate_vin');
|
||||
var loadedEmail = $email.val();
|
||||
|
||||
$('#customer_id').on('change', function () {
|
||||
var id = $(this).val();
|
||||
if (!id) return;
|
||||
dirty = true;
|
||||
$.getJSON($form.data('customerInfoUrl'), { customer_id: id }).done(function (info) {
|
||||
// Replace the email only if it was the previous customer's (or empty)
|
||||
if (!$email.val().trim() || $email.val() === loadedEmail) $email.val(info.email || '');
|
||||
loadedEmail = info.email || '';
|
||||
$('#qbo-estimate-address').text(info.billing_address || '');
|
||||
|
||||
var $list = $('#qbo-estimate-vins').empty();
|
||||
(info.vehicles || []).forEach(function (vehicle) {
|
||||
$('<option>').attr('value', vehicle.vin).text(vehicle.name).appendTo($list);
|
||||
});
|
||||
if ($vin.length && !$vin.prop('disabled') && !$vin.val().trim() && (info.vehicles || []).length === 1) {
|
||||
$vin.val(info.vehicles[0].vin);
|
||||
}
|
||||
});
|
||||
});
|
||||
|
||||
// Clearing the customer name clears the customer
|
||||
$('#qbo_estimate_customer_name').on('input', function () {
|
||||
if (!this.value.trim()) $('#customer_id').val('');
|
||||
});
|
||||
|
||||
$vin.on('blur', function () { this.value = this.value.trim().toUpperCase(); });
|
||||
|
||||
// New estimates expire a set number of days after the estimate date (plugin setting)
|
||||
var expirationDays = parseInt($form.data('expirationDays'), 10) || 0;
|
||||
var $txnDate = $('#qbo_estimate_txn_date');
|
||||
var $expiration = $('#qbo_estimate_expiration_date');
|
||||
function addDays(iso, days) {
|
||||
var parts = iso.split('-').map(Number);
|
||||
var date = new Date(Date.UTC(parts[0], parts[1] - 1, parts[2] + days));
|
||||
return date.toISOString().slice(0, 10);
|
||||
}
|
||||
if (expirationDays > 0) {
|
||||
var lastDefault = $txnDate.val() ? addDays($txnDate.val(), expirationDays) : '';
|
||||
$txnDate.on('change', function () {
|
||||
if (!this.value) return;
|
||||
// Only move a date that's still the default (or empty), not one picked by hand
|
||||
if (!$expiration.val() || $expiration.val() === lastDefault) {
|
||||
lastDefault = addDays(this.value, expirationDays);
|
||||
$expiration.val(lastDefault);
|
||||
}
|
||||
});
|
||||
}
|
||||
|
||||
// ---- invoices: import billable time and open estimates ----
|
||||
var $panel = $('#qbo-import-panel');
|
||||
if ($panel.length) {
|
||||
var importData = null;
|
||||
var undoState = null;
|
||||
var $status = $('#qbo-import-status');
|
||||
|
||||
var setStatus = function (text) { $status.text(text || ''); };
|
||||
var linkedEstimateIds = function () {
|
||||
return $('#qbo-linked-estimates input').map(function () { return this.value; }).get();
|
||||
};
|
||||
var timeIdsInForm = function () {
|
||||
return $tbody.find('.qbo-line-time-id').map(function () { return this.value; }).get().filter(Boolean);
|
||||
};
|
||||
|
||||
// A new row (not yet in the table) filled with an imported line
|
||||
var makeRow = function (line) {
|
||||
if (line.kind === 'subtotal') return $(subtotalTemplate.replace(/__KEY__/g, String(nextKey++)));
|
||||
var $row = $(template.replace(/__KEY__/g, String(nextKey++)));
|
||||
$row.find('.qbo-line-item-id').val(line.item_id || '');
|
||||
$row.find('.qbo-line-item-name').val(line.item_name || '');
|
||||
$row.find('.qbo-line-description-input').val(line.description || '');
|
||||
$row.find('.qbo-line-qty-input').val(line.quantity || '');
|
||||
$row.find('.qbo-line-rate-input').val(line.rate || '');
|
||||
$row.find('.qbo-line-taxable').prop('checked', !!line.taxable);
|
||||
if (line.time_activity_id) {
|
||||
$row.find('.qbo-line-time-id').val(line.time_activity_id);
|
||||
$row.addClass('qbo-line-time');
|
||||
}
|
||||
return $row;
|
||||
};
|
||||
|
||||
// The issue a line came from: "Install #116: some job" on time, "Added from: Install #116: ..." on estimates
|
||||
var issueOf = function (text) {
|
||||
var match = /#(\d+):/.exec((text || '').split('\n')[0]);
|
||||
return match ? match[1] : null;
|
||||
};
|
||||
|
||||
// The last time line on the invoice for the issue
|
||||
var timeRowForIssue = function (issueId) {
|
||||
return rows().filter(function () {
|
||||
var $row = $(this);
|
||||
return $row.hasClass('qbo-line-time') && issueOf($row.find('.qbo-line-description-input').val()) === issueId;
|
||||
}).last();
|
||||
};
|
||||
|
||||
// Issues behind the invoice's time lines and "Added from" notes
|
||||
var invoiceIssueIds = function () {
|
||||
var ids = [];
|
||||
rows().each(function () {
|
||||
var $row = $(this);
|
||||
if (isSubtotal($row)) return;
|
||||
var description = $row.find('.qbo-line-description-input').val() || '';
|
||||
if (!$row.hasClass('qbo-line-time') && !/^\s*Added from:/i.test(description)) return;
|
||||
var id = issueOf(description);
|
||||
if (id && ids.indexOf(id) < 0) ids.push(id);
|
||||
});
|
||||
return ids;
|
||||
};
|
||||
|
||||
// VIN and mileage from the work orders (via plugins such as redmine_qbo_vehicles and redmine_mileage_cp):
|
||||
// one vehicle fills the VIN box; the highest mileage fills the mileage box
|
||||
var updateVehicleFields = function (issueIds) {
|
||||
var values = (importData && importData.issue_values) || {};
|
||||
var vins = [], mileage = null;
|
||||
issueIds.forEach(function (id) {
|
||||
var v = values[id] || {};
|
||||
if (v.vin && vins.indexOf(v.vin.toUpperCase()) < 0) vins.push(v.vin.toUpperCase());
|
||||
var miles = parseNumber(v.mileage);
|
||||
if (miles !== null && !isNaN(miles) && (mileage === null || miles > mileage)) mileage = miles;
|
||||
});
|
||||
var $vinBox = $('#qbo_estimate_vin');
|
||||
if (vins.length === 1 && $vinBox.length && !$vinBox.prop('disabled')) $vinBox.val(vins[0]);
|
||||
var $mileageBox = $('#qbo_estimate_mileage');
|
||||
if (mileage !== null && $mileageBox.length) $mileageBox.val(String(mileage));
|
||||
return vins;
|
||||
};
|
||||
|
||||
// Rows go after the last filled line, above the spare empty rows
|
||||
var insertAfterFilled = function ($rows) {
|
||||
var $filled = rows().filter(function () { return !rowIsBlank($(this)); });
|
||||
if ($filled.length) { $filled.last().after($rows); } else { $tbody.prepend($rows); }
|
||||
};
|
||||
|
||||
var lineLabel = function ($row) {
|
||||
var item = $row.find('.qbo-line-item-name').val();
|
||||
var description = ($row.find('.qbo-line-description-input').val() || '').split('\n')[0];
|
||||
var amount = $row.find('.qbo-line-amount-input').val();
|
||||
return '#' + $row.find('.qbo-line-number').text().trim() + ' ' + [item, description].filter(Boolean).join(' – ') +
|
||||
(amount ? ' (' + money.format(parseFloat(amount)) + ')' : '');
|
||||
};
|
||||
|
||||
// The invoice's lines, for ticking the ones the time replaces (e.g. the estimate's labor lines).
|
||||
// When products/services are set as replaceable by time in the plugin settings, only lines with one of
|
||||
// them are offered; with none set, every line is.
|
||||
var replaceable = ($form.data('replaceableItemIds') || []).map(String);
|
||||
var fillReplaceList = function () {
|
||||
var $list = $('#qbo-import-replace').empty();
|
||||
rows().each(function () {
|
||||
var $row = $(this);
|
||||
if (isSubtotal($row) || rowIsBlank($row) || $row.hasClass('qbo-line-time')) return;
|
||||
if (replaceable.length && replaceable.indexOf(String($row.find('.qbo-line-item-id').val())) < 0) return;
|
||||
var $box = $('<input type="checkbox">').data('row', $row);
|
||||
$('<li>').append($('<label>').append($box, ' ', document.createTextNode(lineLabel($row)))).appendTo($list);
|
||||
});
|
||||
if (!$list.children().length) $('<li>').text($panel.data('noneText')).appendTo($list);
|
||||
};
|
||||
|
||||
var emptyRow = function ($tbodyEl, columns) {
|
||||
$('<tr>').append($('<td>').attr('colspan', columns).addClass('qbo-import-none').text($panel.data('noneText'))).appendTo($tbodyEl);
|
||||
};
|
||||
|
||||
var renderImport = function () {
|
||||
var used = timeIdsInForm();
|
||||
var linked = linkedEstimateIds();
|
||||
var $time = $('#qbo-import-time tbody').empty();
|
||||
importData.time_activities.forEach(function (activity, index) {
|
||||
if (used.indexOf(activity.id) >= 0) return;
|
||||
$('<tr>').append(
|
||||
$('<td>').append($('<input type="checkbox" class="qbo-import-pick">').val(index)),
|
||||
$('<td>').text(activity.date),
|
||||
$('<td>').text(activity.item_name || ''),
|
||||
$('<td>').text([activity.employee, activity.description].filter(Boolean).join(': ')),
|
||||
$('<td class="qbo-num">').text(activity.quantity),
|
||||
$('<td class="qbo-num">').text(money.format(parseFloat(activity.amount)))
|
||||
).appendTo($time);
|
||||
});
|
||||
if (!$time.children().length) emptyRow($time, 6);
|
||||
|
||||
var $estimates = $('#qbo-import-estimates tbody').empty();
|
||||
importData.estimates.forEach(function (estimate, index) {
|
||||
if (linked.indexOf(estimate.id) >= 0) return;
|
||||
var first = estimate.lines.filter(function (l) { return l.description; })[0];
|
||||
$('<tr>').append(
|
||||
$('<td>').append($('<input type="checkbox" class="qbo-import-pick">').val(index)),
|
||||
$('<td>').text('#' + estimate.doc_number),
|
||||
$('<td>').text(estimate.date),
|
||||
$('<td>').text(estimate.issue || (first ? first.description.split('\n')[0] : '')),
|
||||
$('<td class="qbo-num">').text(money.format(parseFloat(estimate.total || 0)))
|
||||
).appendTo($estimates);
|
||||
});
|
||||
if (!$estimates.children().length) emptyRow($estimates, 5);
|
||||
};
|
||||
|
||||
$('#qbo-import-open').on('click', function () {
|
||||
$panel.prop('hidden', false);
|
||||
importData = null;
|
||||
$('#qbo-import-time tbody, #qbo-import-estimates tbody').empty();
|
||||
fillReplaceList();
|
||||
var customerId = $('#customer_id').val();
|
||||
if (!customerId) { setStatus($panel.data('needCustomerText')); return; }
|
||||
setStatus($panel.data('loadingText'));
|
||||
$.getJSON($form.data('importUrl'), { customer_id: customerId, issue_ids: invoiceIssueIds() })
|
||||
.done(function (data) { importData = data; renderImport(); setStatus(''); })
|
||||
.fail(function (xhr) { setStatus((xhr.responseJSON && xhr.responseJSON.error) || xhr.statusText); });
|
||||
});
|
||||
|
||||
$('#qbo-import-close').on('click', function () { $panel.prop('hidden', true); });
|
||||
|
||||
$panel.on('change', '.qbo-import-all', function () {
|
||||
$('#' + $(this).data('target') + ' .qbo-import-pick').prop('checked', this.checked);
|
||||
});
|
||||
|
||||
$('#qbo-import-add').on('click', function () {
|
||||
if (!importData) return;
|
||||
var times = $('#qbo-import-time .qbo-import-pick:checked').map(function () { return importData.time_activities[this.value]; }).get();
|
||||
var estimates = $('#qbo-import-estimates .qbo-import-pick:checked').map(function () { return importData.estimates[this.value]; }).get();
|
||||
if (!times.length && !estimates.length) return;
|
||||
|
||||
// Kept so the import can be undone before saving (clones keep what was typed)
|
||||
undoState = { rows: rows().clone(), linked: $('#qbo-linked-estimates').children().clone() };
|
||||
|
||||
// Time goes where the first ticked line was; the ticked lines are removed
|
||||
if (times.length) {
|
||||
var $timeRows = $(times.map(function (activity) {
|
||||
return makeRow($.extend({}, activity, { time_activity_id: activity.id }))[0];
|
||||
}));
|
||||
var $replaced = $('#qbo-import-replace input:checked').map(function () { return $(this).data('row')[0]; });
|
||||
var $anchor = rows().filter(function () { return $replaced.index(this) >= 0; }).first();
|
||||
if ($anchor.length) { $anchor.before($timeRows); } else { insertAfterFilled($timeRows); }
|
||||
$replaced.remove();
|
||||
}
|
||||
|
||||
// Each estimate's lines go right after the time for the same issue (e.g. lineitems' "Added from:
|
||||
// Install #116" estimate after the time for #116), and its "Added from" note is dropped since the time
|
||||
// line already names the issue. Estimates with no matching time keep the note and go at the end.
|
||||
// The estimate is linked and closed when the invoice is saved.
|
||||
var isAddedFromNote = function (line) {
|
||||
return !line.kind && !line.item_id && !line.rate && /^\s*Added from:/i.test(line.description || '');
|
||||
};
|
||||
var lastForIssue = {};
|
||||
estimates.forEach(function (estimate) {
|
||||
var issueId = estimate.issue_id ? String(estimate.issue_id) : null;
|
||||
var $anchor = issueId ? (lastForIssue[issueId] || timeRowForIssue(issueId)) : $();
|
||||
var placed = !!($anchor && $anchor.length);
|
||||
var lines = placed ? estimate.lines.filter(function (line) { return !isAddedFromNote(line); }) : estimate.lines;
|
||||
var $estimateRows = $(lines.map(function (line) { return makeRow(line)[0]; }));
|
||||
if (!$estimateRows.length) {
|
||||
// Nothing but the note: nothing to add
|
||||
} else if (placed) {
|
||||
$anchor.after($estimateRows);
|
||||
lastForIssue[issueId] = $estimateRows.last();
|
||||
} else {
|
||||
insertAfterFilled($estimateRows);
|
||||
}
|
||||
$('<input type="hidden" name="estimate[linked_estimate_ids][]">').val(estimate.id).appendTo('#qbo-linked-estimates');
|
||||
});
|
||||
|
||||
rows().each(function () { setupRow($(this)); tidyNumbers($(this)); });
|
||||
renumber();
|
||||
changed();
|
||||
|
||||
// Imported estimates' notes are dropped next to their time, so their issues are added here
|
||||
var issueIds = invoiceIssueIds();
|
||||
estimates.forEach(function (estimate) {
|
||||
if (estimate.issue_id && issueIds.indexOf(String(estimate.issue_id)) < 0) issueIds.push(String(estimate.issue_id));
|
||||
});
|
||||
var vins = updateVehicleFields(issueIds);
|
||||
$panel.prop('hidden', true);
|
||||
if (vins.length > 1) window.alert($panel.data('manyVehiclesText') + ' ' + vins.join(', '));
|
||||
$('#qbo-import-undo').prop('hidden', false);
|
||||
});
|
||||
|
||||
$('#qbo-import-undo').on('click', function () {
|
||||
if (!undoState) return;
|
||||
$tbody.empty().append(undoState.rows);
|
||||
$('#qbo-linked-estimates').empty().append(undoState.linked);
|
||||
undoState = null;
|
||||
rows().each(function () { setupRow($(this)); });
|
||||
renumber();
|
||||
changed();
|
||||
$(this).prop('hidden', true);
|
||||
});
|
||||
}
|
||||
|
||||
// ---- saving ----
|
||||
$form.on('input change', '.qbo-estimate-top input, .qbo-estimate-details input, .qbo-estimate-notes textarea', function () { dirty = true; });
|
||||
|
||||
// Enter in a text box shouldn't save the estimate half-written
|
||||
$form.on('keydown', 'input[type=text], input[type=date]', function (event) {
|
||||
if (event.key === 'Enter' && !$(this).closest('.ui-autocomplete').length) event.preventDefault();
|
||||
});
|
||||
|
||||
$form.on('submit', function (event) {
|
||||
var submitter = event.originalEvent && event.originalEvent.submitter;
|
||||
if (submitter && submitter.id === 'qbo-estimate-save-and-send' && !$email.val().trim()) {
|
||||
event.preventDefault();
|
||||
window.alert($(submitter).data('needsEmailText'));
|
||||
$email.trigger('focus');
|
||||
return;
|
||||
}
|
||||
dirty = false;
|
||||
});
|
||||
|
||||
window.addEventListener('beforeunload', function (event) {
|
||||
if (!dirty || !$form.data('warnUnsaved')) return;
|
||||
event.preventDefault();
|
||||
event.returnValue = '';
|
||||
});
|
||||
|
||||
rows().each(function () { tidyNumbers($(this)); });
|
||||
|
||||
// Estimates with bundles are shown read-only
|
||||
if (locked) { recalc(); return; }
|
||||
|
||||
rows().each(function () { setupRow($(this)); });
|
||||
ensureSpareRow();
|
||||
recalc();
|
||||
});
|
||||
<% end %>
|
||||
@@ -0,0 +1,163 @@
|
||||
<%# Inline so the page never depends on precompiled plugin assets %>
|
||||
<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] .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; }
|
||||
.qbo-estimate-row { display: flex; flex-wrap: wrap; gap: 16px 20px; align-items: flex-start; margin-bottom: 16px; }
|
||||
.qbo-field { display: flex; flex-direction: column; gap: 4px; }
|
||||
.qbo-field label, .qbo-field .qbo-label { font-size: 0.9em; font-weight: 600; color: #393a3d; }
|
||||
.qbo-field input[type=text], .qbo-field input[type=date], .qbo-field textarea {
|
||||
border: 1px solid var(--qbo-border); border-radius: 4px; padding: 6px 8px; font-size: 1em; box-sizing: border-box; background: #fff;
|
||||
font-family: inherit; height: auto;
|
||||
}
|
||||
.qbo-field input[type=text], .qbo-field input[type=date] { height: 34px; }
|
||||
.qbo-field input:focus, .qbo-field textarea:focus, .qbo-estimate-lines input:focus, .qbo-estimate-lines textarea:focus {
|
||||
outline: none; border-color: var(--qbo-green); box-shadow: 0 0 0 2px rgba(44,160,28,.25);
|
||||
}
|
||||
.qbo-field input[readonly], .qbo-field input[disabled] { background: #f4f5f8; color: #393a3d; }
|
||||
.qbo-field em.info { font-size: .85em; max-width: 220px; }
|
||||
.qbo-field-customer input { width: 280px; }
|
||||
.qbo-field-email input { width: 300px; }
|
||||
.qbo-field-date input { width: 150px; }
|
||||
.qbo-field-number input { width: 160px; }
|
||||
.qbo-field-sales-person input { width: 200px; }
|
||||
.qbo-field-vin input { width: 220px; font-family: monospace; text-transform: uppercase; }
|
||||
.qbo-field-mileage input { width: 120px; }
|
||||
.qbo-field-refresh { align-self: flex-end; padding-bottom: 6px; max-width: 420px; }
|
||||
.qbo-address { min-width: 220px; min-height: 4.5em; white-space: pre-line; color: #393a3d; padding: 6px 0; line-height: 1.4; }
|
||||
.qbo-estimate-amount { text-align: right; flex-shrink: 0; }
|
||||
.qbo-estimate-amount-label { display: block; font-size: .8em; font-weight: 600; letter-spacing: .05em; text-transform: uppercase; color: var(--qbo-muted); }
|
||||
.qbo-estimate-amount-value { display: block; font-size: 2.6em; font-weight: 700; color: #393a3d; line-height: 1.1; font-variant-numeric: tabular-nums; }
|
||||
|
||||
.qbo-estimate-lines-wrap { overflow-x: auto; margin-top: 8px; }
|
||||
.qbo-estimate-lines { width: 100%; border-collapse: collapse; min-width: 820px; }
|
||||
.qbo-estimate-lines th { font-size: .78em; font-weight: 600; letter-spacing: .04em; text-transform: uppercase; color: var(--qbo-muted);
|
||||
text-align: left; padding: 8px 6px; border-bottom: 2px solid #d4d7dc; white-space: nowrap; }
|
||||
.qbo-estimate-lines td { padding: 6px; border-bottom: 1px solid #e3e5e8; vertical-align: top; }
|
||||
.qbo-estimate-lines input[type=text], .qbo-estimate-lines textarea {
|
||||
width: 100%; box-sizing: border-box; border: 1px solid transparent; border-radius: 3px; padding: 5px 6px; font-size: 1em; background: transparent; font-family: inherit;
|
||||
}
|
||||
.qbo-estimate-lines tr:hover input[type=text], .qbo-estimate-lines tr:hover textarea,
|
||||
.qbo-estimate-lines tr:focus-within input[type=text], .qbo-estimate-lines tr:focus-within textarea { border-color: var(--qbo-border); background: #fff; }
|
||||
.qbo-estimate-lines textarea { resize: none; min-height: 2.1em; line-height: 1.35; overflow: hidden; }
|
||||
.qbo-estimate-lines .qbo-line-handle { width: 18px; cursor: grab; color: #8d9096; padding-top: 10px; }
|
||||
.qbo-estimate-lines .qbo-line-number { width: 24px; color: var(--qbo-muted); padding-top: 11px; text-align: right; }
|
||||
.qbo-estimate-lines .qbo-line-item { width: 22%; }
|
||||
.qbo-estimate-lines .qbo-line-qty { width: 70px; }
|
||||
.qbo-estimate-lines .qbo-line-rate, .qbo-estimate-lines .qbo-line-amount { width: 100px; }
|
||||
.qbo-estimate-lines td.qbo-line-qty input, .qbo-estimate-lines td.qbo-line-rate input, .qbo-estimate-lines td.qbo-line-amount input { text-align: right; font-variant-numeric: tabular-nums; }
|
||||
.qbo-estimate-lines th.qbo-line-qty, .qbo-estimate-lines th.qbo-line-rate, .qbo-estimate-lines th.qbo-line-amount { text-align: right; }
|
||||
.qbo-estimate-lines .qbo-line-tax { width: 40px; text-align: center; padding-top: 11px; }
|
||||
.qbo-estimate-lines .qbo-line-remove { width: 28px; padding-top: 8px; }
|
||||
.qbo-line-remove-button { border: 0; background: none; cursor: pointer; color: #8d9096; padding: 2px; visibility: hidden; }
|
||||
.qbo-estimate-lines tr:hover .qbo-line-remove-button, .qbo-estimate-lines tr:focus-within .qbo-line-remove-button { visibility: visible; }
|
||||
.qbo-line-remove-button:hover { color: #c00; }
|
||||
.qbo-line.qbo-line-unmatched .qbo-line-item-name { border-color: #d52b1e !important; background: #fff4f3 !important; }
|
||||
.qbo-line-subtotal td { background: #f4f5f8; }
|
||||
.qbo-estimate-lines td.qbo-line-subtotal-label { text-align: right; font-weight: 600; padding-top: 11px; color: #393a3d; }
|
||||
.qbo-estimate-lines td.qbo-line-subtotal-amount { text-align: right; font-weight: 600; padding: 11px 12px 6px 6px; font-variant-numeric: tabular-nums; }
|
||||
.qbo-line.ui-sortable-helper { background: #fff; box-shadow: 0 2px 8px rgba(0,0,0,.2); display: table; }
|
||||
.qbo-line-placeholder td { background: #eef7ec; height: 2.4em; }
|
||||
.ui-autocomplete .qbo-item-option-meta { color: var(--qbo-muted, #6b6c72); font-size: .85em; }
|
||||
.ui-autocomplete .qbo-item-option-price { float: right; margin-left: 12px; font-variant-numeric: tabular-nums; }
|
||||
|
||||
/* Invoice lines that bill a QuickBooks time activity */
|
||||
.qbo-estimate .qbo-button[hidden] { display: none; }
|
||||
.qbo-line-time-badge { display: none; }
|
||||
.qbo-estimate-lines td.qbo-line-description { position: relative; }
|
||||
.qbo-line-time .qbo-line-time-badge { display: block; position: absolute; top: 0; right: 8px; z-index: 1; font-size: .65em; font-weight: 600;
|
||||
text-transform: uppercase; letter-spacing: .04em; background: #e8eefa; color: #0d47a1; border-radius: 8px; padding: 0 6px; pointer-events: none; }
|
||||
|
||||
/* Invoice import panel */
|
||||
.qbo-import-panel { border: 1px solid #d4d7dc; border-radius: 4px; background: #f8f9fa; padding: 12px 16px; margin: 0 0 20px; }
|
||||
.qbo-import-panel[hidden] { display: none; }
|
||||
.qbo-import-panel h4 { margin: 4px 0 8px; font-size: .95em; }
|
||||
.qbo-import-columns { display: flex; gap: 24px; flex-wrap: wrap; }
|
||||
.qbo-import-time { flex: 2 1 480px; min-width: 0; }
|
||||
.qbo-import-replace { flex: 1 1 260px; }
|
||||
.qbo-import-replace ul { list-style: none; margin: 0; padding: 0; max-height: 260px; overflow: auto; }
|
||||
.qbo-import-replace li { padding: 3px 0; }
|
||||
.qbo-import-table { width: 100%; border-collapse: collapse; background: #fff; }
|
||||
.qbo-import-table th { font-size: .78em; text-transform: uppercase; color: var(--qbo-muted); text-align: left; padding: 6px; border-bottom: 1px solid #d4d7dc; }
|
||||
.qbo-import-table td { padding: 6px; border-bottom: 1px solid #eceef1; vertical-align: top; }
|
||||
.qbo-import-table .qbo-num { text-align: right; font-variant-numeric: tabular-nums; white-space: nowrap; }
|
||||
.qbo-import-table td.qbo-import-none { color: var(--qbo-muted); font-style: italic; }
|
||||
.qbo-import-estimates { margin-top: 14px; }
|
||||
.qbo-import-buttons { display: flex; gap: 8px; align-items: center; margin: 14px 0 0; }
|
||||
.qbo-import-status { color: var(--qbo-muted); }
|
||||
|
||||
.qbo-estimate-line-buttons { margin: 12px 0 20px; display: flex; flex-wrap: wrap; gap: 8px; }
|
||||
.qbo-estimate-bottom { display: flex; justify-content: space-between; gap: 32px; flex-wrap: wrap; }
|
||||
.qbo-estimate-notes { display: flex; flex-direction: column; gap: 14px; flex: 1 1 320px; max-width: 460px; }
|
||||
.qbo-estimate-notes textarea { width: 100%; }
|
||||
.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-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; }
|
||||
|
||||
.qbo-estimate .qbo-button { display: inline-flex; align-items: center; box-sizing: border-box; height: 34px; margin: 0;
|
||||
border: 1px solid #8d9096; background: #fff; color: #393a3d; border-radius: 4px; padding: 0 16px;
|
||||
font-size: 1em; font-family: inherit; font-weight: 600; cursor: pointer; text-decoration: none; line-height: 1; white-space: nowrap; }
|
||||
.qbo-estimate .qbo-button:hover { background: #f4f5f8; text-decoration: none; }
|
||||
.qbo-estimate-actions { position: sticky; bottom: 0; z-index: 5; display: flex; justify-content: space-between; align-items: center;
|
||||
background: var(--qbo-bar); padding: 10px 24px; border-radius: 0 0 4px 4px; margin-top: 0; }
|
||||
.qbo-estimate-actions-save { display: flex; gap: 8px; }
|
||||
.qbo-estimate .qbo-button-dark { background: transparent; color: #fff; border-color: #fff; }
|
||||
.qbo-estimate .qbo-button-dark:hover { background: rgba(255,255,255,.12); color: #fff; }
|
||||
.qbo-estimate-actions a.qbo-button-dark, .qbo-estimate-actions a.qbo-button-dark:hover { color: #fff; }
|
||||
.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; }
|
||||
|
||||
.qbo-estimate-status { display: inline-block; font-size: .6em; font-weight: 600; vertical-align: middle; padding: 2px 8px; border-radius: 10px;
|
||||
background: #eceef1; color: #393a3d; margin-left: 6px; }
|
||||
.qbo-estimate-status-sent { background: #e6f4e4; color: #108000; }
|
||||
.qbo-estimate-status-accepted { background: #e6f4e4; color: #108000; }
|
||||
.qbo-estimate-status-closed, .qbo-estimate-status-converted { background: #e8eefa; color: #0d47a1; }
|
||||
/* 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; }
|
||||
div.warning.qbo-estimate-notice li { margin: 2px 0; }
|
||||
.qbo-estimate-status-rejected { background: #fdecea; color: #b71c1c; }
|
||||
.qbo-estimate-edit-link { margin-left: 4px; vertical-align: middle; }
|
||||
|
||||
/* Phones: each line becomes a small card (number, product and delete; description; qty, rate, amount and tax) */
|
||||
@media (max-width: 699px) {
|
||||
.qbo-estimate-lines { min-width: 0; }
|
||||
.qbo-estimate-lines thead { display: none; }
|
||||
.qbo-estimate-lines tr.qbo-line { display: grid; grid-template-columns: 24px 1fr 1fr 1fr 44px; gap: 4px 8px; padding: 10px 0; border-bottom: 1px solid #d4d7dc; }
|
||||
.qbo-estimate-lines tr.qbo-line td { display: block; border: 0; padding: 0; width: auto; }
|
||||
.qbo-estimate-lines td[data-label]::before { content: attr(data-label); display: block; font-size: .75em; font-weight: 600; text-transform: uppercase; color: var(--qbo-muted); margin-bottom: 2px; }
|
||||
.qbo-estimate-lines tr.qbo-line td.qbo-line-handle { display: none; }
|
||||
.qbo-estimate-lines td.qbo-line-number { grid-column: 1; grid-row: 1; padding-top: 22px; text-align: left; }
|
||||
.qbo-estimate-lines td.qbo-line-item { grid-column: 2 / 5; grid-row: 1; }
|
||||
.qbo-estimate-lines td.qbo-line-remove { grid-column: 5; grid-row: 1; padding-top: 18px; text-align: center; }
|
||||
.qbo-estimate-lines td.qbo-line-description { grid-column: 2 / 6; grid-row: 2; }
|
||||
.qbo-estimate-lines td.qbo-line-qty { grid-column: 2; grid-row: 3; }
|
||||
.qbo-estimate-lines td.qbo-line-rate { grid-column: 3; grid-row: 3; }
|
||||
.qbo-estimate-lines td.qbo-line-amount { grid-column: 4; grid-row: 3; }
|
||||
.qbo-estimate-lines td.qbo-line-tax { grid-column: 5; grid-row: 3; text-align: center; }
|
||||
.qbo-estimate-lines td.qbo-line-tax input { margin-top: 8px; }
|
||||
.qbo-estimate-lines tr.qbo-line-subtotal { background: #f4f5f8; }
|
||||
.qbo-estimate-lines tr.qbo-line-subtotal td.qbo-line-subtotal-label { grid-column: 2 / 4; grid-row: 1; padding-top: 4px; }
|
||||
.qbo-estimate-lines tr.qbo-line-subtotal td.qbo-line-subtotal-amount { grid-column: 4; grid-row: 1; padding: 4px 0 0; }
|
||||
.qbo-estimate-lines tr.qbo-line-subtotal td.qbo-line-number { padding-top: 4px; }
|
||||
.qbo-estimate-lines tr.qbo-line-subtotal td.qbo-line-remove { padding-top: 0; }
|
||||
.qbo-estimate-lines tr.qbo-line-subtotal td.qbo-line-tax { display: none; }
|
||||
.qbo-estimate-lines input[type=text], .qbo-estimate-lines textarea { border-color: var(--qbo-border); background: #fff; }
|
||||
.qbo-line-remove-button { visibility: visible; }
|
||||
}
|
||||
|
||||
@media (max-width: 899px) {
|
||||
.qbo-estimate-sheet { padding: 14px; }
|
||||
.qbo-estimate-top { flex-direction: column-reverse; gap: 8px; }
|
||||
.qbo-estimate-amount { text-align: left; }
|
||||
.qbo-field-customer input, .qbo-field-email input { width: 100%; }
|
||||
.qbo-field-customer, .qbo-field-email { flex: 1 1 100%; }
|
||||
.qbo-estimate-totals { width: 100%; }
|
||||
.qbo-estimate-actions { padding: 10px 14px; }
|
||||
}
|
||||
</style>
|
||||
@@ -0,0 +1,16 @@
|
||||
<%# A subtotal row: totals the lines above it, back to the previous subtotal (QuickBooks works out the amount) %>
|
||||
<% name = "estimate[lines][#{key}]" %>
|
||||
<tr class="qbo-line qbo-line-subtotal">
|
||||
<td class="qbo-line-handle" title="<%= l(:label_drag_to_reorder) %>"><%= sprite_icon('reorder') %></td>
|
||||
<td class="qbo-line-number"><%= number %></td>
|
||||
<td class="qbo-line-subtotal-label" colspan="4">
|
||||
<%= hidden_field_tag "#{name}[id]", line.id, id: nil %>
|
||||
<%= hidden_field_tag "#{name}[kind]", 'subtotal', id: nil %>
|
||||
<%= l(:label_subtotal) %>
|
||||
</td>
|
||||
<td class="qbo-line-amount qbo-line-subtotal-amount"></td>
|
||||
<td class="qbo-line-tax"></td>
|
||||
<td class="qbo-line-remove">
|
||||
<button type="button" class="qbo-line-remove-button" title="<%= l(:button_delete) %>"><%= sprite_icon('del') %></button>
|
||||
</td>
|
||||
</tr>
|
||||
@@ -0,0 +1,26 @@
|
||||
<% html_title "#{l(:label_estimate)} ##{@form.doc_number}" %>
|
||||
|
||||
<div class="contextual">
|
||||
<%# Plugins add estimate actions here (e.g. redmine_qbo_calendar's Add appointment) %>
|
||||
<%= call_hook :view_qbo_estimate_contextual, { estimate_id: @form.id, customer_id: @form.customer_id, vin: @form.vin, doc_number: @form.doc_number } %>
|
||||
<%# An estimate is billed once: no Create invoice once it's on an invoice, closed or rejected %>
|
||||
<% if RedmineQboBilling.invoice_writer? && Array(@form.invoiced_on).empty? && !%w[Converted Closed Rejected].include?(@form.txn_status.to_s) %>
|
||||
<%= link_to sprite_icon('document', l(:button_create_invoice)), new_qbo_invoice_path(estimate_id: @form.id), class: 'icon icon-document' %>
|
||||
<% end %>
|
||||
<% if User.current.allowed_to?(:create_estimate_issues, nil, global: true) %>
|
||||
<%= link_to sprite_icon('issue', l(:button_create_estimate_issues)), issues_preview_qbo_estimate_path(@form.id), class: 'icon icon-issue' %>
|
||||
<% end %>
|
||||
<%= link_to sprite_icon('copy', l(:button_duplicate)), new_qbo_estimate_path(duplicate: @form.id), class: 'icon icon-copy' %>
|
||||
<%= link_to sprite_icon('application-pdf', l(:label_estimate_pdf)), estimate_path(@form.id), class: 'icon icon-pdf', target: :_blank %>
|
||||
<% if RedmineQboBilling.sender? && @form.email.present? %>
|
||||
<%= link_to sprite_icon('email', l(:button_email_estimate)), send_email_qbo_estimate_path(@form.id, email: @form.email),
|
||||
method: :post, class: 'icon icon-email',
|
||||
data: { confirm: l(:text_email_estimate_confirmation, number: @form.doc_number, email: @form.email) } %>
|
||||
<% end %>
|
||||
<%= link_to sprite_icon('link', l(:button_open_in_quickbooks)),
|
||||
"https://#{RedmineQbo.sandbox_mode? ? 'sandbox' : 'app'}.qbo.intuit.com/app/estimate?txnId=#{@form.id}",
|
||||
class: 'icon icon-link', target: :_blank, rel: 'noopener' %>
|
||||
</div>
|
||||
|
||||
<%= render partial: 'qbo_estimates/header', locals: { form: @form } %>
|
||||
<%= render partial: 'qbo_estimates/form', locals: { form: @form } %>
|
||||
@@ -0,0 +1,261 @@
|
||||
<% html_title l(:button_create_estimate_issues) %>
|
||||
<%# Extra params to carry through (e.g. appointment_id from redmine_qbo_calendar) %>
|
||||
<% carry = request.query_parameters.merge(request.request_parameters).slice('appointment_id') %>
|
||||
|
||||
<div class="contextual">
|
||||
<%= link_to sprite_icon('angle-left', @return_label), @return_path, class: 'icon icon-angle-left' %>
|
||||
</div>
|
||||
|
||||
<h2>
|
||||
<%= l(:button_create_estimate_issues) %>
|
||||
<span class="estimate-preview-subtitle">
|
||||
· <%= l(:label_estimate) %> #<%= @estimate.doc_number %>
|
||||
<% if @estimate.customer %>· <%= @estimate.customer.name %><% end %>
|
||||
</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>
|
||||
<%= 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>
|
||||
</p>
|
||||
<% end %>
|
||||
<% else %>
|
||||
<p><strong><%= l(:field_project) %>:</strong> <%= link_to_project @target_project %></p>
|
||||
<% end %>
|
||||
|
||||
<% if @builder.errors.any? %>
|
||||
<div id="errorExplanation">
|
||||
<ul>
|
||||
<% @builder.errors.each do |message| %>
|
||||
<li><%= message %></li>
|
||||
<% end %>
|
||||
</ul>
|
||||
</div>
|
||||
<% end %>
|
||||
|
||||
<% proposals = @builder.proposals %>
|
||||
|
||||
<% if proposals.empty? %>
|
||||
<p class="nodata">
|
||||
<%= l(:error_no_labor_lines_found) %>
|
||||
(<%= l(:label_estimate_item_codes) %>: <%= RedmineQboBilling::EstimateIssueBuilder.item_codes.join(', ') %>)
|
||||
<% if User.current.admin? %>
|
||||
· <%= link_to l(:label_settings), plugin_settings_path(id: 'redmine_qbo') %>
|
||||
<% end %>
|
||||
</p>
|
||||
<% else %>
|
||||
<%
|
||||
templates_enabled = RedmineQboBilling::IssueTemplateSupport.enabled_for?(@target_project)
|
||||
template_data = @templates.map { |t| { key: t.key, title: t.title, tracker_id: t.tracker_id, is_default: t.is_default, group: t.group } }
|
||||
default_template_for = ->(tracker_id) { @templates.detect { |t| t.tracker_id == tracker_id.to_i && t.is_default }&.key }
|
||||
selectable_count = proposals.count { |p| !p.created? }
|
||||
%>
|
||||
|
||||
<%= form_tag create_issues_qbo_estimate_path(@estimate.id),
|
||||
method: :post,
|
||||
id: 'estimate-issues-form',
|
||||
data: { templates: template_data.to_json } do %>
|
||||
<%= hidden_field_tag :project_id, @target_project.id %>
|
||||
<% carry.each do |key, value| %><%= hidden_field_tag key, value, id: nil %><% end %>
|
||||
|
||||
<table class="list estimate-issues-preview">
|
||||
<thead>
|
||||
<tr>
|
||||
<th class="checkbox">
|
||||
<% if selectable_count > 0 %>
|
||||
<input type="checkbox" id="estimate-issues-toggle-all" checked title="<%= l(:button_check_all) %>">
|
||||
<% end %>
|
||||
</th>
|
||||
<th><%= l(:label_estimate_item) %></th>
|
||||
<th><%= l(:field_subject) %></th>
|
||||
<th><%= l(:field_tracker) %></th>
|
||||
<% if templates_enabled %>
|
||||
<th><%= l(:label_issue_template) %></th>
|
||||
<% end %>
|
||||
<th><%= l(:field_estimated_hours) %></th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<% proposals.each do |proposal| %>
|
||||
<% field = "lines[#{proposal.line_id}]" %>
|
||||
<% if proposal.created? %>
|
||||
<tr class="estimate-line created">
|
||||
<td class="checkbox"><input type="checkbox" disabled></td>
|
||||
<td><%= proposal.item_name %></td>
|
||||
<td class="subject"><%= proposal.description %></td>
|
||||
<td colspan="<%= templates_enabled ? 3 : 2 %>">
|
||||
<%= l(:label_estimate_line_already_created) %>:
|
||||
<%= link_to_issue(proposal.existing_issue, truncate: 60) %>
|
||||
</td>
|
||||
</tr>
|
||||
<% else %>
|
||||
<%
|
||||
row = (@rows[proposal.line_id] || {}).to_h
|
||||
selected = row.empty? || row['selected'] == '1'
|
||||
tracker_id = (row['tracker_id'].presence || @default_tracker&.id).to_i
|
||||
template_key = row.key?('template') ? row['template'] : default_template_for.call(tracker_id)
|
||||
hours = row.key?('estimated_hours') ? row['estimated_hours'] : proposal.hours
|
||||
%>
|
||||
<tr class="estimate-line">
|
||||
<td class="checkbox">
|
||||
<%= hidden_field_tag "#{field}[selected]", '0', id: nil %>
|
||||
<%= check_box_tag "#{field}[selected]", '1', selected, class: 'estimate-line-select', id: nil %>
|
||||
</td>
|
||||
<td><%= proposal.item_name %></td>
|
||||
<td class="subject">
|
||||
<%= text_field_tag "#{field}[subject]", row['subject'] || proposal.description,
|
||||
maxlength: 255, class: 'estimate-line-subject', id: nil %>
|
||||
</td>
|
||||
<td>
|
||||
<%= select_tag "#{field}[tracker_id]",
|
||||
options_from_collection_for_select(@trackers, :id, :name, tracker_id),
|
||||
class: 'estimate-line-tracker', id: nil %>
|
||||
</td>
|
||||
<% if templates_enabled %>
|
||||
<td>
|
||||
<%# Options are filled by the script below to match the chosen tracker %>
|
||||
<%= select_tag "#{field}[template]",
|
||||
options_for_select([[l(:label_no_issue_template), '']] +
|
||||
@templates.select { |t| t.tracker_id == tracker_id }.map { |t| [t.title, t.key] }, template_key),
|
||||
class: 'estimate-line-template', id: nil %>
|
||||
</td>
|
||||
<% end %>
|
||||
<td>
|
||||
<%= number_field_tag "#{field}[estimated_hours]", hours, step: 0.25, min: 0, size: 6, id: nil %>
|
||||
</td>
|
||||
</tr>
|
||||
<% end %>
|
||||
<% end %>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
<%# Custom fields for the chosen trackers, entered once and applied to every issue that uses them %>
|
||||
<% if @field_set&.any? %>
|
||||
<fieldset class="box tabular estimate-issue-fields" id="estimate-issue-fields">
|
||||
<legend><%= l(:label_estimate_issue_fields) %></legend>
|
||||
<p class="estimate-issue-fields-info"><em class="info"><%= l(:text_estimate_issue_fields_info) %></em></p>
|
||||
<% @field_set.fields.each do |field| %>
|
||||
<p class="estimate-issue-field"
|
||||
data-tracker-ids="<%= field.tracker_ids.join(',') %>"
|
||||
data-required-tracker-ids="<%= field.required_tracker_ids.join(',') %>">
|
||||
<label for="<%= custom_field_tag_id('issue', field.custom_field) %>">
|
||||
<%= custom_field_name_tag(field.custom_field) %>
|
||||
<span class="required estimate-field-required"<%= ' style="display:none"'.html_safe unless field.required_for_any? %>> *</span>
|
||||
</label>
|
||||
<%= custom_field_tag('issue', field.custom_value) %>
|
||||
</p>
|
||||
<% end %>
|
||||
</fieldset>
|
||||
<% end %>
|
||||
|
||||
<p class="estimate-issues-hint">
|
||||
<% if templates_enabled %>
|
||||
<%= l(:text_estimate_issues_template_hint) %>
|
||||
<% else %>
|
||||
<%= l(:text_estimate_issues_hint) %>
|
||||
<% end %>
|
||||
</p>
|
||||
|
||||
<p>
|
||||
<% if selectable_count > 0 %>
|
||||
<%= submit_tag l(:button_create_estimate_issues_submit), data: { disable_with: l(:label_loading) } %>
|
||||
<% end %>
|
||||
<%= link_to l(:button_cancel), @return_path %>
|
||||
</p>
|
||||
<% end %>
|
||||
|
||||
<%= javascript_tag do %>
|
||||
(function () {
|
||||
var form = document.getElementById('estimate-issues-form');
|
||||
if (!form) return;
|
||||
|
||||
// Select / deselect all lines
|
||||
var toggleAll = document.getElementById('estimate-issues-toggle-all');
|
||||
if (toggleAll) {
|
||||
toggleAll.addEventListener('change', function () {
|
||||
form.querySelectorAll('.estimate-line-select').forEach(function (box) { box.checked = toggleAll.checked; });
|
||||
});
|
||||
}
|
||||
|
||||
// Keep each template dropdown limited to templates for the chosen tracker
|
||||
var templates = [];
|
||||
try { templates = JSON.parse(form.dataset.templates || '[]'); } catch (e) { templates = []; }
|
||||
var noneLabel = <%= raw l(:label_no_issue_template).to_json %>;
|
||||
|
||||
function fillTemplates(templateSelect, trackerId, useDefault) {
|
||||
var current = templateSelect.value;
|
||||
var matches = templates.filter(function (t) { return String(t.tracker_id) === String(trackerId); });
|
||||
templateSelect.innerHTML = '';
|
||||
templateSelect.appendChild(new Option(noneLabel, ''));
|
||||
matches.forEach(function (t) {
|
||||
templateSelect.appendChild(new Option(t.title + (t.group === 'global' ? ' (global)' : ''), t.key));
|
||||
});
|
||||
var defaultTemplate = matches.find(function (t) { return t.is_default; });
|
||||
if (useDefault) {
|
||||
templateSelect.value = defaultTemplate ? defaultTemplate.key : '';
|
||||
} else if (matches.some(function (t) { return t.key === current; })) {
|
||||
templateSelect.value = current;
|
||||
}
|
||||
}
|
||||
|
||||
form.querySelectorAll('tr.estimate-line').forEach(function (row) {
|
||||
var tracker = row.querySelector('.estimate-line-tracker');
|
||||
var template = row.querySelector('.estimate-line-template');
|
||||
if (!tracker || !template) return;
|
||||
fillTemplates(template, tracker.value, false);
|
||||
tracker.addEventListener('change', function () { fillTemplates(template, tracker.value, true); });
|
||||
});
|
||||
|
||||
// Show only the custom fields used by the trackers of the selected lines, and star the required ones
|
||||
var fieldBox = document.getElementById('estimate-issue-fields');
|
||||
|
||||
function idList(value) {
|
||||
return (value || '').split(',').filter(function (v) { return v !== ''; });
|
||||
}
|
||||
|
||||
function updateFields() {
|
||||
if (!fieldBox) return;
|
||||
var trackerIds = [];
|
||||
form.querySelectorAll('tr.estimate-line').forEach(function (row) {
|
||||
var box = row.querySelector('.estimate-line-select');
|
||||
var tracker = row.querySelector('.estimate-line-tracker');
|
||||
if (box && tracker && box.checked && trackerIds.indexOf(tracker.value) < 0) trackerIds.push(tracker.value);
|
||||
});
|
||||
|
||||
var visibleCount = 0;
|
||||
fieldBox.querySelectorAll('.estimate-issue-field').forEach(function (field) {
|
||||
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';
|
||||
var star = field.querySelector('.estimate-field-required');
|
||||
if (star) star.style.display = required ? '' : 'none';
|
||||
if (used) visibleCount++;
|
||||
});
|
||||
fieldBox.style.display = visibleCount > 0 ? '' : 'none';
|
||||
}
|
||||
|
||||
form.querySelectorAll('.estimate-line-select, .estimate-line-tracker').forEach(function (el) {
|
||||
el.addEventListener('change', updateFields);
|
||||
});
|
||||
if (toggleAll) toggleAll.addEventListener('change', updateFields);
|
||||
updateFields();
|
||||
})();
|
||||
<% end %>
|
||||
<% end %>
|
||||
|
||||
<%# Inline so the page never depends on precompiled plugin assets %>
|
||||
<style>
|
||||
.estimate-preview-subtitle { font-weight: normal; font-size: 0.8em; color: #777; }
|
||||
table.estimate-issues-preview td.subject { text-align: left; }
|
||||
table.estimate-issues-preview td.subject input { width: 98%; }
|
||||
table.estimate-issues-preview tr.created td { color: #888; }
|
||||
.estimate-issues-hint { color: #777; font-size: 0.9em; }
|
||||
.estimate-issue-fields .estimate-issue-fields-info { padding-left: 0; }
|
||||
</style>
|
||||
@@ -0,0 +1,4 @@
|
||||
<% html_title l(:label_new_estimate) %>
|
||||
|
||||
<%= render partial: 'qbo_estimates/header', locals: { form: @form } %>
|
||||
<%= render partial: 'qbo_estimates/form', locals: { form: @form } %>
|
||||
@@ -0,0 +1,2 @@
|
||||
<%= link_to sprite_icon('document', l(:button_create_invoice)), new_qbo_invoice_path(customer_id: customer.id),
|
||||
class: 'icon icon-document' %>
|
||||
@@ -0,0 +1,5 @@
|
||||
<%# Invoices with a payment applied are read-only, so they get a View link instead of Edit %>
|
||||
<% paid = invoice.balance && invoice.total_amount && invoice.balance.to_d < invoice.total_amount.to_d %>
|
||||
<%= link_to sprite_icon(paid ? 'zoom-in' : 'edit', l(paid ? :button_view_invoice : :button_edit)), edit_qbo_invoice_path(invoice.id),
|
||||
class: "icon-only #{paid ? 'icon-zoom-in' : 'icon-edit'} qbo-estimate-edit-link",
|
||||
title: l(paid ? :button_view_invoice : :button_edit_invoice) %>
|
||||
@@ -0,0 +1,19 @@
|
||||
<% html_title "#{l(:label_invoice)} ##{@form.doc_number}" %>
|
||||
|
||||
<div class="contextual">
|
||||
<% 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 %>
|
||||
<%= 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),
|
||||
method: :post, class: 'icon icon-email',
|
||||
data: { confirm: l(:text_email_invoice_confirmation, number: @form.doc_number, email: @form.email) } %>
|
||||
<% end %>
|
||||
<%= link_to sprite_icon('link', l(:button_open_in_quickbooks)),
|
||||
"https://#{RedmineQbo.sandbox_mode? ? 'sandbox' : 'app'}.qbo.intuit.com/app/invoice?txnId=#{@form.id}",
|
||||
class: 'icon icon-link', target: :_blank, rel: 'noopener' %>
|
||||
</div>
|
||||
|
||||
<%= render partial: 'qbo_estimates/header', locals: { form: @form } %>
|
||||
<%= render partial: 'qbo_estimates/form', locals: { form: @form } %>
|
||||
@@ -0,0 +1,4 @@
|
||||
<% html_title l(:label_new_invoice) %>
|
||||
|
||||
<%= render partial: 'qbo_estimates/header', locals: { form: @form } %>
|
||||
<%= render partial: 'qbo_estimates/form', locals: { form: @form } %>
|
||||
@@ -0,0 +1,82 @@
|
||||
<% html_title @customer.name, l(:label_payments) %>
|
||||
|
||||
<div class="contextual">
|
||||
<% 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 %>
|
||||
<%= link_to sprite_icon('link', l(:button_open_in_quickbooks)),
|
||||
"https://#{RedmineQbo.sandbox_mode? ? 'sandbox' : 'app'}.qbo.intuit.com/app/customerdetail?nameId=#{@customer.id}",
|
||||
class: 'icon icon-link', target: :_blank, rel: 'noopener' %>
|
||||
</div>
|
||||
|
||||
<h2>
|
||||
<%= link_to l(:label_customers), customers_path %> »
|
||||
<%= link_to @customer.name, customer_path(@customer) %> »
|
||||
<%= l(:label_payments) %>
|
||||
</h2>
|
||||
|
||||
<% if @payments.empty? %>
|
||||
<p class="nodata"><%= l(:label_no_payments) %></p>
|
||||
<% else %>
|
||||
<div class="autoscroll">
|
||||
<table class="list qbo-payments">
|
||||
<thead>
|
||||
<tr>
|
||||
<th><%= l(:label_payment_date) %></th>
|
||||
<th><%= l(:label_payment_method) %></th>
|
||||
<th><%= l(:label_payment_reference) %></th>
|
||||
<th class="applied"><%= l(:label_payment_applies_to) %></th>
|
||||
<th class="memo"><%= l(:label_memo) %></th>
|
||||
<th class="amount"><%= l(:label_amount) %></th>
|
||||
<th class="amount"><%= l(:label_payment_unapplied) %></th>
|
||||
<th></th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<% @payments.each do |payment| %>
|
||||
<% applied = RedmineQboBilling::PaymentWriter.applied_invoices(payment) %>
|
||||
<% unapplied = BigDecimal(payment.unapplied_amount.to_s.presence || '0') %>
|
||||
<tr>
|
||||
<td class="date"><%= link_to format_date(payment.txn_date), qbo_payment_path(payment.id) %></td>
|
||||
<td><%= RedmineQboBilling::PaymentWriter.payment_method_name(payment) %></td>
|
||||
<td><%= payment.payment_ref_number %></td>
|
||||
<td class="applied">
|
||||
<% if applied.empty? %>
|
||||
<em><%= l(:label_payment_deposit) %></em>
|
||||
<% else %>
|
||||
<% applied.each do |invoice_id, number, amount| %>
|
||||
<div>
|
||||
<%= link_to "##{number}", RedmineQboBilling.invoice_writer? ? edit_qbo_invoice_path(invoice_id) : invoice_path(invoice_id) %>
|
||||
<%= number_to_currency(amount) %>
|
||||
</div>
|
||||
<% end %>
|
||||
<% end %>
|
||||
</td>
|
||||
<td class="memo"><%= truncate(payment.private_note.to_s, length: 60) %></td>
|
||||
<td class="amount"><%= number_to_currency(payment.total) %></td>
|
||||
<td class="amount"><%= unapplied > 0 ? number_to_currency(unapplied) : '' %></td>
|
||||
<td class="buttons">
|
||||
<%= link_to sprite_icon('application-pdf', l(:button_print_payment)), pdf_qbo_payment_path(payment.id),
|
||||
class: 'icon icon-pdf', target: :_blank %>
|
||||
</td>
|
||||
</tr>
|
||||
<% end %>
|
||||
</tbody>
|
||||
<tfoot>
|
||||
<tr class="total">
|
||||
<td colspan="5"><strong><%= l(:label_payment_totals) %></strong> (<%= @payments.size %>)</td>
|
||||
<td class="amount"><strong><%= number_to_currency(@totals[:received]) %></strong></td>
|
||||
<td class="amount"><strong><%= @totals[:unapplied] > 0 ? number_to_currency(@totals[:unapplied]) : '' %></strong></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tfoot>
|
||||
</table>
|
||||
</div>
|
||||
<% end %>
|
||||
|
||||
<style>
|
||||
table.qbo-payments td { vertical-align: top; }
|
||||
table.qbo-payments .applied, table.qbo-payments .memo { text-align: left; }
|
||||
table.qbo-payments .amount { text-align: right; white-space: nowrap; }
|
||||
table.qbo-payments tfoot td { border-top: 2px solid #ccc; }
|
||||
</style>
|
||||
@@ -0,0 +1,187 @@
|
||||
<% html_title l(:button_receive_payment) %>
|
||||
<% customer = Customer.find_by(id: @form.customer_id) if @form.customer_id.present? %>
|
||||
|
||||
<h2>
|
||||
<%= link_to l(:label_customers), customers_path %> »
|
||||
<% if customer %><%= link_to customer.name, customer_path(customer) %> »<% end %>
|
||||
<%= l(:button_receive_payment) %>
|
||||
</h2>
|
||||
|
||||
<%= error_messages_for @form %>
|
||||
|
||||
<%= form_tag qbo_payments_path, id: 'qbo-payment-form',
|
||||
data: { open_invoices_url: open_invoices_qbo_payments_path, none_text: l(:label_no_open_invoices) } do %>
|
||||
<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' } %>
|
||||
<%= hidden_field_tag 'payment[customer_id]', @form.customer_id, id: 'customer_id' %>
|
||||
</p>
|
||||
<p>
|
||||
<label for="qbo_payment_txn_date"><%= l(:label_payment_date) %><span class="required"> *</span></label>
|
||||
<%= date_field_tag 'payment[txn_date]', @form.txn_date, id: 'qbo_payment_txn_date' %>
|
||||
</p>
|
||||
<p>
|
||||
<label for="qbo_payment_method"><%= l(:label_payment_method) %><span class="required"> *</span></label>
|
||||
<%= select_tag 'payment[payment_method_id]', options_for_select(@payment_methods, @form.payment_method_id),
|
||||
include_blank: true, id: 'qbo_payment_method' %>
|
||||
<% if @payment_methods.empty? %>
|
||||
<em class="info"><%= l(:text_no_payment_methods) %></em>
|
||||
<% end %>
|
||||
</p>
|
||||
<p>
|
||||
<label for="qbo_payment_reference"><%= l(:label_payment_reference) %></label>
|
||||
<%= text_field_tag 'payment[reference]', @form.reference, id: 'qbo_payment_reference', size: 20, maxlength: 21 %>
|
||||
<em class="info"><%= l(:text_payment_reference) %></em>
|
||||
</p>
|
||||
<p>
|
||||
<label for="qbo_payment_amount"><%= l(:label_amount) %><span class="required"> *</span></label>
|
||||
<%= text_field_tag 'payment[amount]', @form.amount, id: 'qbo_payment_amount', size: 12, inputmode: 'decimal', autocomplete: 'off' %>
|
||||
</p>
|
||||
<p>
|
||||
<label for="qbo_payment_deposit"><%= l(:label_payment_deposit) %></label>
|
||||
<%= hidden_field_tag 'payment[deposit]', '0', id: nil %>
|
||||
<%= check_box_tag 'payment[deposit]', '1', @form.deposit?, id: 'qbo_payment_deposit' %>
|
||||
<em class="info"><%= l(:text_payment_deposit) %></em>
|
||||
</p>
|
||||
<p>
|
||||
<label for="qbo_payment_memo"><%= l(:label_memo) %></label>
|
||||
<%= text_area_tag 'payment[memo]', @form.memo, id: 'qbo_payment_memo', rows: 3, cols: 60, maxlength: 4000 %>
|
||||
</p>
|
||||
</div>
|
||||
|
||||
<%# How the amount will be applied: the customer's open invoices, oldest first (worked out again when saving) %>
|
||||
<fieldset class="box" id="qbo-payment-invoices">
|
||||
<legend><%= l(:label_payment_applies_to) %></legend>
|
||||
<p><em class="info"><%= l(:text_payment_pick_invoices) %></em></p>
|
||||
<table class="list qbo-payment-invoices">
|
||||
<thead>
|
||||
<tr>
|
||||
<th class="checkbox"><input type="checkbox" id="qbo-payment-all" aria-label="<%= l(:button_check_all) %>"></th>
|
||||
<th><%= l(:label_invoice) %></th>
|
||||
<th><%= l(:label_date) %></th>
|
||||
<th><%= l(:label_due_date) %></th>
|
||||
<th class="qbo-num"><%= l(:label_estimate_total) %></th>
|
||||
<th class="qbo-num"><%= l(:label_open_balance) %></th>
|
||||
<th class="qbo-num"><%= l(:label_payment_applied) %></th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody id="qbo-payment-invoice-rows">
|
||||
<% @open_invoices.each do |invoice| %>
|
||||
<tr data-balance="<%= invoice[:balance] %>">
|
||||
<td class="checkbox"><%= check_box_tag 'payment[invoice_ids][]', invoice[:id], @form.invoice_ids.include?(invoice[:id]), id: nil, class: 'qbo-payment-pick' %></td>
|
||||
<td>#<%= invoice[:doc_number] %></td>
|
||||
<td><%= invoice[:date] %></td>
|
||||
<td><%= invoice[:due_date] %></td>
|
||||
<td class="qbo-num"><%= number_to_currency(invoice[:total]) %></td>
|
||||
<td class="qbo-num"><%= number_to_currency(invoice[:balance]) %></td>
|
||||
<td class="qbo-num qbo-payment-applied"></td>
|
||||
</tr>
|
||||
<% end %>
|
||||
<% if @open_invoices.empty? %>
|
||||
<tr class="qbo-payment-none"><td colspan="7"><%= l(:label_no_open_invoices) %></td></tr>
|
||||
<% end %>
|
||||
</tbody>
|
||||
<tfoot>
|
||||
<tr>
|
||||
<th colspan="6" class="qbo-num"><%= l(:label_payment_unapplied) %></th>
|
||||
<th class="qbo-num" id="qbo-payment-unapplied"></th>
|
||||
</tr>
|
||||
</tfoot>
|
||||
</table>
|
||||
</fieldset>
|
||||
|
||||
<p>
|
||||
<%= submit_tag l(:button_save_payment) %>
|
||||
<%= link_to l(:button_cancel), customer ? customer_path(customer) : home_path %>
|
||||
</p>
|
||||
<% end %>
|
||||
|
||||
<style>
|
||||
table.qbo-payment-invoices { width: auto; min-width: 60%; }
|
||||
table.qbo-payment-invoices .qbo-num { text-align: right; font-variant-numeric: tabular-nums; white-space: nowrap; }
|
||||
table.qbo-payment-invoices td.qbo-payment-applied { font-weight: 600; }
|
||||
#qbo-payment-form.qbo-deposit table.qbo-payment-invoices td.qbo-payment-applied { color: #999; font-weight: normal; }
|
||||
</style>
|
||||
|
||||
<%= javascript_tag do %>
|
||||
$(function () {
|
||||
var $form = $('#qbo-payment-form');
|
||||
if (!$form.length) return;
|
||||
var money = new Intl.NumberFormat(<%= raw (current_language.to_s.presence || 'en').to_json %>, { style: 'currency', currency: 'USD' });
|
||||
var $rows = $('#qbo-payment-invoice-rows');
|
||||
|
||||
function amount() {
|
||||
var n = Number(String($('#qbo_payment_amount').val() || '').replace(/[$,\s]/g, ''));
|
||||
return isFinite(n) && n > 0 ? n : 0;
|
||||
}
|
||||
|
||||
function picked() { return $rows.find('.qbo-payment-pick:checked'); }
|
||||
|
||||
// Oldest first, like QuickBooks: on the ticked invoices if any are ticked, otherwise on all of them.
|
||||
// A deposit applies to nothing.
|
||||
function recalc() {
|
||||
var deposit = $('#qbo_payment_deposit').is(':checked');
|
||||
$form.toggleClass('qbo-deposit', deposit);
|
||||
var left = deposit ? 0 : Math.round(amount() * 100);
|
||||
var onlyPicked = picked().length > 0;
|
||||
$rows.children('tr[data-balance]').each(function () {
|
||||
var balance = Math.round(parseFloat($(this).data('balance')) * 100);
|
||||
var counts = !onlyPicked || $(this).find('.qbo-payment-pick').is(':checked');
|
||||
var take = counts ? Math.min(left, balance) : 0;
|
||||
left -= take;
|
||||
$(this).find('.qbo-payment-applied').text(take > 0 ? money.format(take / 100) : '');
|
||||
});
|
||||
var unapplied = deposit ? amount() : left / 100;
|
||||
$('#qbo-payment-unapplied').text(money.format(unapplied));
|
||||
}
|
||||
|
||||
function loadInvoices(customerId) {
|
||||
$rows.empty();
|
||||
if (!customerId) { recalc(); return; }
|
||||
$.getJSON($form.data('openInvoicesUrl'), { customer_id: customerId }).done(function (invoices) {
|
||||
(invoices || []).forEach(function (invoice) {
|
||||
$('<tr>').attr('data-balance', invoice.balance).append(
|
||||
$('<td class="checkbox">').append($('<input type="checkbox" name="payment[invoice_ids][]" class="qbo-payment-pick">').val(invoice.id)),
|
||||
$('<td>').text('#' + invoice.doc_number), $('<td>').text(invoice.date), $('<td>').text(invoice.due_date),
|
||||
$('<td class="qbo-num">').text(money.format(parseFloat(invoice.total || 0))),
|
||||
$('<td class="qbo-num">').text(money.format(parseFloat(invoice.balance))),
|
||||
$('<td class="qbo-num qbo-payment-applied">')
|
||||
).appendTo($rows);
|
||||
});
|
||||
if (!$rows.children().length) {
|
||||
$('<tr class="qbo-payment-none">').append($('<td colspan="7">').text($form.data('noneText'))).appendTo($rows);
|
||||
}
|
||||
recalc();
|
||||
});
|
||||
}
|
||||
|
||||
$('#customer_id').on('change', function () { loadInvoices(this.value); });
|
||||
$('#qbo_payment_customer_name').on('input', function () { if (!this.value.trim()) $('#customer_id').val(''); });
|
||||
// Ticking invoices fills in the amount: the total of their open balances
|
||||
function fillAmount() {
|
||||
var cents = 0;
|
||||
picked().each(function () { cents += Math.round(parseFloat($(this).closest('tr').data('balance')) * 100); });
|
||||
if (picked().length) {
|
||||
$('#qbo_payment_amount').val((cents / 100).toFixed(2));
|
||||
$('#qbo_payment_deposit').prop('checked', false);
|
||||
}
|
||||
var $all = $('#qbo-payment-all');
|
||||
var boxes = $rows.find('.qbo-payment-pick');
|
||||
$all.prop('checked', boxes.length > 0 && picked().length === boxes.length);
|
||||
recalc();
|
||||
}
|
||||
$rows.on('change', '.qbo-payment-pick', fillAmount);
|
||||
$('#qbo-payment-all').on('change', function () {
|
||||
$rows.find('.qbo-payment-pick').prop('checked', this.checked);
|
||||
if (!this.checked) $('#qbo_payment_amount').val('');
|
||||
fillAmount();
|
||||
});
|
||||
$('#qbo_payment_amount').on('input', recalc);
|
||||
$('#qbo_payment_deposit').on('change', recalc);
|
||||
$form.on('keydown', 'input[type=text]', function (e) { if (e.key === 'Enter' && $(this).hasClass('customer-name')) e.preventDefault(); });
|
||||
recalc();
|
||||
});
|
||||
<% end %>
|
||||
@@ -0,0 +1,58 @@
|
||||
<% html_title l(:label_payment) %>
|
||||
<% method_name = RedmineQboBilling::PaymentWriter.payment_method_name(@payment) %>
|
||||
|
||||
<div class="contextual">
|
||||
<%= 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' %>
|
||||
<% end %>
|
||||
<%= link_to sprite_icon('link', l(:button_open_in_quickbooks)),
|
||||
"https://#{RedmineQbo.sandbox_mode? ? 'sandbox' : 'app'}.qbo.intuit.com/app/recvpayment?txnId=#{@payment.id}",
|
||||
class: 'icon icon-link', target: :_blank, rel: 'noopener' %>
|
||||
</div>
|
||||
|
||||
<h2>
|
||||
<%= link_to l(:label_customers), customers_path %> »
|
||||
<% if @customer %><%= link_to @customer.name, customer_path(@customer) %> »
|
||||
<%= link_to l(:label_payments), qbo_payments_path(customer_id: @customer.id) %> »<% end %>
|
||||
<%= l(:label_payment) %> <%= number_to_currency(@payment.total) %>
|
||||
</h2>
|
||||
|
||||
<div class="issue details">
|
||||
<div class="attributes">
|
||||
<div class="splitcontent">
|
||||
<div class="splitcontentleft">
|
||||
<div class="attribute"><div class="label"><%= l(:label_payment_date) %>:</div><div class="value"><%= format_date(@payment.txn_date) %></div></div>
|
||||
<div class="attribute"><div class="label"><%= l(:label_payment_method) %>:</div><div class="value"><%= method_name %></div></div>
|
||||
<div class="attribute"><div class="label"><%= l(:label_payment_reference) %>:</div><div class="value"><%= @payment.payment_ref_number %></div></div>
|
||||
</div>
|
||||
<div class="splitcontentright">
|
||||
<div class="attribute"><div class="label"><%= l(:label_amount) %>:</div><div class="value"><%= number_to_currency(@payment.total) %></div></div>
|
||||
<div class="attribute"><div class="label"><%= l(:label_payment_unapplied) %>:</div><div class="value"><%= number_to_currency(@payment.unapplied_amount || 0) %></div></div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<% if @payment.private_note.present? %>
|
||||
<hr />
|
||||
<p><strong><%= l(:label_memo) %></strong></p>
|
||||
<p><%= @payment.private_note %></p>
|
||||
<% end %>
|
||||
</div>
|
||||
|
||||
<h3><%= l(:label_payment_applies_to) %></h3>
|
||||
<% applied = RedmineQboBilling::PaymentWriter.applied_invoices(@payment) %>
|
||||
<% if applied.empty? %>
|
||||
<p class="nodata"><%= l(:text_payment_unapplied_deposit) %></p>
|
||||
<% else %>
|
||||
<table class="list">
|
||||
<thead><tr><th><%= l(:label_invoice) %></th><th><%= l(:label_payment_applied) %></th></tr></thead>
|
||||
<tbody>
|
||||
<% applied.each do |invoice_id, number, amount| %>
|
||||
<tr>
|
||||
<td><%= link_to "##{number}", RedmineQboBilling.invoice_writer? ? edit_qbo_invoice_path(invoice_id) : invoice_path(invoice_id) %></td>
|
||||
<td><%= number_to_currency(amount) %></td>
|
||||
</tr>
|
||||
<% end %>
|
||||
</tbody>
|
||||
</table>
|
||||
<% end %>
|
||||
+206
-2
@@ -11,6 +11,9 @@
|
||||
# English strings go here for Rails i18n
|
||||
# Usage I18n.t(:label)
|
||||
en:
|
||||
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"
|
||||
button_bulk_pdf: "Bulk PDF"
|
||||
customer_details: "Customer Details"
|
||||
field_billed: "Billed"
|
||||
@@ -34,7 +37,6 @@ en:
|
||||
label_closed_issues: "Closed Issues"
|
||||
label_connected: "Successfully connected to QuickBooks"
|
||||
label_create_estimate: "Create Estimate"
|
||||
label_create_payment: "Create Payment"
|
||||
label_customer_count: "Customer Count"
|
||||
label_customer_link_expires: "This customer link expires in"
|
||||
label_customer: "Customer"
|
||||
@@ -65,6 +67,7 @@ en:
|
||||
label_model: "Model"
|
||||
label_name: "Name"
|
||||
label_new_customer: "New Customer"
|
||||
label_new_issue: "New Issue"
|
||||
label_qbo_never_synced: "Never Synced"
|
||||
label_no_customers: "There are no customers matching the search term(s)."
|
||||
label_no_estimates: "No Estimates"
|
||||
@@ -113,4 +116,205 @@ en:
|
||||
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?"
|
||||
warn_ru_sure: "Are you sure?"
|
||||
|
||||
# ---- Billing: estimates, invoices, payments, items and accounts ----
|
||||
label_billing_settings: "Billing"
|
||||
# Permissions
|
||||
permission_write_estimates: "Write estimates"
|
||||
permission_send_estimates: "Email estimates"
|
||||
permission_write_invoices: "Write invoices"
|
||||
permission_send_invoices: "Email invoices"
|
||||
permission_create_estimate_issues: "Create issues from estimates"
|
||||
permission_receive_payments: "Receive payments"
|
||||
|
||||
button_add_lines: "Add lines"
|
||||
button_add_subtotal: "Add subtotal"
|
||||
button_clear_all_lines: "Clear all lines"
|
||||
button_duplicate: "Duplicate"
|
||||
button_edit_estimate: "Edit estimate"
|
||||
button_view_estimate: "View estimate"
|
||||
button_email_estimate: "Email"
|
||||
button_open_in_quickbooks: "Open in QuickBooks"
|
||||
button_refresh_quickbooks_fields: "Refresh QuickBooks fields"
|
||||
button_reload_estimate: "Reload the estimate"
|
||||
button_save_and_send: "Save and send"
|
||||
|
||||
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"
|
||||
error_estimate_linked_to_issues: "This estimate is linked to these issues, so it can't be changed here. Duplicate it to make a new estimate:"
|
||||
error_estimate_has_bundles: "This estimate has bundles, which can only be edited in QuickBooks."
|
||||
error_estimate_line_description: "Line %{line} needs a description, a product or service, or a rate"
|
||||
error_estimate_line_number: "Line %{line} has a quantity or rate that isn't a number"
|
||||
error_estimate_line_unmatched_item: "Line %{line}: pick \"%{name}\" from the product/service list"
|
||||
error_estimate_needs_a_line: "Add at least one line"
|
||||
error_estimate_needs_customer: "Choose a customer"
|
||||
error_estimate_not_saved: "QuickBooks didn't save the estimate"
|
||||
error_estimate_not_sent: "QuickBooks didn't send the estimate"
|
||||
error_estimate_saved_not_sent: "It was saved but not sent: %{message}"
|
||||
|
||||
label_choose_a_customer: "Choose a customer"
|
||||
label_customer_email: "Customer email"
|
||||
label_discount_from_quickbooks: "Discount"
|
||||
label_drag_to_reorder: "Drag to reorder"
|
||||
label_estimate_date: "Estimate date"
|
||||
label_estimate_expiration_days: "Estimates expire after (days)"
|
||||
label_estimate_no: "Estimate no."
|
||||
label_estimate_pdf: "PDF"
|
||||
label_estimate_sent: "Sent"
|
||||
label_estimate_total: "Total"
|
||||
label_expiration_date: "Expiration date"
|
||||
label_memo: "Memo"
|
||||
label_message_on_estimate: "Message displayed on estimate"
|
||||
label_new_estimate: "New estimate"
|
||||
label_product_service: "Product/service"
|
||||
label_qty: "Qty"
|
||||
label_rate: "Rate"
|
||||
label_sales_person: "Sales person"
|
||||
label_sales_tax: "Sales tax"
|
||||
label_subtotal: "Subtotal"
|
||||
label_tax: "Tax"
|
||||
label_taxable_subtotal: "Taxable subtotal"
|
||||
label_vin: "VIN"
|
||||
|
||||
notice_estimate_saved_and_sent: "Estimate #%{number} saved in QuickBooks and emailed to %{email}"
|
||||
notice_estimate_saved_in_quickbooks: "Estimate #%{number} saved in QuickBooks"
|
||||
notice_estimate_sent: "Estimate #%{number} emailed to %{email}"
|
||||
notice_estimate_settings_refreshed: "QuickBooks custom fields and estimate settings were read again"
|
||||
|
||||
text_assigned_by_quickbooks: "Assigned when saved"
|
||||
text_clear_all_lines_confirmation: "Clear all lines?"
|
||||
text_email_estimate_confirmation: "Email estimate #%{number} to %{email}?"
|
||||
text_estimate_duplicated_from: "Copied from estimate #%{number}. It's saved as a new estimate."
|
||||
text_estimate_closed: "This estimate is closed (it was turned into an invoice). Changes here won't change the invoice."
|
||||
text_estimate_expiration_days: "New estimates get an expiration date this many days after the estimate date, e.g. 30. Leave blank for no expiration date."
|
||||
text_estimate_reload: "Reloading shows the latest version from QuickBooks; changes made on this page will be lost."
|
||||
text_estimate_send_needs_email: "Enter the customer's email to send it."
|
||||
text_memo_is_private: "Internal, not shown to the customer"
|
||||
text_no_sales_person_field: "QuickBooks isn't sharing a text custom field named Sales Person, so this isn't saved."
|
||||
text_no_vin_field: "QuickBooks isn't sharing a text custom field named VIN."
|
||||
text_quickbooks_custom_fields_found: "Custom fields QuickBooks shares with apps: %{fields}. QuickBooks only shares its first three text fields; a field it doesn't list in its settings shows up here once it's filled in on an estimate."
|
||||
text_quickbooks_settings_unavailable: "QuickBooks' estimate settings couldn't be read, so custom fields and the default message are missing. Check the QuickBooks connection."
|
||||
text_separate_emails_with_comma: "Separate emails with a comma"
|
||||
text_tax_calculated_by_quickbooks: "Calculated by QuickBooks when saved"
|
||||
|
||||
# QuickBooks product/service list and income accounts
|
||||
field_classification: "Classification"
|
||||
field_sku: "SKU"
|
||||
field_taxable: "Taxable"
|
||||
field_unit_price: "Unit Price"
|
||||
label_active: "Active"
|
||||
label_account: "Account"
|
||||
label_accounts: "Accounts"
|
||||
label_account_count: "Number of Accounts:"
|
||||
label_back: "Back"
|
||||
label_default_account: "Default Item Income Account"
|
||||
label_description: "Description"
|
||||
label_edit_item: "Edit Item"
|
||||
label_item: "Item"
|
||||
label_item_count: "Item Count:"
|
||||
label_item_new: "New Item"
|
||||
label_items: "Items"
|
||||
label_management_and_sync: "Management & Synchronization"
|
||||
label_never_synced: "Never synced"
|
||||
label_no: "No"
|
||||
label_sync_now_accounts: "Sync Accounts"
|
||||
label_sync_now_items: "Sync Items"
|
||||
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."
|
||||
|
||||
# Invoices
|
||||
button_add_to_invoice: "Add to invoice"
|
||||
button_create_invoice: "Create invoice"
|
||||
button_edit_invoice: "Edit invoice"
|
||||
button_import_time_estimates: "Import time & estimates"
|
||||
button_undo_import: "Undo import"
|
||||
button_view_invoice: "View invoice"
|
||||
error_estimate_already_invoiced: "Estimate #%{number} is already billed on invoice #%{invoice}."
|
||||
error_estimate_closed_billed: "Estimate #%{number} is already billed (%{status})."
|
||||
error_estimate_rejected: "Estimate #%{number} was rejected, so it can't be billed."
|
||||
text_estimate_billed_on: "This estimate is billed on:"
|
||||
error_invoice_changed_in_quickbooks: "This invoice was changed in QuickBooks after you opened it, so it wasn't saved."
|
||||
error_invoice_has_bundles: "This invoice has bundles, which can only be edited in QuickBooks."
|
||||
error_invoice_not_saved: "QuickBooks didn't save the invoice"
|
||||
error_invoice_not_sent: "QuickBooks didn't send the invoice"
|
||||
error_invoice_paid: "A payment has been applied to this invoice, so it can't be changed here."
|
||||
label_billable_time: "Billable time"
|
||||
label_due_date: "Due date"
|
||||
label_invoice: "Invoice"
|
||||
label_invoice_balance: "Balance due %{balance}"
|
||||
label_invoice_date: "Invoice date"
|
||||
label_invoice_no: "Invoice no."
|
||||
label_invoice_paid: "Paid"
|
||||
label_invoice_partially_paid: "Partially paid"
|
||||
label_message_on_invoice: "Message displayed on invoice"
|
||||
label_new_invoice: "New invoice"
|
||||
label_open_estimates: "Open estimates"
|
||||
label_replace_lines: "Replace these lines"
|
||||
label_replaceable_items: "Replaced by imported time"
|
||||
label_time_badge: "Time"
|
||||
notice_invoice_saved_and_sent: "Invoice #%{number} saved in QuickBooks and emailed to %{email}"
|
||||
notice_invoice_saved_in_quickbooks: "Invoice #%{number} saved in QuickBooks"
|
||||
notice_invoice_sent: "Invoice #%{number} emailed to %{email}"
|
||||
text_email_invoice_confirmation: "Email invoice #%{number} to %{email}?"
|
||||
text_invoice_from_estimate: "Made from estimate #%{number}. The estimate is closed when the invoice is saved."
|
||||
text_invoice_many_vehicles: "These work orders are for more than one vehicle:"
|
||||
text_line_bills_time: "Bills a QuickBooks time activity; saving marks the time as billed"
|
||||
text_replaceable_items: "Products/services that billable time can replace on invoices, e.g. Labor. Only invoice lines with these are offered under Replace these lines when time is imported. Leave empty to offer every line. Ctrl/Cmd-click to pick several."
|
||||
text_replace_lines: "Tick the lines the time replaces (e.g. the estimate's labor lines). The time goes where the first ticked line is."
|
||||
|
||||
# Issues from estimates (moved from redmine_qbo_calendar)
|
||||
button_create_estimate_issues_submit: "Create issues"
|
||||
button_create_estimate_issues: "Create issues"
|
||||
error_estimate_lines_already_created: "Some of these estimate lines were just turned into issues by someone else. Please review and try again."
|
||||
error_no_estimate_lines_selected: "Select at least one estimate line"
|
||||
error_no_labor_lines_found: "No lines with a description and a matching item code were found on the estimate"
|
||||
label_default_project: "Default project"
|
||||
label_default_tracker: "Default tracker"
|
||||
label_estimate_issue_fields: "Issue fields"
|
||||
label_estimate_issue_settings: "Issues from estimates"
|
||||
label_estimate_item: "Item"
|
||||
label_estimate_item_codes: "Estimate item codes"
|
||||
label_estimate_line_already_created: "Already created"
|
||||
label_issue_template: "Template"
|
||||
label_no_issue_template: "(no template)"
|
||||
notice_estimate_issues_created:
|
||||
one: "1 issue created from the estimate"
|
||||
other: "%{count} issues created from the estimate"
|
||||
text_default_project_info: "Where issues from estimates are created when nothing else picks a project (e.g. an appointment's project). It can still be changed on the page."
|
||||
text_default_tracker_info: "Pre-selected for each proposed issue. Leave blank to use the project's first tracker."
|
||||
text_estimate_issue_fields_info: "Entered once and applied to every created issue whose tracker uses the field. Fields marked * are required by the selected trackers."
|
||||
text_estimate_issues_hint: "The subject comes from the estimate line's description and estimated hours from its quantity. Edit anything before creating. New issues are related to each other and to issues already created from this estimate."
|
||||
text_estimate_issues_template_hint: "The subject comes from the estimate line's description and estimated hours from its quantity. A template supplies the issue's description. New issues are related to each other and to issues already created from this estimate."
|
||||
text_estimate_item_codes_info: "QBO item names that can become issues, one per line (e.g. Labor, Alignments). Matches the full item name or any part of a Category:Item name, ignoring case. Their quantities are also an estimate's labor hours (an appointment's hours can't be less)."
|
||||
|
||||
# Payments
|
||||
button_print_payment: "Print"
|
||||
button_receive_payment: "Receive payment"
|
||||
button_save_payment: "Save payment"
|
||||
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"
|
||||
label_no_open_invoices: "No open invoices: the payment is kept as a credit"
|
||||
label_open_balance: "Open balance"
|
||||
label_payment: "Payment"
|
||||
label_payment_applied: "Payment"
|
||||
label_payment_applies_to: "Applied to"
|
||||
label_payment_date: "Payment date"
|
||||
label_payment_deposit: "Deposit"
|
||||
label_payment_method: "Payment method"
|
||||
label_payment_reference: "Reference no."
|
||||
label_payment_unapplied: "Unapplied (credit)"
|
||||
label_payments: "Payments"
|
||||
label_no_payments: "No payments from this customer in QuickBooks"
|
||||
label_payment_totals: "Total"
|
||||
permission_view_payments: "View payments"
|
||||
notice_payment_not_found: "Payment not found in QuickBooks"
|
||||
notice_payment_saved: "Payment of %{amount} saved in QuickBooks"
|
||||
text_no_payment_methods: "QuickBooks' payment methods couldn't be read. Check the QuickBooks connection."
|
||||
text_payment_deposit: "Keep it as a credit on the customer's account instead of paying open invoices"
|
||||
text_payment_pick_invoices: "Tick invoices to fill in the amount and pay just those. With none ticked, the payment goes on the oldest invoices first."
|
||||
text_payment_reference: "e.g. the check number"
|
||||
text_payment_unapplied_deposit: "Not applied to any invoice: it's a credit on the customer's account."
|
||||
+52
-2
@@ -27,7 +27,7 @@ get 'estimates/doc/', to: 'estimates#doc', as: :estimate_doc
|
||||
get 'invoices/:id', to: 'invoices#show', as: :invoice
|
||||
|
||||
#manual billing
|
||||
get 'bill/:id', to: 'qbo#bill', as: :bill
|
||||
post 'bill/:id', to: 'qbo#bill', as: :bill
|
||||
|
||||
#customer issue view
|
||||
get 'customers/view/:token', to: 'customers#view', as: :view
|
||||
@@ -42,4 +42,54 @@ resources :customers do
|
||||
get :autocomplete
|
||||
get :sync
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
# Estimate writer pages. Kept under /qbo_estimates so they don't clash with redmine_qbo's /estimates/:id PDF route.
|
||||
resources :qbo_estimates, only: [:new, :create, :edit, :update] do
|
||||
member do
|
||||
post :send_email
|
||||
get :issues_preview
|
||||
post :create_issues
|
||||
end
|
||||
collection do
|
||||
get :customer_info
|
||||
get :items
|
||||
post :refresh_company
|
||||
end
|
||||
end
|
||||
|
||||
# Invoice writer pages (redmine_qbo has /invoices/:id for the PDF)
|
||||
resources :qbo_invoices, only: [:new, :create, :edit, :update] do
|
||||
member do
|
||||
post :send_email
|
||||
end
|
||||
collection do
|
||||
get :import_options
|
||||
end
|
||||
end
|
||||
|
||||
# Receive payment pages, and a customer's payments (/qbo_payments?customer_id=)
|
||||
resources :qbo_payments, only: [:index, :new, :create, :show] do
|
||||
member do
|
||||
get :pdf
|
||||
end
|
||||
collection do
|
||||
get :open_invoices
|
||||
end
|
||||
end
|
||||
|
||||
# QuickBooks product/service list (moved from redmine_qbo_lineitems; same URLs)
|
||||
resources :items do
|
||||
collection do
|
||||
get :autocomplete
|
||||
get :sync
|
||||
end
|
||||
end
|
||||
|
||||
# QuickBooks income accounts
|
||||
resources :accounts do
|
||||
collection do
|
||||
patch :set_default
|
||||
get :sync
|
||||
end
|
||||
end
|
||||
@@ -0,0 +1,201 @@
|
||||
Apache License
|
||||
Version 2.0, January 2004
|
||||
http://www.apache.org/licenses/
|
||||
|
||||
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
||||
|
||||
1. Definitions.
|
||||
|
||||
"License" shall mean the terms and conditions for use, reproduction,
|
||||
and distribution as defined by Sections 1 through 9 of this document.
|
||||
|
||||
"Licensor" shall mean the copyright owner or entity authorized by
|
||||
the copyright owner that is granting the License.
|
||||
|
||||
"Legal Entity" shall mean the union of the acting entity and all
|
||||
other entities that control, are controlled by, or are under common
|
||||
control with that entity. For the purposes of this definition,
|
||||
"control" means (i) the power, direct or indirect, to cause the
|
||||
direction or management of such entity, whether by contract or
|
||||
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
||||
outstanding shares, or (iii) beneficial ownership of such entity.
|
||||
|
||||
"You" (or "Your") shall mean an individual or Legal Entity
|
||||
exercising permissions granted by this License.
|
||||
|
||||
"Source" form shall mean the preferred form for making modifications,
|
||||
including but not limited to software source code, documentation
|
||||
source, and configuration files.
|
||||
|
||||
"Object" form shall mean any form resulting from mechanical
|
||||
transformation or translation of a Source form, including but
|
||||
not limited to compiled object code, generated documentation,
|
||||
and conversions to other media types.
|
||||
|
||||
"Work" shall mean the work of authorship, whether in Source or
|
||||
Object form, made available under the License, as indicated by a
|
||||
copyright notice that is included in or attached to the work
|
||||
(an example is provided in the Appendix below).
|
||||
|
||||
"Derivative Works" shall mean any work, whether in Source or Object
|
||||
form, that is based on (or derived from) the Work and for which the
|
||||
editorial revisions, annotations, elaborations, or other modifications
|
||||
represent, as a whole, an original work of authorship. For the purposes
|
||||
of this License, Derivative Works shall not include works that remain
|
||||
separable from, or merely link (or bind by name) to the interfaces of,
|
||||
the Work and Derivative Works thereof.
|
||||
|
||||
"Contribution" shall mean any work of authorship, including
|
||||
the original version of the Work and any modifications or additions
|
||||
to that Work or Derivative Works thereof, that is intentionally
|
||||
submitted to Licensor for inclusion in the Work by the copyright owner
|
||||
or by an individual or Legal Entity authorized to submit on behalf of
|
||||
the copyright owner. For the purposes of this definition, "submitted"
|
||||
means any form of electronic, verbal, or written communication sent
|
||||
to the Licensor or its representatives, including but not limited to
|
||||
communication on electronic mailing lists, source code control systems,
|
||||
and issue tracking systems that are managed by, or on behalf of, the
|
||||
Licensor for the purpose of discussing and improving the Work, but
|
||||
excluding communication that is conspicuously marked or otherwise
|
||||
designated in writing by the copyright owner as "Not a Contribution."
|
||||
|
||||
"Contributor" shall mean Licensor and any individual or Legal Entity
|
||||
on behalf of whom a Contribution has been received by Licensor and
|
||||
subsequently incorporated within the Work.
|
||||
|
||||
2. Grant of Copyright License. Subject to the terms and conditions of
|
||||
this License, each Contributor hereby grants to You a perpetual,
|
||||
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
||||
copyright license to reproduce, prepare Derivative Works of,
|
||||
publicly display, publicly perform, sublicense, and distribute the
|
||||
Work and such Derivative Works in Source or Object form.
|
||||
|
||||
3. Grant of Patent License. Subject to the terms and conditions of
|
||||
this License, each Contributor hereby grants to You a perpetual,
|
||||
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
||||
(except as stated in this section) patent license to make, have made,
|
||||
use, offer to sell, sell, import, and otherwise transfer the Work,
|
||||
where such license applies only to those patent claims licensable
|
||||
by such Contributor that are necessarily infringed by their
|
||||
Contribution(s) alone or by combination of their Contribution(s)
|
||||
with the Work to which such Contribution(s) was submitted. If You
|
||||
institute patent litigation against any entity (including a
|
||||
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
||||
or a Contribution incorporated within the Work constitutes direct
|
||||
or contributory patent infringement, then any patent licenses
|
||||
granted to You under this License for that Work shall terminate
|
||||
as of the date such litigation is filed.
|
||||
|
||||
4. Redistribution. You may reproduce and distribute copies of the
|
||||
Work or Derivative Works thereof in any medium, with or without
|
||||
modifications, and in Source or Object form, provided that You
|
||||
meet the following conditions:
|
||||
|
||||
(a) You must give any other recipients of the Work or
|
||||
Derivative Works a copy of this License; and
|
||||
|
||||
(b) You must cause any modified files to carry prominent notices
|
||||
stating that You changed the files; and
|
||||
|
||||
(c) You must retain, in the Source form of any Derivative Works
|
||||
that You distribute, all copyright, patent, trademark, and
|
||||
attribution notices from the Source form of the Work,
|
||||
excluding those notices that do not pertain to any part of
|
||||
the Derivative Works; and
|
||||
|
||||
(d) If the Work includes a "NOTICE" text file as part of its
|
||||
distribution, then any Derivative Works that You distribute must
|
||||
include a readable copy of the attribution notices contained
|
||||
within such NOTICE file, excluding those notices that do not
|
||||
pertain to any part of the Derivative Works, in at least one
|
||||
of the following places: within a NOTICE text file distributed
|
||||
as part of the Derivative Works; within the Source form or
|
||||
documentation, if provided along with the Derivative Works; or,
|
||||
within a display generated by the Derivative Works, if and
|
||||
wherever such third-party notices normally appear. The contents
|
||||
of the NOTICE file are for informational purposes only and
|
||||
do not modify the License. You may add Your own attribution
|
||||
notices within Derivative Works that You distribute, alongside
|
||||
or as an addendum to the NOTICE text from the Work, provided
|
||||
that such additional attribution notices cannot be construed
|
||||
as modifying the License.
|
||||
|
||||
You may add Your own copyright statement to Your modifications and
|
||||
may provide additional or different license terms and conditions
|
||||
for use, reproduction, or distribution of Your modifications, or
|
||||
for any such Derivative Works as a whole, provided Your use,
|
||||
reproduction, and distribution of the Work otherwise complies with
|
||||
the conditions stated in this License.
|
||||
|
||||
5. Submission of Contributions. Unless You explicitly state otherwise,
|
||||
any Contribution intentionally submitted for inclusion in the Work
|
||||
by You to the Licensor shall be under the terms and conditions of
|
||||
this License, without any additional terms or conditions.
|
||||
Notwithstanding the above, nothing herein shall supersede or modify
|
||||
the terms of any separate license agreement you may have executed
|
||||
with Licensor regarding such Contributions.
|
||||
|
||||
6. Trademarks. This License does not grant permission to use the trade
|
||||
names, trademarks, service marks, or product names of the Licensor,
|
||||
except as required for reasonable and customary use in describing the
|
||||
origin of the Work and reproducing the content of the NOTICE file.
|
||||
|
||||
7. Disclaimer of Warranty. Unless required by applicable law or
|
||||
agreed to in writing, Licensor provides the Work (and each
|
||||
Contributor provides its Contributions) on an "AS IS" BASIS,
|
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
||||
implied, including, without limitation, any warranties or conditions
|
||||
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
||||
PARTICULAR PURPOSE. You are solely responsible for determining the
|
||||
appropriateness of using or redistributing the Work and assume any
|
||||
risks associated with Your exercise of permissions under this License.
|
||||
|
||||
8. Limitation of Liability. In no event and under no legal theory,
|
||||
whether in tort (including negligence), contract, or otherwise,
|
||||
unless required by applicable law (such as deliberate and grossly
|
||||
negligent acts) or agreed to in writing, shall any Contributor be
|
||||
liable to You for damages, including any direct, indirect, special,
|
||||
incidental, or consequential damages of any character arising as a
|
||||
result of this License or out of the use or inability to use the
|
||||
Work (including but not limited to damages for loss of goodwill,
|
||||
work stoppage, computer failure or malfunction, or any and all
|
||||
other commercial damages or losses), even if such Contributor
|
||||
has been advised of the possibility of such damages.
|
||||
|
||||
9. Accepting Warranty or Additional Liability. While redistributing
|
||||
the Work or Derivative Works thereof, You may choose to offer,
|
||||
and charge a fee for, acceptance of support, warranty, indemnity,
|
||||
or other liability obligations and/or rights consistent with this
|
||||
License. However, in accepting such obligations, You may act only
|
||||
on Your own behalf and on Your sole responsibility, not on behalf
|
||||
of any other Contributor, and only if You agree to indemnify,
|
||||
defend, and hold each Contributor harmless for any liability
|
||||
incurred by, or claims asserted against, such Contributor by reason
|
||||
of your accepting any such warranty or additional liability.
|
||||
|
||||
END OF TERMS AND CONDITIONS
|
||||
|
||||
APPENDIX: How to apply the Apache License to your work.
|
||||
|
||||
To apply the Apache License to your work, attach the following
|
||||
boilerplate notice, with the fields enclosed by brackets "{}"
|
||||
replaced with your own identifying information. (Don't include
|
||||
the brackets!) The text should be enclosed in the appropriate
|
||||
comment syntax for the file format. We also recommend that a
|
||||
file or class name and description of purpose be included on the
|
||||
same "printed page" as the copyright notice for easier
|
||||
identification within third-party archives.
|
||||
|
||||
Copyright {yyyy} {name of copyright owner}
|
||||
|
||||
Licensed under the Apache License, Version 2.0 (the "License");
|
||||
you may not use this file except in compliance with the License.
|
||||
You may obtain a copy of the License at
|
||||
|
||||
http://www.apache.org/licenses/LICENSE-2.0
|
||||
|
||||
Unless required by applicable law or agreed to in writing, software
|
||||
distributed under the License is distributed on an "AS IS" BASIS,
|
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
See the License for the specific language governing permissions and
|
||||
limitations under the License.
|
||||
@@ -0,0 +1,9 @@
|
||||
# Nickname data
|
||||
|
||||
`names.csv` is from the [nicknames](https://github.com/carltonnorthern/nicknames) project by
|
||||
Carlton Northern and contributors (commit `ed160b3`), used under the Apache License 2.0
|
||||
(see `LICENSE.txt`). It is unmodified.
|
||||
|
||||
Each row is `name1,has_nickname,name2`. `CustomerSearchService` uses it so that a search for
|
||||
"Bill Smith" finds "William Smith". To update it, replace `names.csv` with a newer copy from the
|
||||
project; extra name groups can also be added in `CustomerSearchService::EXTRA_NICKNAME_GROUPS`.
|
||||
File diff suppressed because it is too large.
Load diff
@@ -0,0 +1,33 @@
|
||||
#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.
|
||||
|
||||
# The QuickBooks product/service list. The table was created by redmine_qbo_lineitems before items moved
|
||||
# into this plugin, so each step is skipped when an existing database already has it: nothing is dropped or
|
||||
# copied, the existing table is simply used from here on.
|
||||
class CreateItemsTable < ActiveRecord::Migration[7.0]
|
||||
def up
|
||||
return if table_exists?(:items)
|
||||
|
||||
create_table :items do |t|
|
||||
t.text :description, null: false
|
||||
t.decimal :unit_price,
|
||||
precision: 15,
|
||||
scale: 4,
|
||||
null: false,
|
||||
default: 0
|
||||
t.boolean :active, default: true, null: false
|
||||
t.timestamps
|
||||
end
|
||||
end
|
||||
|
||||
def down
|
||||
drop_table :items if table_exists?(:items)
|
||||
end
|
||||
end
|
||||
@@ -0,0 +1,22 @@
|
||||
#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.
|
||||
|
||||
# Item name and SKU (skipped where redmine_qbo_lineitems already added them)
|
||||
class AddItemNameAndSku < ActiveRecord::Migration[7.0]
|
||||
def up
|
||||
add_column :items, :name, :string, null: false unless column_exists?(:items, :name)
|
||||
add_column :items, :sku, :string unless column_exists?(:items, :sku)
|
||||
end
|
||||
|
||||
def down
|
||||
remove_column :items, :sku if column_exists?(:items, :sku)
|
||||
remove_column :items, :name if column_exists?(:items, :name)
|
||||
end
|
||||
end
|
||||
@@ -0,0 +1,37 @@
|
||||
#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.
|
||||
|
||||
# QuickBooks income accounts, and each item's account, type and taxable flag
|
||||
# (skipped where redmine_qbo_lineitems already created them)
|
||||
class CreateAccountsTable < ActiveRecord::Migration[7.0]
|
||||
def up
|
||||
unless table_exists?(:accounts)
|
||||
create_table :accounts do |t|
|
||||
t.text :name, null: false
|
||||
t.text :description
|
||||
t.boolean :active, default: true, null: false
|
||||
t.boolean :default, default: false, null: false
|
||||
t.text :classification
|
||||
t.timestamps
|
||||
end
|
||||
end
|
||||
|
||||
add_reference :items, :account, foreign_key: true unless column_exists?(:items, :account_id)
|
||||
add_column :items, :type, :string unless column_exists?(:items, :type)
|
||||
add_column :items, :taxable, :boolean, null: true unless column_exists?(:items, :taxable)
|
||||
end
|
||||
|
||||
def down
|
||||
remove_column :items, :taxable if column_exists?(:items, :taxable)
|
||||
remove_column :items, :type if column_exists?(:items, :type)
|
||||
remove_reference :items, :account, foreign_key: true if column_exists?(:items, :account_id)
|
||||
drop_table :accounts if table_exists?(:accounts)
|
||||
end
|
||||
end
|
||||
@@ -0,0 +1,46 @@
|
||||
#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.
|
||||
|
||||
# Records which issue was created from which QuickBooks estimate line, so a line can't be turned into an
|
||||
# issue twice. Issues redmine_qbo_calendar created from appointment estimates are copied in, so they still
|
||||
# count as created.
|
||||
class CreateQboEstimateLineIssues < ActiveRecord::Migration[7.0]
|
||||
class LineIssue < ActiveRecord::Base
|
||||
self.table_name = 'qbo_estimate_line_issues'
|
||||
end
|
||||
|
||||
def up
|
||||
unless table_exists?(:qbo_estimate_line_issues)
|
||||
create_table :qbo_estimate_line_issues do |t|
|
||||
t.bigint :estimate_id, null: false
|
||||
t.string :line_id, null: false
|
||||
t.references :issue, null: false, index: { unique: true }
|
||||
t.datetime :created_on, null: false
|
||||
end
|
||||
add_index :qbo_estimate_line_issues, [:estimate_id, :line_id], unique: true, name: 'index_qbo_estimate_line_issues_on_line'
|
||||
end
|
||||
|
||||
return unless table_exists?(:appointment_estimate_issues)
|
||||
|
||||
LineIssue.reset_column_information
|
||||
existing_issue_ids = select_values('SELECT id FROM issues').map(&:to_i).to_set
|
||||
select_all('SELECT estimate_id, line_id, issue_id, created_on FROM appointment_estimate_issues').each do |row|
|
||||
next unless existing_issue_ids.include?(row['issue_id'].to_i)
|
||||
next if LineIssue.exists?(estimate_id: row['estimate_id'], line_id: row['line_id']) || LineIssue.exists?(issue_id: row['issue_id'])
|
||||
|
||||
LineIssue.create!(estimate_id: row['estimate_id'], line_id: row['line_id'], issue_id: row['issue_id'],
|
||||
created_on: row['created_on'] || Time.current)
|
||||
end
|
||||
end
|
||||
|
||||
def down
|
||||
drop_table :qbo_estimate_line_issues if table_exists?(:qbo_estimate_line_issues)
|
||||
end
|
||||
end
|
||||
@@ -13,8 +13,8 @@ Redmine::Plugin.register :redmine_qbo do
|
||||
# About
|
||||
name 'Redmine QBO plugin'
|
||||
author 'Rick Barrette'
|
||||
description 'A pluging for Redmine to connect with QuickBooks Online to create Time Activity Entries for billable hours logged when an Issue is closed'
|
||||
version '2026.8.0'
|
||||
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.1'
|
||||
url 'https://github.com/rickbarrette/redmine_qbo'
|
||||
author_url 'https://barrettefabrication.com'
|
||||
settings default: {empty: true}, partial: 'qbo/settings'
|
||||
@@ -30,12 +30,32 @@ Redmine::Plugin.register :redmine_qbo do
|
||||
# set per_page globally
|
||||
WillPaginate.per_page = 20
|
||||
|
||||
# Permissions for security
|
||||
permission :view_customers, customers: :index, public: false
|
||||
permission :add_customers, customers: :new, public: false
|
||||
# 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
|
||||
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
|
||||
|
||||
# Project permissions
|
||||
permission :bill_issues, { qbo: [:bill] }
|
||||
|
||||
# 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
|
||||
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
|
||||
permission :send_invoices, { qbo_invoices: [:send_email] }, global: true
|
||||
permission :view_payments, { qbo_payments: [:index, :show, :pdf] }, global: true
|
||||
permission :receive_payments, { qbo_payments: [:index, :new, :create, :show, :pdf, :open_invoices],
|
||||
qbo_estimates: [:customer_info] }, global: true
|
||||
# The product/service list, accounts and their syncs are admin-only (see ItemsController, AccountsController)
|
||||
|
||||
# Register top menu items
|
||||
menu :top_menu, :customers, { controller: :customers, action: :index }, caption: :label_customers, if: Proc.new {User.current.logged?}
|
||||
menu :top_menu, :customers, { controller: :customers, action: :index }, caption: :label_customers, if: Proc.new {User.current.allowed_to?(:view_customers, nil, global: true)}
|
||||
|
||||
Redmine::Search.map do |search|
|
||||
search.register :customers
|
||||
@@ -43,4 +63,4 @@ Redmine::Plugin.register :redmine_qbo do
|
||||
|
||||
end
|
||||
|
||||
RedmineQbo.setup
|
||||
RedmineQbo.setup
|
||||
@@ -29,6 +29,18 @@ module RedmineQbo
|
||||
RedmineQbo::Hooks::IssuesHookListener
|
||||
RedmineQbo::Hooks::UsersShowHookListener
|
||||
RedmineQbo::Hooks::ViewHookListener
|
||||
|
||||
# === Billing: estimates, invoices, payments, items and accounts ===
|
||||
RedmineQboBilling.setup
|
||||
|
||||
# If the SubtaskFieldCopier plugin is installed, register our fields
|
||||
if defined?(SubtaskFieldCopier)
|
||||
SubtaskFieldCopier.registered_fields << :customer
|
||||
SubtaskFieldCopier.registered_fields << :estimate
|
||||
|
||||
# Ensure there are no duplicates in case of hot-reloads in development mode
|
||||
SubtaskFieldCopier.registered_fields.uniq!
|
||||
end
|
||||
end
|
||||
|
||||
def self.settings
|
||||
|
||||
@@ -11,27 +11,51 @@
|
||||
module RedmineQbo
|
||||
module Patches
|
||||
module AttachmentsControllerPatch
|
||||
module Helper
|
||||
# Check if login is globally required to access the application
|
||||
def check_if_login_required
|
||||
# Return true if the user is already logged in
|
||||
return true if User.current.logged?
|
||||
|
||||
# Pull up the attachment and verify if we have a valid token for the issue
|
||||
attachment = Attachment.find_by(id: params[:id])
|
||||
return require_login if attachment.nil?
|
||||
|
||||
token = CustomerToken.where("token = ? AND expires_at > ?", session[:token], Time.current).first
|
||||
return true if token&.issue_id == attachment.container_id
|
||||
|
||||
# Default to requiring login if all else fails
|
||||
require_login if Setting.login_required?
|
||||
end
|
||||
end
|
||||
|
||||
def self.apply
|
||||
AttachmentsController.class_eval do
|
||||
helper Helper
|
||||
# 1. PREPEND: Must run before ANY of Redmine's ApplicationController filters
|
||||
prepend_before_action :load_customer_token
|
||||
|
||||
# 2. Skip global login redirects if the user holds a valid token for this file
|
||||
skip_before_action :check_if_login_required, if: :valid_customer_token?
|
||||
skip_before_action :check_project_privacy, raise: false, if: :valid_customer_token?
|
||||
|
||||
# Note: We do NOT need to skip :read_authorize anymore.
|
||||
# Because we patched Attachment#visible?, read_authorize will pass naturally!
|
||||
|
||||
private
|
||||
|
||||
# Kept on the controller instance (one per request) rather than Thread.current, which is reused
|
||||
# across requests by the web server and could carry one customer's token into another request.
|
||||
def load_customer_token
|
||||
@customer_token = session[:token].present? ? CustomerToken.active.find_by(token: session[:token]) : nil
|
||||
end
|
||||
|
||||
def valid_customer_token?
|
||||
token = @customer_token
|
||||
return false unless token
|
||||
|
||||
# Handle "Download All" zip requests (object_type=issues, object_id=ID)
|
||||
if params[:action] == 'download_all'
|
||||
return params[:object_type] == 'issues' && params[:object_id].to_i == token.issue_id
|
||||
end
|
||||
|
||||
# Handle normal single attachment requests (show, download, thumbnail)
|
||||
attachment = Attachment.find_by(id: params[:id])
|
||||
return false unless attachment
|
||||
|
||||
# Allow if attachment belongs directly to the Issue
|
||||
if attachment.container_type == 'Issue' && attachment.container_id == token.issue_id
|
||||
return true
|
||||
end
|
||||
|
||||
# Allow if attachment belongs to a Journal (comment) on the Issue
|
||||
if attachment.container_type == 'Journal' && attachment.container.journalized_type == 'Issue' && attachment.container.journalized_id == token.issue_id
|
||||
return true
|
||||
end
|
||||
|
||||
false
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
@@ -32,12 +32,13 @@ module RedmineQbo
|
||||
BillIssueTimeJob.perform_later(id)
|
||||
end
|
||||
|
||||
# Titlize the subject for consistent formatting in billing descriptions
|
||||
# Capitalize each word of the subject for consistent billing descriptions, without lowercasing
|
||||
# the rest of the word (keeps LED, JL, 4x4 as typed). Only runs when the subject changes.
|
||||
def titlize_subject
|
||||
return unless subject.present? && will_save_change_to_subject?
|
||||
|
||||
log "Titlizing subject for issue ##{id}"
|
||||
self.subject = subject.split(/\s+/).map do |word|
|
||||
(word =~ /[A-Z]/ && word =~ /[0-9]/) ? word : word.capitalize
|
||||
end.join(' ')
|
||||
self.subject = RedmineQbo::TitleCase.call(subject)
|
||||
end
|
||||
|
||||
# Generate a shareable token linking this issue to the customer for QuickBooks
|
||||
|
||||
@@ -16,11 +16,16 @@ module RedmineQbo
|
||||
def watcher_link(issue, user)
|
||||
links = ''
|
||||
|
||||
# Admin users can bill time
|
||||
links << link_to(I18n.t(:label_bill_time), bill_path(issue.id), method: :get, class: 'icon icon-email-add') if user.admin?
|
||||
# Users with the "Bill issues" permission can bill time (POST, so it can't be triggered by a plain link)
|
||||
if user.allowed_to?(:bill_issues, issue.project)
|
||||
links << link_to(I18n.t(:label_bill_time), bill_path(issue.id), method: :post,
|
||||
data: { confirm: I18n.t(:text_are_you_sure) }, class: 'icon icon-email-add')
|
||||
end
|
||||
|
||||
# Logged-in users can share the issue
|
||||
links << link_to(I18n.t(:label_share), share_path(issue.id), method: :get, target: :_blank, class: 'icon icon-shared') if user.logged?
|
||||
# Users with the "Share issues with customers" permission can create a customer link
|
||||
if user.allowed_to?(:share_issues_with_customers, nil, global: true)
|
||||
links << link_to(I18n.t(:label_share), share_path(issue.id), method: :get, target: :_blank, class: 'icon icon-shared')
|
||||
end
|
||||
|
||||
# Append to the original watcher links
|
||||
(links.html_safe + super).html_safe
|
||||
|
||||
@@ -13,6 +13,12 @@ module RedmineQbo
|
||||
module PdfPatch
|
||||
extend ActiveSupport::Concern
|
||||
|
||||
# Rows returned by the :pdf_left / :pdf_right hooks are [label, text], or
|
||||
# [label, text, { html: "..." }] to draw the value as simple HTML (e.g. part of it in <b>).
|
||||
# text is still required: it sizes the row. Other plugins can check this constant before
|
||||
# sending HTML values, so they keep working with older versions of this plugin.
|
||||
PDF_HTML_VALUES = true
|
||||
|
||||
def issue_to_pdf(issue, assoc={})
|
||||
pdf = setup_pdf(issue)
|
||||
|
||||
@@ -136,8 +142,8 @@ module RedmineQbo
|
||||
hr1 = pdf.get_string_height(35, item_right ? "#{item_right.first}:" : "")
|
||||
|
||||
pdf.SetFontStyle('', 9)
|
||||
hl2 = pdf.get_string_height(60, item_left ? item_left.last.to_s : "")
|
||||
hr2 = pdf.get_string_height(60, item_right ? item_right.last.to_s : "")
|
||||
hl2 = pdf.get_string_height(60, item_left ? item_left[1].to_s : "")
|
||||
hr2 = pdf.get_string_height(60, item_right ? item_right[1].to_s : "")
|
||||
|
||||
height = [hl1, hr1, hl2, hr2].max
|
||||
|
||||
@@ -162,7 +168,13 @@ module RedmineQbo
|
||||
pdf.RDMMultiCell(35, height, item ? "#{item.first}:" : "", border_label, '', 0, 0)
|
||||
|
||||
pdf.SetFontStyle('', 9)
|
||||
pdf.RDMMultiCell(60, height, item ? item.last.to_s : "", border_val, '', 0, ln_type)
|
||||
html = item && item[2].is_a?(Hash) ? item[2][:html].presence : nil
|
||||
if html
|
||||
# Plugin-supplied HTML value, drawn directly (RDMwriteHTMLCell would run wiki formatting on it)
|
||||
pdf.writeHTMLCell(60, height, '', '', html, border_val, ln_type, 0)
|
||||
else
|
||||
pdf.RDMMultiCell(60, height, item ? item[1].to_s : "", border_val, '', 0, ln_type)
|
||||
end
|
||||
end
|
||||
|
||||
def render_description(pdf, issue)
|
||||
@@ -176,6 +188,10 @@ module RedmineQbo
|
||||
edit_section_links: false,
|
||||
headings: false,
|
||||
inline_attachments: false)
|
||||
|
||||
# Apply the fix here
|
||||
text = sanitize_html_for_pdf(text)
|
||||
|
||||
pdf.RDMwriteFormattedCell(190, 5, '', '', text, issue.attachments, "LRB")
|
||||
end
|
||||
|
||||
@@ -275,6 +291,10 @@ module RedmineQbo
|
||||
pdf.ln unless journal.details.empty?
|
||||
pdf.SetFontStyle('', 8)
|
||||
text = textilizable(journal, :notes, only_path: false, edit_section_links: false, headings: false, inline_attachments: false)
|
||||
|
||||
# Apply the fix here
|
||||
text = sanitize_html_for_pdf(text)
|
||||
|
||||
pdf.RDMwriteFormattedCell(190, 5, '', '', text, issue.attachments, "")
|
||||
end
|
||||
pdf.ln
|
||||
@@ -309,6 +329,40 @@ module RedmineQbo
|
||||
end
|
||||
end
|
||||
|
||||
private
|
||||
|
||||
# NEW HELPER: Aggressively cleans up HTML so RBPDF doesn't crash on tables
|
||||
def sanitize_html_for_pdf(text)
|
||||
clean_text = text.to_s.dup
|
||||
|
||||
# 1. RBPDF layout engine hates div wrappers. Strip all opening and closing divs.
|
||||
clean_text.gsub!(/<\/?div[^>]*>/i, '')
|
||||
|
||||
# 2. Rebuild tables into a completely flat, pure HTML structure that TCPDF supports
|
||||
clean_text.gsub!(/<table[^>]*>.*?<\/table>/mi) do |match|
|
||||
table_html = match.dup
|
||||
|
||||
# Strip thead and tbody tags completely
|
||||
table_html.gsub!(/<\/?thead[^>]*>/i, '')
|
||||
table_html.gsub!(/<\/?tbody[^>]*>/i, '')
|
||||
|
||||
# TCPDF cell width calculations crash on <th> tags. Convert them to <td> + bold.
|
||||
table_html.gsub!(/<th([^>]*)>/i, '<td\1><strong>')
|
||||
table_html.gsub!(/<\/th>/i, '</strong></td>')
|
||||
|
||||
# Remove all newlines and spaces between tags to prevent stray text nodes crashing the parser
|
||||
table_html.gsub!(/>\s+</m, '><')
|
||||
table_html.gsub!(/\r?\n/, '')
|
||||
|
||||
# Inject a standardized <table> tag with borders so the table actually renders visibly
|
||||
table_html.sub!(/<table[^>]*>/i, '<table border="1" cellpadding="4" style="border-collapse: collapse;">')
|
||||
|
||||
table_html
|
||||
end
|
||||
|
||||
clean_text
|
||||
end
|
||||
|
||||
end
|
||||
end
|
||||
end
|
||||
@@ -0,0 +1,27 @@
|
||||
#The MIT License (MIT)
|
||||
#
|
||||
#Copyright (c) 2016 - 2026 rick barrette
|
||||
#
|
||||
#Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
|
||||
#
|
||||
#The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
|
||||
#
|
||||
#THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
||||
|
||||
module RedmineQbo
|
||||
# Capitalizes the first letter of every word and leaves the rest of each word exactly as typed,
|
||||
# so acronyms and model names survive: "led light bar for JL" -> "Led Light Bar For JL",
|
||||
# "LED" stays "LED", "4x4" stays "4x4", "(front)" -> "(Front)". Runs of whitespace become one space.
|
||||
# (Rails' titleize lowercases the rest of each word, turning "LED" into "Led" and "JL" into "Jl".)
|
||||
module TitleCase
|
||||
module_function
|
||||
|
||||
def call(text)
|
||||
return text if text.nil?
|
||||
|
||||
text.to_s.split(/\s+/).reject(&:empty?).map do |word|
|
||||
word.sub(/\A([^\p{L}\p{N}]*)(\p{Ll})/) { "#{Regexp.last_match(1)}#{Regexp.last_match(2).upcase}" }
|
||||
end.join(' ')
|
||||
end
|
||||
end
|
||||
end
|
||||
@@ -0,0 +1,60 @@
|
||||
#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.
|
||||
|
||||
# Billing in Redmine: writing, editing and emailing QuickBooks estimates and invoices, receiving payments,
|
||||
# the QuickBooks product/service list and accounts, and creating issues from estimates. Called from
|
||||
# RedmineQbo.setup. (It began as the separate redmine_qbo_billing plugin, hence the name; other plugins use
|
||||
# its hooks and RedmineQboBilling::EstimateWriter.create_estimate.)
|
||||
module RedmineQboBilling
|
||||
def self.setup
|
||||
# Invoice lines that bill time activities need a LinkedTxn
|
||||
RedmineQboBilling::Patches::InvoiceLineItemLinkedTxn.apply!
|
||||
|
||||
# Hooks
|
||||
RedmineQboBilling::Hooks::QboHookListener
|
||||
RedmineQboBilling::Hooks::IssueMileageListener
|
||||
|
||||
# Administration menu: the QuickBooks product/service list (accounts are reached from it)
|
||||
Redmine::MenuManager.map :admin_menu do |menu|
|
||||
menu.push :redmine_qbo_items, { controller: 'items', action: 'index' }, icon: 'list', caption: :label_items,
|
||||
html: { class: 'icon icon-list' } unless menu.exists?(:redmine_qbo_items)
|
||||
end
|
||||
end
|
||||
|
||||
# True when the user may write estimates
|
||||
def self.writer?(user = User.current)
|
||||
user.allowed_to?(:write_estimates, nil, global: true)
|
||||
end
|
||||
|
||||
# True when the user may email estimates to customers
|
||||
def self.sender?(user = User.current)
|
||||
user.allowed_to?(:send_estimates, nil, global: true)
|
||||
end
|
||||
|
||||
# True when the user may receive customer payments
|
||||
def self.payment_receiver?(user = User.current)
|
||||
user.allowed_to?(:receive_payments, 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)
|
||||
end
|
||||
|
||||
# True when the user may write invoices
|
||||
def self.invoice_writer?(user = User.current)
|
||||
user.allowed_to?(:write_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)
|
||||
end
|
||||
end
|
||||
@@ -0,0 +1,152 @@
|
||||
#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 QuickBooks company is set up with, read from its Preferences so nothing has to be configured
|
||||
# in Redmine: the estimate custom fields (found by name), whether estimate numbers are typed by hand,
|
||||
# and the default message shown on estimates.
|
||||
#
|
||||
# QuickBooks only shares its first three text custom fields with apps (dropdown fields aren't
|
||||
# available), so a "Sales Person" dropdown has to be changed to a text field to be filled in here.
|
||||
module Company
|
||||
CACHE_KEY = 'redmine_qbo_billing:company'
|
||||
CACHE_TIME = 1.hour
|
||||
# While the VIN or sales person field is missing, look again sooner (e.g. right after adding it in QuickBooks)
|
||||
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
|
||||
|
||||
# Custom field names are matched loosely, e.g. "VIN", "Vin #", "Sales Person", "Salesperson", "Sales Rep"
|
||||
VIN_NAME = /\bvin\b/i
|
||||
SALES_PERSON_NAME = /sales|\brep\b/i
|
||||
MILEAGE_NAME = /mileage|odometer|\bmiles\b/i
|
||||
|
||||
Field = Struct.new(:id, :name)
|
||||
|
||||
module_function
|
||||
|
||||
# All enabled sales form custom fields, in QuickBooks' order
|
||||
def custom_fields
|
||||
Array(settings[:custom_fields]).map { |f| Field.new(f[:id], f[:name]) }
|
||||
end
|
||||
|
||||
def vin_field
|
||||
custom_fields.detect { |f| f.name.to_s =~ VIN_NAME }
|
||||
end
|
||||
|
||||
# Optional: a text field named like "Mileage" or "Odometer"
|
||||
def mileage_field
|
||||
custom_fields.detect { |f| f.name.to_s =~ MILEAGE_NAME && f.name.to_s !~ VIN_NAME }
|
||||
end
|
||||
|
||||
def sales_person_field
|
||||
custom_fields.detect { |f| f.name.to_s =~ SALES_PERSON_NAME && f.name.to_s !~ VIN_NAME }
|
||||
end
|
||||
|
||||
# When on, QuickBooks leaves estimate numbers to the user; when off it numbers them itself
|
||||
def custom_txn_numbers?
|
||||
settings[:custom_txn_numbers] == true
|
||||
end
|
||||
|
||||
# The "default message shown on estimates" from QuickBooks' sales settings
|
||||
def estimate_message
|
||||
settings[:estimate_message].to_s
|
||||
end
|
||||
|
||||
# The "default message shown on invoices" (and other sales forms)
|
||||
def invoice_message
|
||||
settings[:invoice_message].to_s
|
||||
end
|
||||
|
||||
# Forgets the cached preferences, e.g. after a custom field was renamed in QuickBooks
|
||||
def refresh!
|
||||
Rails.cache.delete(CACHE_KEY)
|
||||
settings
|
||||
end
|
||||
|
||||
# Cached for an hour (five minutes while a field is missing). A failed lookup isn't cached.
|
||||
def settings
|
||||
cached = Rails.cache.read(CACHE_KEY)
|
||||
return cached if cached
|
||||
|
||||
fresh = fetch_settings
|
||||
return {} unless fresh
|
||||
|
||||
names = fresh[:custom_fields].map { |f| f[:name].to_s }
|
||||
complete = names.any? { |n| n =~ VIN_NAME } && names.any? { |n| n =~ SALES_PERSON_NAME && n !~ VIN_NAME }
|
||||
Rails.cache.write(CACHE_KEY, fresh, expires_in: complete ? CACHE_TIME : MISSING_FIELD_CACHE_TIME)
|
||||
fresh
|
||||
end
|
||||
|
||||
def fetch_settings
|
||||
QboConnectionService.with_qbo_service(entity: 'Preferences') do |service|
|
||||
prefs = service.query.entries.first
|
||||
return nil unless prefs
|
||||
|
||||
forms = prefs.sales_forms
|
||||
{
|
||||
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,
|
||||
estimate_message: forms&.estimate_message.to_s,
|
||||
invoice_message: forms&.default_customer_message.to_s
|
||||
}
|
||||
end
|
||||
rescue StandardError => e
|
||||
Rails.logger.warn "[RedmineQboBilling] Could not read QuickBooks preferences: #{e.message}"
|
||||
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.
|
||||
def merge_fields(from_preferences, from_estimates)
|
||||
ids = from_preferences.map { |f| f[:id] }
|
||||
from_preferences + from_estimates.reject { |f| ids.include?(f[:id]) }
|
||||
end
|
||||
|
||||
# The text custom fields on the most recently changed estimates
|
||||
def custom_fields_from_estimates
|
||||
estimates = QboEstimateService.with_service do |service|
|
||||
service.query('SELECT * FROM Estimate ORDERBY MetaData.LastUpdatedTime DESC', per_page: RECENT_ESTIMATES).entries
|
||||
end
|
||||
|
||||
Array(estimates).flat_map { |e| Array(e.custom_fields) }
|
||||
.select { |f| f.id.to_i > 0 && f.name.present? && (f.type.blank? || f.type.to_s == 'StringType') }
|
||||
.map { |f| { id: f.id.to_i, name: f.name.to_s.strip } }
|
||||
.uniq { |f| f[:id] }
|
||||
.sort_by { |f| f[:id] }
|
||||
rescue StandardError => e
|
||||
Rails.logger.warn "[RedmineQboBilling] Could not read custom fields from recent estimates: #{e.message}"
|
||||
[]
|
||||
end
|
||||
|
||||
# Preferences list the custom fields as name/value pairs:
|
||||
# SalesFormsPrefs.UseSalesCustom2 => true (field 2 is turned on)
|
||||
# SalesFormsPrefs.SalesCustomName2 => "VIN" (field 2's name)
|
||||
# The number is the field's DefinitionId on estimates.
|
||||
def parse_custom_fields(entries)
|
||||
enabled = {}
|
||||
names = {}
|
||||
|
||||
Array(entries).each do |entry|
|
||||
case entry.name.to_s
|
||||
when /UseSalesCustom(\d+)\z/
|
||||
enabled[$1.to_i] = entry.boolean_value.to_s == 'true'
|
||||
when /SalesCustomName(\d+)\z/
|
||||
names[$1.to_i] = entry.string_value.to_s.strip
|
||||
end
|
||||
end
|
||||
|
||||
names.keys.sort.filter_map do |id|
|
||||
next if names[id].blank? || enabled[id] == false
|
||||
{ id: id, name: names[id] }
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
@@ -0,0 +1,235 @@
|
||||
#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 estimate and invoice editor shows and posts: the header fields and the lines.
|
||||
# EstimateWriter and InvoiceWriter turn it into a QuickBooks estimate or invoice and back.
|
||||
class EstimateForm
|
||||
include ActiveModel::Model
|
||||
include ActiveModel::Validations
|
||||
|
||||
# One row of the line table. A row with a product/service is a sales line; a row with only a
|
||||
# description (e.g. the estimate notes on the first line) becomes a description-only line.
|
||||
# A subtotal row (kind "subtotal") totals the lines above it, back to the previous subtotal.
|
||||
# On invoices, a row imported from a QuickBooks time activity keeps its id (time_activity_id) so the
|
||||
# invoice line stays linked to it and QuickBooks marks the time as billed.
|
||||
class Line
|
||||
include ActiveModel::Model
|
||||
|
||||
SUBTOTAL = 'subtotal'.freeze
|
||||
|
||||
# The fields each row posts (the controller permits exactly these)
|
||||
PARAMS = %i[id kind item_id item_name description quantity rate taxable time_activity_id].freeze
|
||||
|
||||
attr_accessor :id, :kind, :item_id, :item_name, :description, :quantity, :rate, :taxable, :time_activity_id
|
||||
|
||||
def self.from_params(hash)
|
||||
hash = hash.to_h.stringify_keys
|
||||
new(
|
||||
id: hash['id'].presence,
|
||||
kind: hash['kind'].to_s == SUBTOTAL ? SUBTOTAL : nil,
|
||||
item_id: hash['item_id'].presence,
|
||||
item_name: hash['item_name'].to_s.strip,
|
||||
description: hash['description'].to_s.strip,
|
||||
quantity: hash['quantity'].to_s.strip,
|
||||
rate: hash['rate'].to_s.strip,
|
||||
taxable: hash['taxable'].to_s == '1',
|
||||
time_activity_id: hash['time_activity_id'].presence
|
||||
)
|
||||
end
|
||||
|
||||
def quantity_value
|
||||
EstimateForm.decimal(quantity)
|
||||
end
|
||||
|
||||
def rate_value
|
||||
EstimateForm.decimal(rate)
|
||||
end
|
||||
|
||||
def subtotal?
|
||||
kind == SUBTOTAL
|
||||
end
|
||||
|
||||
# Quantity defaults to 1 when only a rate is given, like QuickBooks. Subtotals add nothing themselves.
|
||||
def amount
|
||||
return BigDecimal('0') if subtotal? || rate_value.nil?
|
||||
((quantity_value || BigDecimal('1')) * rate_value).round(2)
|
||||
end
|
||||
|
||||
def taxable?
|
||||
taxable == true || taxable.to_s == '1' || taxable.to_s == 'true'
|
||||
end
|
||||
|
||||
def item?
|
||||
!subtotal? && item_id.present?
|
||||
end
|
||||
|
||||
# No product and no price: a note line
|
||||
def description_only?
|
||||
!subtotal? && !item? && rate_value.nil?
|
||||
end
|
||||
|
||||
# Empty rows (e.g. the spare row at the bottom of the table) are dropped
|
||||
def blank?
|
||||
!subtotal? && !item? && item_name.blank? && description.blank? && rate.blank?
|
||||
end
|
||||
|
||||
# Typed in the product box but never picked from the list
|
||||
def unmatched_item?
|
||||
!subtotal? && !item? && item_name.present?
|
||||
end
|
||||
|
||||
def number_invalid?
|
||||
return false if subtotal?
|
||||
(quantity.present? && quantity_value.nil?) || (rate.present? && rate_value.nil?)
|
||||
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 vin mileage customer_memo private_note].freeze
|
||||
|
||||
# "estimate" or "invoice"
|
||||
attr_writer :document
|
||||
|
||||
attr_accessor :id, :sync_token, *HEADER_ATTRIBUTES, :sales_person, :lines,
|
||||
# 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
|
||||
:billing_address, :total, :total_tax, :discount, :email_status, :txn_status, :duplicated_from,
|
||||
:balance, :converted_from,
|
||||
# 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
|
||||
# :paid (a payment is applied to the invoice)
|
||||
:locked
|
||||
|
||||
validate :validate_customer
|
||||
validate :validate_lines
|
||||
validate :validate_dates
|
||||
validate :validate_email
|
||||
# Plugins can block a save (e.g. redmine_qbo_vehicles: one vehicle per invoice); see IssueValues
|
||||
validate :validate_with_plugins
|
||||
|
||||
def initialize(attributes = {})
|
||||
super
|
||||
self.lines ||= []
|
||||
self.linked_estimate_ids ||= []
|
||||
end
|
||||
|
||||
def document
|
||||
@document || 'estimate'
|
||||
end
|
||||
|
||||
def invoice?
|
||||
document == 'invoice'
|
||||
end
|
||||
|
||||
# Builds the form from posted params (estimate[...], with lines keyed by row in table order)
|
||||
def self.from_params(params, id: nil, document: 'estimate')
|
||||
params = params.to_h.stringify_keys
|
||||
form = new(id: id.presence, sync_token: params['sync_token'].presence, document: document)
|
||||
HEADER_ATTRIBUTES.each { |attr| form.public_send("#{attr}=", params[attr.to_s].to_s.strip) }
|
||||
form.total_tax = params['total_tax'].presence
|
||||
form.discount = params['discount'].presence
|
||||
form.email_status = params['email_status'].presence
|
||||
form.txn_status = params['txn_status'].presence
|
||||
form.balance = params['balance'].presence
|
||||
form.linked_estimate_ids = Array(params['linked_estimate_ids']).map(&:to_s).reject(&:blank?).uniq
|
||||
form.lines = params['lines'].to_h.values.map { |row| Line.from_params(row) }
|
||||
form
|
||||
end
|
||||
|
||||
def self.decimal(value)
|
||||
text = value.to_s.strip.delete(',').delete('$')
|
||||
return nil if text.empty?
|
||||
BigDecimal(text)
|
||||
rescue ArgumentError
|
||||
nil
|
||||
end
|
||||
|
||||
def self.date(value)
|
||||
return value if value.is_a?(Date)
|
||||
text = value.to_s.strip
|
||||
text.empty? ? nil : Date.iso8601(text)
|
||||
rescue ArgumentError
|
||||
nil
|
||||
end
|
||||
|
||||
def persisted?
|
||||
id.present?
|
||||
end
|
||||
|
||||
def filled_lines
|
||||
lines.reject(&:blank?)
|
||||
end
|
||||
|
||||
def subtotal
|
||||
filled_lines.sum(BigDecimal('0'), &:amount)
|
||||
end
|
||||
|
||||
def sent?
|
||||
email_status.to_s == 'EmailSent'
|
||||
end
|
||||
|
||||
def txn_date_value
|
||||
self.class.date(txn_date)
|
||||
end
|
||||
|
||||
def expiration_date_value
|
||||
self.class.date(expiration_date)
|
||||
end
|
||||
|
||||
def due_date_value
|
||||
self.class.date(due_date)
|
||||
end
|
||||
|
||||
private
|
||||
|
||||
# Messages are added to base so they read as full sentences in Redmine's error box
|
||||
def invalid(label_key)
|
||||
errors.add(:base, I18n.t(:error_estimate_field_invalid, field: I18n.t(label_key)))
|
||||
end
|
||||
|
||||
def validate_customer
|
||||
errors.add(:base, I18n.t(:error_estimate_needs_customer)) if customer_id.blank?
|
||||
end
|
||||
|
||||
def validate_lines
|
||||
if filled_lines.empty?
|
||||
errors.add(:base, I18n.t(:error_estimate_needs_a_line))
|
||||
return
|
||||
end
|
||||
|
||||
filled_lines.each_with_index do |line, index|
|
||||
number = index + 1
|
||||
errors.add(:base, I18n.t(:error_estimate_line_unmatched_item, line: number, name: line.item_name)) if line.unmatched_item?
|
||||
errors.add(:base, I18n.t(:error_estimate_line_number, line: number)) if line.number_invalid?
|
||||
errors.add(:base, I18n.t(:error_estimate_line_description, line: number)) if line.description_only? && line.description.blank?
|
||||
end
|
||||
end
|
||||
|
||||
def validate_dates
|
||||
invalid(invoice? ? :label_invoice_date : :label_estimate_date) if txn_date_value.nil?
|
||||
invalid(:label_expiration_date) if expiration_date.present? && expiration_date_value.nil?
|
||||
invalid(:label_due_date) if due_date.present? && due_date_value.nil?
|
||||
end
|
||||
|
||||
def validate_with_plugins
|
||||
IssueValues.plugin_errors(self).each { |message| errors.add(:base, message) }
|
||||
end
|
||||
|
||||
def validate_email
|
||||
return if email.blank?
|
||||
# QuickBooks takes several addresses separated by commas
|
||||
addresses = email.split(',').map(&:strip)
|
||||
invalid(:label_customer_email) unless addresses.all? { |a| a.match?(/\A[^@\s]+@[^@\s]+\z/) }
|
||||
end
|
||||
end
|
||||
end
|
||||
@@ -0,0 +1,271 @@
|
||||
#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
|
||||
# Turns the labor lines of a QuickBooks estimate into proposed issues, and creates the ones the user selects
|
||||
# on the "Create issues from estimate" page (moved here from redmine_qbo_calendar).
|
||||
#
|
||||
# - Only lines whose item matches a configured item code (e.g. "Labor", "Alignments") are proposed
|
||||
# - Subject = the line's description; estimated hours = the line's quantity
|
||||
# - 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
|
||||
#
|
||||
# Other plugins fill in more through hooks:
|
||||
# :qbo_billing_issue_defaults, { estimate:, params: } => a hash of start_date, due_date, assignee,
|
||||
# vehicle_id, description, project, return_path, return_label (e.g. redmine_qbo_calendar, when the page is
|
||||
# opened from an appointment)
|
||||
# :qbo_billing_issues_created, { estimate:, issues:, params: } after issues are created
|
||||
class EstimateIssueBuilder
|
||||
include Redmine::I18n
|
||||
|
||||
DEFAULT_ITEM_CODES = ['Labor'].freeze
|
||||
|
||||
Proposal = Struct.new(:line_id, :item_name, :description, :hours, :existing_issue, keyword_init: true) do
|
||||
def created?
|
||||
existing_issue.present?
|
||||
end
|
||||
end
|
||||
|
||||
# Item codes from the plugin settings, one per line (commas also accepted). Until they're set here, the
|
||||
# ones redmine_qbo_calendar used are kept.
|
||||
def self.item_codes
|
||||
raw = setting('issue_item_codes', 'item_codes').to_s
|
||||
codes = raw.split(/[\n,]/).map(&:strip).reject(&:blank?)
|
||||
codes.presence || DEFAULT_ITEM_CODES
|
||||
end
|
||||
|
||||
def self.default_tracker_id
|
||||
setting('issue_default_tracker_id', 'default_tracker_id').to_i
|
||||
end
|
||||
|
||||
def self.default_project_id
|
||||
setting('issue_default_project_id', 'default_project_id').to_i
|
||||
end
|
||||
|
||||
# This plugin's setting, or redmine_qbo_calendar's old one while this one is blank
|
||||
def self.setting(key, calendar_key)
|
||||
ours = (Setting.plugin_redmine_qbo || {})[key]
|
||||
return ours if ours.present?
|
||||
|
||||
calendar = Setting.respond_to?(:plugin_redmine_qbo_calendar) ? (Setting.plugin_redmine_qbo_calendar || {}) : {}
|
||||
calendar[calendar_key]
|
||||
rescue StandardError
|
||||
nil
|
||||
end
|
||||
|
||||
# A line matches a code if its QBO item name equals the code, or any part of a
|
||||
# "Category:Item" name does. Case-insensitive.
|
||||
def self.item_matches?(item_name, codes = item_codes)
|
||||
name = item_name.to_s.strip.downcase
|
||||
parts = name.split(':').map(&:strip)
|
||||
codes.map { |c| c.strip.downcase }.any? { |code| name == code || parts.include?(code) }
|
||||
end
|
||||
|
||||
# The estimate's labor hours: the quantities of its lines whose item matches an item code
|
||||
# (e.g. for an appointment's hours, which shouldn't be less)
|
||||
def self.labor_hours(estimate)
|
||||
return 0.0 if estimate.nil?
|
||||
|
||||
Array(estimate.line_items).sum do |line|
|
||||
detail = line.respond_to?(:sales_line_item_detail) ? line.sales_line_item_detail : nil
|
||||
next 0.0 if detail.nil? || detail.item_ref.nil? || !item_matches?(detail.item_ref.name)
|
||||
detail.quantity.to_f
|
||||
end
|
||||
end
|
||||
|
||||
# Relates every issue in the list to every other one ("Related to"), skipping pairs that already
|
||||
# have any relation. Used for issues created from the same estimate, whichever batch they came from.
|
||||
# Issues loaded fresh have no open journal, so this adds no history entries and sends no
|
||||
# "issue updated" emails. A failed relation (e.g. cross-project relations disabled) is logged, not fatal.
|
||||
# Returns the number of relations created.
|
||||
def self.relate_all(issues)
|
||||
issues = issues.compact.uniq(&:id)
|
||||
return 0 if issues.size < 2
|
||||
|
||||
ids = issues.map(&:id)
|
||||
already_related = IssueRelation.where(issue_from_id: ids, issue_to_id: ids)
|
||||
.pluck(:issue_from_id, :issue_to_id)
|
||||
.map(&:minmax)
|
||||
.to_set
|
||||
|
||||
issues.combination(2).count do |issue_from, issue_to|
|
||||
next false if already_related.include?([issue_from.id, issue_to.id].minmax)
|
||||
|
||||
relation = IssueRelation.new(issue_from: issue_from, issue_to: issue_to,
|
||||
relation_type: IssueRelation::TYPE_RELATES)
|
||||
next true if relation.save
|
||||
|
||||
Rails.logger.warn "[EstimateIssueBuilder] Could not relate ##{issue_from.id} and ##{issue_to.id}: " \
|
||||
"#{relation.errors.full_messages.join(', ')}"
|
||||
false
|
||||
end
|
||||
end
|
||||
|
||||
attr_reader :estimate, :defaults, :errors
|
||||
|
||||
# estimate: redmine_qbo's local Estimate (its QuickBooks details give the lines)
|
||||
# defaults: start_date, due_date, assignee, vehicle_id, description (from another plugin's hook)
|
||||
def initialize(estimate, defaults: {})
|
||||
@estimate = estimate
|
||||
@defaults = (defaults || {}).to_h.symbolize_keys
|
||||
@errors = []
|
||||
end
|
||||
|
||||
def proposals
|
||||
@proposals ||= build_proposals
|
||||
end
|
||||
|
||||
# rows: { line_id => { 'selected' => '1', 'subject' => ..., 'tracker_id' => ..., 'template' => 'global:3', 'estimated_hours' => ... } }
|
||||
# custom_field_values: { custom_field_id => value }, applied to every issue whose tracker uses the field
|
||||
# Returns the created issues, or [] with #errors filled in.
|
||||
def create_issues(project:, rows:, custom_field_values: {}, author: User.current)
|
||||
@errors = []
|
||||
rows = (rows || {}).to_h.transform_keys(&:to_s)
|
||||
|
||||
selected = proposals.reject(&:created?).select { |p| rows.dig(p.line_id, 'selected') == '1' }
|
||||
if selected.empty?
|
||||
@errors << l(:error_no_estimate_lines_selected)
|
||||
return []
|
||||
end
|
||||
|
||||
allowed_trackers = Issue.allowed_target_trackers(project, author).to_a
|
||||
|
||||
built = selected.map do |proposal|
|
||||
[proposal, build_issue(proposal, rows[proposal.line_id] || {}, project, author, allowed_trackers, custom_field_values)]
|
||||
end
|
||||
|
||||
Issue.transaction do
|
||||
built.each do |proposal, issue|
|
||||
next if issue.save
|
||||
|
||||
@errors << "#{proposal.description.truncate(60)}: #{issue.errors.full_messages.join(', ')}"
|
||||
end
|
||||
raise ActiveRecord::Rollback if @errors.any?
|
||||
|
||||
built.each do |proposal, issue|
|
||||
# Clear a link left behind by an issue that no longer exists, then record the new one
|
||||
QboEstimateLineIssue.where(estimate_id: estimate.id, line_id: proposal.line_id)
|
||||
.where.not(issue_id: Issue.select(:id)).delete_all
|
||||
QboEstimateLineIssue.create!(estimate_id: estimate.id, line_id: proposal.line_id, issue: issue)
|
||||
end
|
||||
|
||||
relate_issues(built.map(&:last))
|
||||
end
|
||||
|
||||
@errors.any? ? [] : built.map(&:last)
|
||||
rescue ActiveRecord::RecordNotUnique, ActiveRecord::RecordInvalid
|
||||
# Someone else created issues from the same lines at the same moment
|
||||
@errors << l(:error_estimate_lines_already_created)
|
||||
[]
|
||||
end
|
||||
|
||||
private
|
||||
|
||||
def build_proposals
|
||||
return [] if estimate.blank?
|
||||
|
||||
codes = self.class.item_codes
|
||||
links = QboEstimateLineIssue.where(estimate_id: estimate.id).includes(:issue).index_by(&:line_id)
|
||||
|
||||
Array(estimate.line_items).each_with_index.filter_map do |line, index|
|
||||
detail = line.respond_to?(:sales_line_item_detail) ? line.sales_line_item_detail : nil
|
||||
next if detail.nil? || detail.item_ref.nil?
|
||||
|
||||
item_name = detail.item_ref.name.to_s.strip
|
||||
next unless self.class.item_matches?(item_name, codes)
|
||||
|
||||
# The subject comes from the line's description, so lines without one are skipped
|
||||
description = line.description.to_s.strip
|
||||
next if description.blank?
|
||||
|
||||
line_id = line_key(line, index)
|
||||
quantity = detail.respond_to?(:quantity) ? detail.quantity.to_f : 0.0
|
||||
|
||||
Proposal.new(
|
||||
line_id: line_id,
|
||||
item_name: item_name,
|
||||
description: description,
|
||||
hours: quantity.positive? ? quantity : nil,
|
||||
existing_issue: links[line_id]&.issue
|
||||
)
|
||||
end
|
||||
end
|
||||
|
||||
# QBO line Ids are stable for the life of the estimate; fall back to line number / position
|
||||
def line_key(line, index)
|
||||
key = line.respond_to?(:id) ? line.id : nil
|
||||
key = line.line_num if key.blank? && line.respond_to?(:line_num)
|
||||
key = "pos-#{index}" if key.blank?
|
||||
key.to_s
|
||||
end
|
||||
|
||||
# Relates the new issues to each other and to every issue created earlier from the same estimate.
|
||||
def relate_issues(new_issues)
|
||||
earlier = QboEstimateLineIssue.where(estimate_id: estimate.id)
|
||||
.where.not(issue_id: new_issues.map(&:id))
|
||||
.includes(:issue)
|
||||
.filter_map(&:issue)
|
||||
self.class.relate_all(earlier + new_issues)
|
||||
end
|
||||
|
||||
def build_issue(proposal, row, project, author, allowed_trackers, custom_field_values)
|
||||
issue = Issue.new(project: project, author: author)
|
||||
issue.tracker = allowed_trackers.detect { |t| t.id == row['tracker_id'].to_i }
|
||||
|
||||
# Shared custom field values. Going through safe_attributes means fields the tracker doesn't
|
||||
# use, or that this user can't edit (hidden / read-only by workflow), are ignored.
|
||||
if custom_field_values.present? && issue.tracker
|
||||
issue.send(:safe_attributes=, { 'custom_field_values' => custom_field_values.to_h }, author)
|
||||
end
|
||||
issue.subject = (row['subject'].presence || proposal.description).to_s.strip.truncate(255)
|
||||
|
||||
template = IssueTemplateSupport.find(row['template'], project)
|
||||
issue.description = template&.description.presence || default_description
|
||||
|
||||
hours = row.key?('estimated_hours') ? row['estimated_hours'] : proposal.hours
|
||||
issue.estimated_hours = hours.presence
|
||||
|
||||
issue.start_date = defaults[:start_date] if defaults[:start_date]
|
||||
issue.due_date = defaults[:due_date] if defaults[:due_date]
|
||||
|
||||
# Only assign someone who can be assigned in this project
|
||||
assignee = defaults[:assignee]
|
||||
issue.assigned_to = assignee if assignee && issue.assignable_users.include?(assignee)
|
||||
|
||||
# Customer / vehicle / estimate fields are added to issues by redmine_qbo and redmine_qbo_vehicles
|
||||
issue.customer_id = estimate.customer_id if issue.respond_to?(:customer_id=)
|
||||
issue.vehicle_id = vehicle_id if issue.respond_to?(:vehicle_id=)
|
||||
issue.estimate_id = estimate.id if issue.respond_to?(:estimate_id=)
|
||||
|
||||
issue
|
||||
end
|
||||
|
||||
# The vehicle from the hook, or the customer's vehicle whose VIN is on the estimate
|
||||
def vehicle_id
|
||||
return defaults[:vehicle_id] if defaults[:vehicle_id].present?
|
||||
|
||||
customer = estimate.customer
|
||||
return nil unless customer.respond_to?(:vehicles)
|
||||
|
||||
vin = EstimateWriter.custom_value(estimate.details, Company.vin_field, Company::VIN_NAME).to_s.strip
|
||||
return nil if vin.empty?
|
||||
|
||||
customer.vehicles.detect { |v| v.vin.to_s.casecmp?(vin) }&.id
|
||||
rescue StandardError
|
||||
nil
|
||||
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}"
|
||||
end
|
||||
end
|
||||
end
|
||||
@@ -0,0 +1,423 @@
|
||||
#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
|
||||
# Reads QuickBooks estimates into an EstimateForm and writes forms back as estimates.
|
||||
#
|
||||
# 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.
|
||||
#
|
||||
# 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.
|
||||
module EstimateWriter
|
||||
class Error < StandardError; end
|
||||
|
||||
# The estimate was saved in QuickBooks (by someone else, or in another tab) after the form was opened
|
||||
class Conflict < Error; end
|
||||
|
||||
# How QuickBooks writes a subtotal line, e.g. "Subtotal: $1,342.60"
|
||||
SUBTOTAL_TEXT = /\ASubtotal:\s*-?\$?-?[\d,]*(\.\d+)?\s*\z/i
|
||||
|
||||
module_function
|
||||
|
||||
# A blank estimate for the customer, filled in the way QuickBooks starts a new estimate
|
||||
def new_form(customer: nil, user: User.current)
|
||||
EstimateForm.new(
|
||||
customer_id: customer&.id,
|
||||
customer_name: customer&.name,
|
||||
email: customer_email(customer),
|
||||
billing_address: customer_address(customer),
|
||||
txn_date: user.today.iso8601,
|
||||
expiration_date: default_expiration_date(user.today)&.iso8601,
|
||||
sales_person: user.name,
|
||||
customer_memo: Company.estimate_message,
|
||||
lines: Array.new(2) { EstimateForm::Line.new(quantity: '', taxable: true) }
|
||||
)
|
||||
end
|
||||
|
||||
# Creates an estimate for another plugin (e.g. redmine_qbo_lineitems billing an issue's line items), so
|
||||
# estimates are only ever built here. Each line is a hash of :description, :item_id, :quantity, :rate,
|
||||
# :taxable (a line with only a description is a note line). Returns the saved QuickBooks estimate.
|
||||
def create_estimate(customer:, lines:, private_note: nil, vin: nil, mileage: nil, user: nil, txn_date: Date.today)
|
||||
form = EstimateForm.new(
|
||||
customer_id: customer.id,
|
||||
customer_name: customer.name,
|
||||
email: customer_email(customer),
|
||||
txn_date: txn_date.iso8601,
|
||||
expiration_date: default_expiration_date(txn_date)&.iso8601,
|
||||
vin: vin.to_s,
|
||||
mileage: mileage.to_s,
|
||||
customer_memo: Company.estimate_message,
|
||||
private_note: private_note.to_s,
|
||||
lines: lines.map do |line|
|
||||
line = line.to_h.symbolize_keys
|
||||
EstimateForm::Line.new(
|
||||
item_id: line[:item_id]&.to_s.presence,
|
||||
description: line[:description].to_s,
|
||||
quantity: plain_number(line[:quantity]),
|
||||
rate: plain_number(line[:rate]),
|
||||
taxable: line.fetch(:taxable, true) ? true : false
|
||||
)
|
||||
end
|
||||
)
|
||||
save(form, user: user)
|
||||
end
|
||||
|
||||
# A new estimate copied from an existing one: same customer, lines, VIN and messages, dated today, with a
|
||||
# new number, the current user as sales person, and no discounts or bundles (those stay in QuickBooks)
|
||||
def duplicate_form(id, user: User.current)
|
||||
source = load(id)
|
||||
today = user.today
|
||||
EstimateForm.new(
|
||||
customer_id: source.customer_id,
|
||||
customer_name: source.customer_name,
|
||||
email: source.email,
|
||||
billing_address: source.billing_address,
|
||||
txn_date: today.iso8601,
|
||||
expiration_date: default_expiration_date(today)&.iso8601,
|
||||
sales_person: user.name,
|
||||
vin: source.vin,
|
||||
mileage: source.mileage,
|
||||
customer_memo: source.customer_memo,
|
||||
private_note: source.private_note,
|
||||
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,
|
||||
taxable: line.taxable)
|
||||
end
|
||||
).tap { |form| form.duplicated_from = source.doc_number }
|
||||
end
|
||||
|
||||
# Issues linked to the estimate (redmine_qbo's issue estimate field)
|
||||
def linked_issues(estimate_id)
|
||||
return Issue.none if estimate_id.blank?
|
||||
Issue.where(estimate_id: estimate_id.to_s)
|
||||
end
|
||||
|
||||
# Loads the estimate from QuickBooks for editing
|
||||
def load(id)
|
||||
remote = QboEstimateService.with_service { |service| service.fetch_by_id(id) }
|
||||
raise Error, I18n.t(:notice_estimate_not_found) unless remote
|
||||
form_from_remote(remote)
|
||||
end
|
||||
|
||||
# Creates or updates the estimate in QuickBooks and returns the saved QuickBooks estimate.
|
||||
# The sales person is the user who creates the estimate; editing keeps the original one.
|
||||
def save(form, user: User.current)
|
||||
customer = Customer.find_by(id: form.customer_id)
|
||||
raise Error, I18n.t(:error_estimate_needs_customer) unless customer
|
||||
|
||||
saved = QboEstimateService.with_service do |service|
|
||||
if form.persisted?
|
||||
remote = service.fetch_by_id(form.id)
|
||||
raise Error, I18n.t(:notice_estimate_not_found) unless remote
|
||||
raise Conflict, I18n.t(:error_estimate_changed_in_quickbooks) if remote.sync_token.to_s != form.sync_token.to_s
|
||||
raise Error, I18n.t(:error_estimate_has_bundles) if group_lines?(remote)
|
||||
raise Error, I18n.t(:error_estimate_linked_to_issues) if linked_issues(form.id).any?
|
||||
|
||||
estimate = Quickbooks::Model::Estimate.new
|
||||
estimate.id = remote.id
|
||||
estimate.sync_token = remote.sync_token
|
||||
apply(form, estimate, customer: customer, remote: remote, user: user)
|
||||
service.update(estimate, sparse: true)
|
||||
else
|
||||
estimate = Quickbooks::Model::Estimate.new
|
||||
apply(form, estimate, customer: customer, remote: nil, user: user)
|
||||
service.create(estimate)
|
||||
end
|
||||
end
|
||||
raise Error, I18n.t(:error_estimate_not_saved) unless saved
|
||||
|
||||
sync_local(saved)
|
||||
saved
|
||||
end
|
||||
|
||||
# Emails the estimate; QuickBooks uses its own estimate email template
|
||||
def send_email(id, email)
|
||||
sent = QboEstimateService.with_service { |service| service.send_estimate(id, email) }
|
||||
raise Error, I18n.t(:error_estimate_not_sent) unless sent
|
||||
sent
|
||||
end
|
||||
|
||||
# ---- QuickBooks estimate -> form ----
|
||||
|
||||
def form_from_remote(remote)
|
||||
EstimateForm.new(
|
||||
id: remote.id.to_s,
|
||||
sync_token: remote.sync_token.to_s,
|
||||
customer_id: remote.customer_ref&.value.to_s,
|
||||
customer_name: remote.customer_ref&.name.presence || Customer.find_by(id: remote.customer_ref&.value)&.name,
|
||||
email: remote.bill_email&.address.to_s,
|
||||
billing_address: format_address(remote.billing_address),
|
||||
txn_date: remote.txn_date&.iso8601,
|
||||
expiration_date: remote.expiration_date&.iso8601,
|
||||
doc_number: remote.doc_number.to_s,
|
||||
sales_person: custom_value(remote, Company.sales_person_field, Company::SALES_PERSON_NAME),
|
||||
vin: custom_value(remote, Company.vin_field, Company::VIN_NAME),
|
||||
mileage: custom_value(remote, Company.mileage_field, Company::MILEAGE_NAME),
|
||||
customer_memo: remote.customer_memo.to_s,
|
||||
private_note: remote.private_note.to_s,
|
||||
lines: tidy_subtotals(Array(remote.line_items).filter_map { |line| line_from_remote(line) }),
|
||||
total: remote.total,
|
||||
total_tax: remote.txn_tax_detail&.total_tax,
|
||||
discount: discount_total(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|
|
||||
[t.txn_id.to_s, InvoiceWriter.invoice_number(t.txn_id)]
|
||||
}.uniq,
|
||||
# Read-only when it has bundles, or once an issue is linked to it (the work is under way)
|
||||
locked: (:bundles if group_lines?(remote)) || (:linked if linked_issues(remote.id).any?)
|
||||
)
|
||||
end
|
||||
|
||||
def line_from_remote(line)
|
||||
if line.sales_item?
|
||||
detail = line.sales_line_item_detail
|
||||
EstimateForm::Line.new(
|
||||
id: line.id.to_s,
|
||||
item_id: detail&.item_ref&.value.to_s.presence,
|
||||
item_name: detail&.item_ref&.name.to_s,
|
||||
description: line.description.to_s,
|
||||
quantity: plain_number(detail&.quantity),
|
||||
rate: plain_number(detail&.unit_price),
|
||||
taxable: detail&.tax_code_ref&.value.to_s == 'TAX',
|
||||
time_activity_id: linked_time_activity_id(line)
|
||||
)
|
||||
elsif line.description_only? && line.description.to_s.strip.match?(SUBTOTAL_TEXT)
|
||||
EstimateForm::Line.new(id: line.id.to_s, kind: EstimateForm::Line::SUBTOTAL)
|
||||
elsif line.description_only?
|
||||
EstimateForm::Line.new(id: line.id.to_s, description: line.description.to_s)
|
||||
end
|
||||
# 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
|
||||
def custom_value(remote, field, name_pattern)
|
||||
fields = Array(remote.custom_fields)
|
||||
match = fields.detect { |f| field && f.id.to_i == field.id.to_i } ||
|
||||
fields.detect { |f| f.name.to_s =~ name_pattern && (name_pattern == Company::VIN_NAME || f.name.to_s !~ Company::VIN_NAME) }
|
||||
match&.string_value.to_s
|
||||
end
|
||||
|
||||
# ---- form -> QuickBooks estimate ----
|
||||
|
||||
def apply(form, estimate, customer:, remote:, user:)
|
||||
estimate.customer_id = customer.id
|
||||
# QuickBooks copies the customer's billing address only when an estimate is created
|
||||
if remote.nil? || remote.customer_ref&.value.to_s != customer.id.to_s
|
||||
address = customer_details(customer)&.billing_address
|
||||
estimate.billing_address = address if address
|
||||
end
|
||||
|
||||
estimate.bill_email = Quickbooks::Model::EmailAddress.new(form.email) if form.email.present?
|
||||
estimate.txn_date = form.txn_date_value
|
||||
estimate.expiration_date = form.expiration_date_value
|
||||
# Numbers aren't typed. With QuickBooks' custom transaction numbers on, it doesn't number estimates
|
||||
# made by apps, so the next number is filled in here.
|
||||
estimate.doc_number = next_doc_number if remote.nil? && Company.custom_txn_numbers?
|
||||
estimate.customer_memo = form.customer_memo.to_s
|
||||
estimate.private_note = form.private_note.to_s
|
||||
estimate.custom_fields = build_custom_fields(form, remote, user)
|
||||
estimate.line_items = build_lines(form, remote)
|
||||
estimate
|
||||
end
|
||||
|
||||
# Keeps every custom field already on the estimate, then sets the VIN, and the sales person on create
|
||||
# (left empty for estimates made without a user, e.g. by a background job)
|
||||
# sales_person: who to name instead of the user (e.g. an invoice names the estimate's sales person)
|
||||
def build_custom_fields(form, remote, user, sales_person: nil)
|
||||
fields = {}
|
||||
Array(remote&.custom_fields).each do |f|
|
||||
next unless f.type.to_s == 'StringType' || f.string_value.present?
|
||||
fields[f.id.to_i] = string_field(f.id, f.name, f.string_value)
|
||||
end
|
||||
|
||||
if (vin = Company.vin_field)
|
||||
fields[vin.id.to_i] = string_field(vin.id, vin.name, form.vin.to_s.strip.upcase)
|
||||
end
|
||||
|
||||
if (mileage = Company.mileage_field)
|
||||
fields[mileage.id.to_i] = string_field(mileage.id, mileage.name, form.mileage.to_s.strip)
|
||||
end
|
||||
|
||||
sales = Company.sales_person_field
|
||||
name = sales_person.presence || user&.name
|
||||
if sales && remote.nil? && name.present?
|
||||
fields[sales.id.to_i] = string_field(sales.id, sales.name, name)
|
||||
end
|
||||
|
||||
fields.values
|
||||
end
|
||||
|
||||
def string_field(id, name, value)
|
||||
field = Quickbooks::Model::CustomField.new
|
||||
field.id = id.to_i
|
||||
field.name = name
|
||||
field.type = 'StringType'
|
||||
field.string_value = value.to_s
|
||||
field
|
||||
end
|
||||
|
||||
def build_lines(form, remote)
|
||||
remote_ids = Array(remote&.line_items).map { |l| l.id.to_s }
|
||||
section = BigDecimal('0')
|
||||
lines = tidy_subtotals(form.filled_lines).map.with_index(1) do |line, number|
|
||||
built = build_line(line, number, keep_id: remote_ids.include?(line.id.to_s), section_total: section)
|
||||
section = line.subtotal? ? BigDecimal('0') : section + (line.description_only? ? BigDecimal('0') : built.amount)
|
||||
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
|
||||
lines
|
||||
end
|
||||
|
||||
def build_line(line, number, keep_id:, section_total: BigDecimal('0'))
|
||||
remote = Quickbooks::Model::InvoiceLineItem.new
|
||||
remote.id = line.id if keep_id
|
||||
remote.line_num = number
|
||||
|
||||
# Saved like QuickBooks saves its subtotals: a description line with the total of its section
|
||||
if line.subtotal?
|
||||
remote.description = subtotal_text(section_total)
|
||||
remote.description_only!
|
||||
return remote
|
||||
end
|
||||
|
||||
remote.description = line.description
|
||||
|
||||
if line.description_only?
|
||||
remote.description_only!
|
||||
return remote
|
||||
end
|
||||
|
||||
rate = line.rate_value
|
||||
rate ||= Item.find_by(id: line.item_id)&.unit_price if line.item?
|
||||
rate ||= BigDecimal('0')
|
||||
quantity = line.quantity_value || BigDecimal('1')
|
||||
|
||||
remote.amount = (quantity * rate).round(2)
|
||||
link_time_activity(remote, line.time_activity_id)
|
||||
remote.sales_item! do |detail|
|
||||
detail.item_ref = Quickbooks::Model::BaseReference.new(line.item_id) if line.item?
|
||||
detail.quantity = quantity
|
||||
detail.unit_price = rate
|
||||
detail.tax_code_ref = Quickbooks::Model::BaseReference.new(line.taxable? ? 'TAX' : 'NON')
|
||||
end
|
||||
remote
|
||||
end
|
||||
|
||||
# ---- helpers ----
|
||||
|
||||
TIME_ACTIVITY = 'TimeActivity'.freeze
|
||||
|
||||
# The time activity an invoice line bills, if any
|
||||
def linked_time_activity_id(line)
|
||||
return nil unless line.respond_to?(:linked_transactions)
|
||||
Array(line.linked_transactions).detect { |t| t.txn_type.to_s == TIME_ACTIVITY }&.txn_id&.to_s
|
||||
end
|
||||
|
||||
# Links an invoice line to the time activity it bills (TxnLineId is always 1 for time activities)
|
||||
def link_time_activity(remote_line, time_activity_id)
|
||||
return if time_activity_id.blank? || !remote_line.respond_to?(:linked_transactions=)
|
||||
remote_line.linked_transactions = [
|
||||
Quickbooks::Model::LinkedTransaction.new(txn_id: time_activity_id.to_s, txn_type: TIME_ACTIVITY, txn_line_id: '1')
|
||||
]
|
||||
end
|
||||
|
||||
# Drops subtotals with nothing to total (at the top, or right after another subtotal)
|
||||
def tidy_subtotals(lines)
|
||||
tidy = []
|
||||
lines.each do |line|
|
||||
next if line.subtotal? && (tidy.empty? || tidy.last.subtotal?)
|
||||
tidy << line
|
||||
end
|
||||
tidy
|
||||
end
|
||||
|
||||
# "Subtotal: $1,342.60", as QuickBooks writes it
|
||||
def subtotal_text(amount)
|
||||
value = BigDecimal(amount.to_s).round(2)
|
||||
whole, cents = format('%.2f', value.abs).split('.')
|
||||
"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
|
||||
def discount_total(remote)
|
||||
discounts = Array(remote.line_items).select(&:discount_item?)
|
||||
discounts.empty? ? nil : discounts.sum(BigDecimal('0')) { |l| l.amount || BigDecimal('0') }
|
||||
end
|
||||
|
||||
def group_lines?(remote)
|
||||
Array(remote.line_items).any?(&:group_line_detail?)
|
||||
end
|
||||
|
||||
# Updates the local estimate record so it shows on the customer page right away
|
||||
def sync_local(saved)
|
||||
EstimateSyncService.new.sync_by_id(saved.id)
|
||||
rescue StandardError => e
|
||||
Rails.logger.warn "[RedmineQboBilling] Saved estimate #{saved.id} but could not sync it locally: #{e.message}"
|
||||
end
|
||||
|
||||
# The plugin setting "Estimates expire after (days)"; blank or 0 leaves the expiration date empty
|
||||
def expiration_days
|
||||
Setting.plugin_redmine_qbo['expiration_days'].to_i
|
||||
rescue StandardError
|
||||
0
|
||||
end
|
||||
|
||||
def default_expiration_date(from)
|
||||
expiration_days.positive? ? from + expiration_days : nil
|
||||
end
|
||||
|
||||
# One more than the highest estimate (or invoice) number used so far
|
||||
def next_doc_number(model = Estimate)
|
||||
numbers = model.order(id: :desc).limit(500).pluck(:doc_number).filter_map { |n| Integer(n.to_s, 10) rescue nil }
|
||||
numbers.empty? ? nil : (numbers.max + 1).to_s
|
||||
end
|
||||
|
||||
def customer_details(customer)
|
||||
customer&.details
|
||||
rescue StandardError => e
|
||||
Rails.logger.warn "[RedmineQboBilling] Could not load customer #{customer&.id} from QuickBooks: #{e.message}"
|
||||
nil
|
||||
end
|
||||
|
||||
def customer_email(customer)
|
||||
customer_details(customer)&.email_address&.address.to_s
|
||||
end
|
||||
|
||||
def customer_address(customer)
|
||||
format_address(customer_details(customer)&.billing_address)
|
||||
end
|
||||
|
||||
# Address lines as QuickBooks prints them: street lines, then "City, ST 12345"
|
||||
def format_address(address)
|
||||
return '' unless address
|
||||
|
||||
street = [address.line1, address.line2, address.line3, address.line4, address.line5].map { |l| l.to_s.strip }.reject(&:empty?)
|
||||
region = [address.country_sub_division_code, address.postal_code].map { |l| l.to_s.strip }.reject(&:empty?).join(' ')
|
||||
locality = [address.city.to_s.strip, region].reject(&:empty?).join(', ')
|
||||
(street + [locality]).reject(&:empty?).join("\n")
|
||||
end
|
||||
|
||||
# 2.0 -> "2", 12.50 -> "12.5"; the editor formats rates for display
|
||||
def plain_number(value)
|
||||
return '' if value.nil? || value.to_s.strip.empty?
|
||||
BigDecimal(value.to_s).to_s('F').sub(/\.0+\z/, '').sub(/(\.\d*?)0+\z/, '\1')
|
||||
end
|
||||
end
|
||||
end
|
||||
@@ -0,0 +1,32 @@
|
||||
#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
|
||||
module Hooks
|
||||
|
||||
# Each work order's mileage, from Redmine's own issue custom field named "Mileage" (any capitalisation),
|
||||
# so an invoice's mileage box fills in when its time or estimates are imported. Answers the same
|
||||
# qbo_billing_issue_values hook other plugins use (see IssueValues).
|
||||
class IssueMileageListener < Redmine::Hook::Listener
|
||||
|
||||
def qbo_billing_issue_values(context = {})
|
||||
issue_ids = Array(context[:issues]).map(&:id)
|
||||
field = IssueCustomField.all.detect { |f| f.name.to_s.strip.casecmp?('mileage') }
|
||||
return {} if field.nil? || issue_ids.empty?
|
||||
|
||||
values = CustomValue.where(customized_type: 'Issue', customized_id: issue_ids, custom_field_id: field.id)
|
||||
.where.not(value: [nil, ''])
|
||||
.pluck(:customized_id, :value)
|
||||
{ mileage: values.to_h }
|
||||
end
|
||||
|
||||
end
|
||||
end
|
||||
end
|
||||
@@ -0,0 +1,29 @@
|
||||
#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
|
||||
module Hooks
|
||||
|
||||
# Adds the product/service list and income accounts to redmine_qbo's syncs
|
||||
class QboHookListener < Redmine::Hook::Listener
|
||||
|
||||
# Called by WebhookProcessJob
|
||||
def qbo_additional_entities(context = {})
|
||||
["Item", "Account"]
|
||||
end
|
||||
|
||||
# Called by the QboSyncDispatcher. Accounts first: items reference their income account.
|
||||
def qbo_full_sync(context = {})
|
||||
[Account, Item]
|
||||
end
|
||||
|
||||
end
|
||||
end
|
||||
end
|
||||
@@ -0,0 +1,401 @@
|
||||
#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
|
||||
# Reads QuickBooks invoices into an EstimateForm (document "invoice") and writes forms back as invoices.
|
||||
# Lines, subtotals, discounts, custom fields and addresses work exactly as on estimates (EstimateWriter).
|
||||
#
|
||||
# On top of that an invoice can take lines from elsewhere:
|
||||
# * an estimate converted to an invoice, or open estimates imported into it (e.g. the ones
|
||||
# redmine_qbo_lineitems makes for parts that weren't quoted). Those estimates are linked to the invoice
|
||||
# and closed when it's saved.
|
||||
# * 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.
|
||||
module InvoiceWriter
|
||||
Error = EstimateWriter::Error
|
||||
Conflict = EstimateWriter::Conflict
|
||||
|
||||
ESTIMATE = 'Estimate'.freeze
|
||||
TIME_ACTIVITY = EstimateWriter::TIME_ACTIVITY
|
||||
# Estimates in these states can still be imported (Converted/Closed ones are already invoiced, Rejected ones lost)
|
||||
OPEN_ESTIMATE_STATUSES = ['', 'Pending', 'Accepted'].freeze
|
||||
# How QuickBooks marks an invoiced estimate: Converted when it made the invoice, Closed when closed by hand
|
||||
BILLED_ESTIMATE_STATUSES = %w[Converted Closed].freeze
|
||||
# How far back to look for billable time if QuickBooks won't filter time activities by customer
|
||||
TIME_LOOKBACK = 400
|
||||
|
||||
module_function
|
||||
|
||||
def writer
|
||||
EstimateWriter
|
||||
end
|
||||
|
||||
# The plugin setting "Replaced by imported time": only lines with these products/services are offered
|
||||
# under Replace these lines when time is imported (e.g. an estimate's Labor lines); empty offers every line
|
||||
def replaceable_item_ids
|
||||
Array(Setting.plugin_redmine_qbo['replaceable_item_ids']).map(&:to_s).reject(&:blank?).uniq
|
||||
rescue StandardError
|
||||
[]
|
||||
end
|
||||
|
||||
# A blank invoice for the customer, dated today
|
||||
def new_form(customer: nil, user: User.current)
|
||||
EstimateForm.new(
|
||||
document: 'invoice',
|
||||
customer_id: customer&.id,
|
||||
customer_name: customer&.name,
|
||||
email: writer.customer_email(customer),
|
||||
billing_address: writer.customer_address(customer),
|
||||
txn_date: user.today.iso8601,
|
||||
sales_person: user.name,
|
||||
customer_memo: Company.invoice_message,
|
||||
lines: Array.new(2) { EstimateForm::Line.new(quantity: '', taxable: true) }
|
||||
)
|
||||
end
|
||||
|
||||
# A new invoice from an estimate, like QuickBooks' "Create invoice" on an estimate: the estimate's
|
||||
# customer, lines, subtotals and VIN. The estimate is linked and closed when the invoice is saved.
|
||||
def from_estimate(estimate_id, user: User.current)
|
||||
remote = QboEstimateService.with_service { |service| service.fetch_by_id(estimate_id) }
|
||||
raise Error, I18n.t(:notice_estimate_not_found) unless remote
|
||||
# An estimate is billed once
|
||||
billed = billing_error(remote)
|
||||
raise Error, billed if billed
|
||||
|
||||
source = writer.form_from_remote(remote)
|
||||
customer = Customer.find_by(id: source.customer_id)
|
||||
new_form(customer: customer, user: user).tap do |form|
|
||||
form.customer_name = source.customer_name if customer.nil?
|
||||
form.customer_id = source.customer_id
|
||||
form.email = source.email.presence || form.email
|
||||
form.billing_address = source.billing_address.presence || form.billing_address
|
||||
form.vin = source.vin
|
||||
form.mileage = source.mileage
|
||||
# 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.lines = copy_lines(source.lines)
|
||||
form.linked_estimate_ids = [source.id.to_s]
|
||||
form.converted_from = source.doc_number
|
||||
end
|
||||
end
|
||||
|
||||
def load(id)
|
||||
remote = QboInvoiceService.with_service { |service| service.fetch_by_id(id) }
|
||||
raise Error, I18n.t(:notice_invoice_not_found) unless remote
|
||||
form_from_remote(remote)
|
||||
end
|
||||
|
||||
# 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)
|
||||
customer = Customer.find_by(id: form.customer_id)
|
||||
raise Error, I18n.t(:error_estimate_needs_customer) unless customer
|
||||
|
||||
saved = QboInvoiceService.with_service do |service|
|
||||
if form.persisted?
|
||||
remote = service.fetch_by_id(form.id)
|
||||
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_not_billed(form.linked_estimate_ids - linked_ids(remote, ESTIMATE))
|
||||
|
||||
invoice = Quickbooks::Model::Invoice.new
|
||||
invoice.id = remote.id
|
||||
invoice.sync_token = remote.sync_token
|
||||
apply(form, invoice, customer: customer, remote: remote, user: user)
|
||||
service.update(invoice, sparse: true)
|
||||
else
|
||||
check_not_billed(form.linked_estimate_ids)
|
||||
invoice = Quickbooks::Model::Invoice.new
|
||||
apply(form, invoice, customer: customer, remote: nil, user: user,
|
||||
sales_person: estimate_sales_person(form.linked_estimate_ids))
|
||||
service.create(invoice)
|
||||
end
|
||||
end
|
||||
raise Error, I18n.t(:error_invoice_not_saved) unless saved
|
||||
|
||||
sync_local(saved)
|
||||
close_estimates(linked_ids(saved, ESTIMATE).presence || form.linked_estimate_ids)
|
||||
saved
|
||||
end
|
||||
|
||||
def send_email(id, email)
|
||||
sent = QboInvoiceService.with_service { |service| service.send_invoice(id, email) }
|
||||
raise Error, I18n.t(:error_invoice_not_sent) unless sent
|
||||
sent
|
||||
end
|
||||
|
||||
# ---- QuickBooks invoice -> form ----
|
||||
|
||||
def form_from_remote(remote)
|
||||
EstimateForm.new(
|
||||
document: 'invoice',
|
||||
id: remote.id.to_s,
|
||||
sync_token: remote.sync_token.to_s,
|
||||
customer_id: remote.customer_ref&.value.to_s,
|
||||
customer_name: remote.customer_ref&.name.presence || Customer.find_by(id: remote.customer_ref&.value)&.name,
|
||||
email: remote.bill_email&.address.to_s,
|
||||
billing_address: writer.format_address(remote.billing_address),
|
||||
txn_date: remote.txn_date&.iso8601,
|
||||
due_date: remote.due_date&.iso8601,
|
||||
doc_number: remote.doc_number.to_s,
|
||||
sales_person: writer.custom_value(remote, Company.sales_person_field, Company::SALES_PERSON_NAME),
|
||||
vin: writer.custom_value(remote, Company.vin_field, Company::VIN_NAME),
|
||||
mileage: writer.custom_value(remote, Company.mileage_field, Company::MILEAGE_NAME),
|
||||
customer_memo: remote.customer_memo.to_s,
|
||||
private_note: remote.private_note.to_s,
|
||||
lines: writer.tidy_subtotals(Array(remote.line_items).filter_map { |line| writer.line_from_remote(line) }),
|
||||
linked_estimate_ids: linked_ids(remote, ESTIMATE),
|
||||
total: remote.total,
|
||||
total_tax: remote.txn_tax_detail&.total_tax,
|
||||
discount: writer.discount_total(remote),
|
||||
balance: remote.balance,
|
||||
email_status: remote.email_status.to_s,
|
||||
locked: (:bundles if writer.group_lines?(remote)) || (:paid if paid?(remote))
|
||||
)
|
||||
end
|
||||
|
||||
# A payment is applied once the balance is less than the total
|
||||
def paid?(remote)
|
||||
return false if remote.balance.nil? || remote.total.nil?
|
||||
BigDecimal(remote.balance.to_s) < BigDecimal(remote.total.to_s)
|
||||
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
|
||||
|
||||
# ---- form -> QuickBooks invoice ----
|
||||
|
||||
def apply(form, invoice, customer:, remote:, user:, sales_person: nil)
|
||||
invoice.customer_id = customer.id
|
||||
if remote.nil? || remote.customer_ref&.value.to_s != customer.id.to_s
|
||||
address = writer.customer_details(customer)&.billing_address
|
||||
invoice.billing_address = address if address
|
||||
end
|
||||
|
||||
invoice.bill_email = Quickbooks::Model::EmailAddress.new(form.email) if form.email.present?
|
||||
invoice.txn_date = form.txn_date_value
|
||||
# Left out when empty: QuickBooks works it out from the customer's terms
|
||||
invoice.due_date = form.due_date_value if form.due_date_value
|
||||
invoice.doc_number = writer.next_doc_number(Invoice) if remote.nil? && Company.custom_txn_numbers?
|
||||
invoice.customer_memo = form.customer_memo.to_s
|
||||
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)
|
||||
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)
|
||||
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) }
|
||||
end
|
||||
|
||||
def link(id, type)
|
||||
Quickbooks::Model::LinkedTransaction.new(txn_id: id.to_s, txn_type: type)
|
||||
end
|
||||
|
||||
# The sales person on the first of the estimates that names one (estimates redmine_qbo_lineitems makes
|
||||
# have none), so the invoice credits whoever wrote the estimate
|
||||
def estimate_sales_person(estimate_ids)
|
||||
field = Company.sales_person_field
|
||||
return nil if field.nil? || Array(estimate_ids).empty?
|
||||
|
||||
QboEstimateService.with_service do |service|
|
||||
Array(estimate_ids).each do |id|
|
||||
estimate = service.fetch_by_id(id)
|
||||
name = estimate && writer.custom_value(estimate, field, Company::SALES_PERSON_NAME)
|
||||
return name if name.present?
|
||||
end
|
||||
nil
|
||||
end
|
||||
rescue StandardError => e
|
||||
Rails.logger.warn "[RedmineQboBilling] Could not read the estimate's sales person: #{e.message}"
|
||||
nil
|
||||
end
|
||||
|
||||
# ---- billing an estimate once ----
|
||||
|
||||
# Why the estimate can't be billed, or nil: it's already on an invoice (linked to one, or closed, which is
|
||||
# how QuickBooks marks an invoiced estimate), or the customer rejected it
|
||||
def billing_error(estimate)
|
||||
number = estimate.doc_number.to_s
|
||||
invoice_id = linked_ids(estimate, 'Invoice').first
|
||||
if invoice_id
|
||||
I18n.t(:error_estimate_already_invoiced, number: number, invoice: invoice_number(invoice_id))
|
||||
elsif BILLED_ESTIMATE_STATUSES.include?(estimate.txn_status.to_s)
|
||||
I18n.t(:error_estimate_closed_billed, number: number, status: estimate.txn_status.to_s)
|
||||
elsif estimate.txn_status.to_s == 'Rejected'
|
||||
I18n.t(:error_estimate_rejected, number: number)
|
||||
end
|
||||
end
|
||||
|
||||
# Checked against QuickBooks when saving, since an estimate can be invoiced elsewhere (another tab, another
|
||||
# user, QuickBooks itself) after the invoice page was opened. Estimates already on this invoice aren't checked.
|
||||
def check_not_billed(estimate_ids)
|
||||
ids = Array(estimate_ids).map(&:to_s).reject(&:blank?).uniq
|
||||
return if ids.empty?
|
||||
|
||||
errors = QboEstimateService.with_service do |service|
|
||||
ids.filter_map do |id|
|
||||
estimate = service.fetch_by_id(id)
|
||||
estimate ? billing_error(estimate) : I18n.t(:notice_estimate_not_found)
|
||||
end
|
||||
end
|
||||
raise Error, errors.join(' ') if errors.any?
|
||||
end
|
||||
|
||||
# The invoice's number when it's synced locally, else its QuickBooks id
|
||||
def invoice_number(invoice_id)
|
||||
Invoice.find_by(id: invoice_id)&.doc_number.presence || invoice_id.to_s
|
||||
rescue StandardError
|
||||
invoice_id.to_s
|
||||
end
|
||||
|
||||
# Marks the estimates as closed (invoiced), as QuickBooks does when it converts one. Done separately
|
||||
# so it also happens if QuickBooks doesn't close a linked estimate by itself.
|
||||
def close_estimates(ids)
|
||||
Array(ids).uniq.each do |id|
|
||||
QboEstimateService.with_service do |service|
|
||||
estimate = service.fetch_by_id(id)
|
||||
# Already Converted or Closed is left as QuickBooks set it
|
||||
next if estimate.nil? || BILLED_ESTIMATE_STATUSES.include?(estimate.txn_status.to_s)
|
||||
|
||||
update = Quickbooks::Model::Estimate.new
|
||||
update.id = estimate.id
|
||||
update.sync_token = estimate.sync_token
|
||||
update.customer_ref = estimate.customer_ref
|
||||
update.txn_status = 'Closed'
|
||||
service.update(update, sparse: true)
|
||||
end
|
||||
EstimateSyncService.new.sync_by_id(id)
|
||||
rescue StandardError => e
|
||||
Rails.logger.warn "[RedmineQboBilling] Could not close estimate #{id}: #{e.message}"
|
||||
end
|
||||
end
|
||||
|
||||
# ---- importing ----
|
||||
|
||||
# What can be pulled into an invoice for the customer: billable time and open estimates, and the VIN and
|
||||
# mileage plugins give for their work orders (and for issues already on the invoice: issue_ids)
|
||||
def import_options(customer, issue_ids: [])
|
||||
times = open_time_activities(customer)
|
||||
estimates = open_estimates(customer)
|
||||
ids = (times.map { |t| t[:issue_id] } + estimates.map { |e| e[:issue_id] } + Array(issue_ids)).compact.map(&:to_s).uniq
|
||||
issues = ids.empty? ? [] : Issue.where(id: ids).to_a
|
||||
{ time_activities: times, estimates: estimates, issue_values: IssueValues.by_issue(issues) }
|
||||
end
|
||||
|
||||
# The customer's QuickBooks time activities that are still billable (not yet on an invoice)
|
||||
def open_time_activities(customer)
|
||||
activities = QboConnectionService.with_qbo_service(entity: 'TimeActivity') do |service|
|
||||
begin
|
||||
service.query("SELECT * FROM TimeActivity WHERE CustomerRef = '#{customer.id.to_i}' ORDERBY TxnDate", per_page: 1000).entries
|
||||
rescue StandardError
|
||||
# Not every company lets time be filtered by customer: look at recent time instead
|
||||
since = (Date.today - TIME_LOOKBACK).iso8601
|
||||
service.query("SELECT * FROM TimeActivity WHERE TxnDate >= '#{since}' ORDERBY TxnDate", per_page: 1000).entries
|
||||
end
|
||||
end
|
||||
|
||||
Array(activities).select { |a| a.customer_ref&.value.to_s == customer.id.to_s && a.billable_status.to_s == 'Billable' }
|
||||
.map { |a| time_activity_hash(a) }
|
||||
end
|
||||
|
||||
def time_activity_hash(activity)
|
||||
hours = activity_hours(activity)
|
||||
rate = EstimateForm.decimal(activity.hourly_rate) || BigDecimal('0')
|
||||
item = Item.find_by(id: activity.item_ref&.value) if activity.item_ref&.value.present?
|
||||
{
|
||||
id: activity.id.to_s,
|
||||
date: activity.txn_date.to_s,
|
||||
employee: activity.employee_ref&.name || activity.vendor_ref&.name,
|
||||
item_id: activity.item_ref&.value.to_s.presence,
|
||||
item_name: activity.item_ref&.name.presence || item&.name,
|
||||
description: activity.description.to_s,
|
||||
issue_id: issue_reference(activity.description),
|
||||
quantity: writer.plain_number(hours),
|
||||
rate: writer.plain_number(rate),
|
||||
amount: (hours * rate).round(2).to_s('F'),
|
||||
taxable: item ? item.taxable != false : false
|
||||
}
|
||||
end
|
||||
|
||||
# Hours and minutes, or start and end time less the break
|
||||
def activity_hours(activity)
|
||||
if activity.hours || activity.minutes
|
||||
(BigDecimal(activity.hours.to_i.to_s) + BigDecimal(activity.minutes.to_i.to_s) / 60).round(4)
|
||||
elsif activity.start_time && activity.end_time
|
||||
minutes = ((activity.end_time.to_time - activity.start_time.to_time) / 60).round -
|
||||
(activity.break_hours.to_i * 60 + activity.break_minutes.to_i)
|
||||
(BigDecimal([minutes, 0].max.to_s) / 60).round(4)
|
||||
else
|
||||
BigDecimal('0')
|
||||
end
|
||||
end
|
||||
|
||||
# The customer's open estimates, each with its lines ready to add to an invoice
|
||||
def open_estimates(customer)
|
||||
estimates = QboEstimateService.with_service do |service|
|
||||
service.query("SELECT * FROM Estimate WHERE CustomerRef = '#{customer.id.to_i}' ORDERBY TxnDate DESC", per_page: 100).entries
|
||||
end
|
||||
|
||||
Array(estimates).select { |e| billing_error(e).nil? && OPEN_ESTIMATE_STATUSES.include?(e.txn_status.to_s) && !writer.group_lines?(e) }.map do |e|
|
||||
lines = writer.tidy_subtotals(Array(e.line_items).filter_map { |line| writer.line_from_remote(line) })
|
||||
linked_issue = writer.linked_issues(e.id).first
|
||||
{
|
||||
id: e.id.to_s,
|
||||
doc_number: e.doc_number.to_s,
|
||||
date: e.txn_date.to_s,
|
||||
total: e.total.to_s,
|
||||
issue: linked_issue&.then { |i| "#{i.tracker} ##{i.id}: #{i.subject}" },
|
||||
# Lines from this estimate go next to the invoice's time for the same issue
|
||||
issue_id: issue_reference(lines.detect { |l| l.description.present? }&.description) || linked_issue&.id&.to_s,
|
||||
lines: lines.map { |l| line_hash(l) }
|
||||
}
|
||||
end
|
||||
end
|
||||
|
||||
def issue_reference(text)
|
||||
IssueValues.issue_reference(text)
|
||||
end
|
||||
|
||||
def line_hash(line)
|
||||
{ kind: line.kind, item_id: line.item_id, item_name: line.item_name, description: line.description,
|
||||
quantity: line.quantity, rate: line.rate, taxable: line.taxable? }
|
||||
end
|
||||
|
||||
# ---- helpers ----
|
||||
|
||||
# Lines copied to a new document: no line ids, everything else as it was
|
||||
def copy_lines(lines)
|
||||
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,
|
||||
taxable: line.taxable, time_activity_id: line.time_activity_id)
|
||||
end
|
||||
end
|
||||
|
||||
def sync_local(saved)
|
||||
InvoiceSyncService.new.sync_by_id(saved.id)
|
||||
rescue StandardError => e
|
||||
Rails.logger.warn "[RedmineQboBilling] Saved invoice #{saved.id} but could not sync it locally: #{e.message}"
|
||||
end
|
||||
end
|
||||
end
|
||||
@@ -0,0 +1,72 @@
|
||||
#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 issue custom fields shown on the "Create issues from estimate" page.
|
||||
#
|
||||
# For every tracker the user may pick, a sample new issue is built in the target project to find
|
||||
# which custom fields the user can edit, and which are required (either the field's own
|
||||
# "Required" flag or a workflow rule for that tracker / role). Values are entered once on the page
|
||||
# and applied to every created issue whose tracker uses that field.
|
||||
class IssueFieldSet
|
||||
# File uploads can't be handled by this shared form
|
||||
UNSUPPORTED_FORMATS = %w[attachment].freeze
|
||||
|
||||
Field = Struct.new(:custom_field, :custom_value, :tracker_ids, :required_tracker_ids, keyword_init: true) do
|
||||
def id
|
||||
custom_field.id
|
||||
end
|
||||
|
||||
def required_for_any?
|
||||
required_tracker_ids.any?
|
||||
end
|
||||
end
|
||||
|
||||
attr_reader :fields
|
||||
|
||||
# values: the submitted { custom_field_id => value } hash, used to refill the form after errors
|
||||
def initialize(project:, trackers:, user: User.current, values: {})
|
||||
@fields = []
|
||||
by_id = {}
|
||||
|
||||
Array(trackers).each do |tracker|
|
||||
issue = Issue.new(project: project, author: user)
|
||||
issue.tracker = tracker
|
||||
|
||||
issue.editable_custom_field_values(user).each do |custom_value|
|
||||
custom_field = custom_value.custom_field
|
||||
next if UNSUPPORTED_FORMATS.include?(custom_field.field_format)
|
||||
|
||||
field = by_id[custom_field.id] ||= Field.new(
|
||||
custom_field: custom_field,
|
||||
custom_value: custom_value,
|
||||
tracker_ids: [],
|
||||
required_tracker_ids: []
|
||||
)
|
||||
field.tracker_ids << tracker.id
|
||||
if custom_field.is_required? || issue.required_attribute?(custom_field.id.to_s, user)
|
||||
field.required_tracker_ids << tracker.id
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
@fields = by_id.values.sort_by { |f| [f.required_for_any? ? 0 : 1, f.custom_field.position.to_i] }
|
||||
|
||||
values = (values || {}).to_h.transform_keys(&:to_s)
|
||||
@fields.each do |field|
|
||||
field.custom_value.value = values[field.id.to_s] if values.key?(field.id.to_s)
|
||||
end
|
||||
end
|
||||
|
||||
def any?
|
||||
@fields.any?
|
||||
end
|
||||
end
|
||||
end
|
||||
@@ -0,0 +1,58 @@
|
||||
#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
|
||||
# Optional support for redmine_issue_templates (https://github.com/agileware-jp/redmine_issue_templates).
|
||||
# Everything here returns empty results when that plugin isn't installed or isn't enabled on the project.
|
||||
module IssueTemplateSupport
|
||||
Option = Struct.new(:key, :title, :tracker_id, :is_default, :description, :group, keyword_init: true)
|
||||
|
||||
module_function
|
||||
|
||||
def installed?
|
||||
defined?(::IssueTemplate) && defined?(::GlobalIssueTemplate) && defined?(::IssueTemplateSetting)
|
||||
end
|
||||
|
||||
def enabled_for?(project)
|
||||
!!(installed? && project&.module_enabled?(:issue_templates))
|
||||
end
|
||||
|
||||
# Templates usable in the project: its own, those shared by parent projects, and global ones.
|
||||
def templates_for(project)
|
||||
return [] unless enabled_for?(project)
|
||||
|
||||
own = ::IssueTemplate.get_templates_for_project_tracker(project.id).to_a
|
||||
inherited = Array(::IssueTemplateSetting.find_or_create(project.id).get_inherit_templates).to_a
|
||||
global = ::GlobalIssueTemplate.get_templates_for_project_tracker(project.id).to_a
|
||||
|
||||
(own + inherited).uniq.map { |t| option('project', t) } + global.map { |t| option('global', t) }
|
||||
rescue StandardError => e
|
||||
Rails.logger.warn "[IssueTemplateSupport] Could not load templates: #{e.class}: #{e.message}"
|
||||
[]
|
||||
end
|
||||
|
||||
def find(key, project)
|
||||
return nil if key.blank?
|
||||
|
||||
templates_for(project).detect { |t| t.key == key }
|
||||
end
|
||||
|
||||
def option(group, template)
|
||||
Option.new(
|
||||
key: "#{group}:#{template.id}",
|
||||
title: template.title,
|
||||
tracker_id: template.tracker_id,
|
||||
is_default: template.is_default?,
|
||||
description: template.description,
|
||||
group: group
|
||||
)
|
||||
end
|
||||
end
|
||||
end
|
||||
@@ -0,0 +1,84 @@
|
||||
#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 work orders (Redmine issues) behind an estimate or invoice, and the two hooks other plugins use with
|
||||
# them:
|
||||
#
|
||||
# :qbo_billing_issue_values, { issues: [Issue, ...] }
|
||||
# Return a hash of field => { issue_id => value }, e.g. redmine_qbo_vehicles returns
|
||||
# { vin: { 116 => "1C4HJXDG5JW123456" } }. This plugin answers it too with { mileage: ... } from the
|
||||
# issue custom field named "Mileage" (Hooks::IssueMileageListener).
|
||||
# The invoice's VIN and mileage boxes are filled from them when time or estimates are imported.
|
||||
#
|
||||
# :qbo_billing_validate, { document: "invoice" or "estimate", form: EstimateForm, issues: [Issue, ...] }
|
||||
# Return an error message (or a list of them) to stop the save, e.g. redmine_qbo_vehicles refuses an
|
||||
# invoice whose work orders are for more than one vehicle. Return nil to allow it.
|
||||
module IssueValues
|
||||
# The issue a line came from: redmine_qbo writes "Install #116: some job" on time activities, and
|
||||
# redmine_qbo_lineitems starts its estimates with "Added from: Install #116: some job"
|
||||
ISSUE_REFERENCE = /#(\d+):/
|
||||
ADDED_FROM = /\A\s*Added from:/i
|
||||
|
||||
module_function
|
||||
|
||||
def issue_reference(text)
|
||||
text.to_s.lines.first.to_s[ISSUE_REFERENCE, 1]
|
||||
end
|
||||
|
||||
# Issues behind the document: the ones its time lines and "Added from" notes name, and the ones linked
|
||||
# to its estimates (an invoice's linked estimates, or the estimate itself)
|
||||
def issue_ids(form)
|
||||
ids = form.filled_lines.filter_map do |line|
|
||||
next if line.subtotal?
|
||||
issue_reference(line.description) if line.time_activity_id.present? || line.description.to_s.match?(ADDED_FROM)
|
||||
end
|
||||
estimate_ids = Array(form.linked_estimate_ids).dup
|
||||
estimate_ids << form.id if !form.invoice? && form.persisted?
|
||||
ids += Issue.where(estimate_id: estimate_ids.map(&:to_s)).pluck(:id).map(&:to_s) if estimate_ids.any?
|
||||
ids.map(&:to_s).uniq
|
||||
end
|
||||
|
||||
def issues(form)
|
||||
ids = issue_ids(form)
|
||||
ids.empty? ? [] : Issue.where(id: ids).to_a
|
||||
end
|
||||
|
||||
# { vin: { "116" => "..." }, mileage: { "116" => "..." } } from every plugin listening
|
||||
def values_for(issues)
|
||||
issues = Array(issues)
|
||||
return {} if issues.empty?
|
||||
|
||||
Redmine::Hook.call_hook(:qbo_billing_issue_values, { issues: issues }).each_with_object({}) do |result, merged|
|
||||
next unless result.is_a?(Hash)
|
||||
result.each do |field, by_issue|
|
||||
next unless by_issue.is_a?(Hash)
|
||||
(merged[field.to_sym] ||= {}).merge!(by_issue.transform_keys(&:to_s).transform_values(&:to_s).reject { |_, v| v.strip.empty? })
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
# The same values by issue, for the import panel: { "116" => { vin: "...", mileage: "..." } }
|
||||
def by_issue(issues)
|
||||
values_for(issues).each_with_object({}) do |(field, by_id), result|
|
||||
by_id.each { |id, value| (result[id] ||= {})[field] = value }
|
||||
end
|
||||
end
|
||||
|
||||
# Error messages from plugins that want this save stopped
|
||||
def plugin_errors(form)
|
||||
context = { document: form.document, form: form, issues: issues(form) }
|
||||
Redmine::Hook.call_hook(:qbo_billing_validate, context).flatten.compact.map(&:to_s).reject(&:empty?)
|
||||
rescue StandardError => e
|
||||
Rails.logger.warn "[RedmineQboBilling] A plugin's validation failed: #{e.message}"
|
||||
[]
|
||||
end
|
||||
end
|
||||
end
|
||||
@@ -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.
|
||||
|
||||
module RedmineQboBilling
|
||||
module Patches
|
||||
# quickbooks-ruby's invoice lines have no LinkedTxn, which QuickBooks needs on each line that bills a
|
||||
# time activity ("When linking a TimeActivity to an Invoice you must also link it to a sales line item").
|
||||
# This adds it, placed right after Amount where QuickBooks' schema has it.
|
||||
module InvoiceLineItemLinkedTxn
|
||||
module_function
|
||||
|
||||
def apply!
|
||||
klass = Quickbooks::Model::InvoiceLineItem
|
||||
return if klass.method_defined?(:linked_transactions)
|
||||
|
||||
klass.class_eval do
|
||||
xml_accessor :linked_transactions, from: 'LinkedTxn', as: [Quickbooks::Model::LinkedTransaction]
|
||||
end
|
||||
|
||||
# Move the new element from the end to after Amount, so it's written in schema order
|
||||
attrs = klass.instance_variable_get(:@roxml_attrs)
|
||||
return unless attrs.is_a?(Array)
|
||||
|
||||
linked = attrs.detect { |a| a.respond_to?(:accessor) && a.accessor == 'linked_transactions' }
|
||||
amount_index = attrs.index { |a| a.respond_to?(:accessor) && a.accessor == 'amount' }
|
||||
return unless linked && amount_index
|
||||
|
||||
attrs.delete(linked)
|
||||
attrs.insert(amount_index + 1, linked)
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
@@ -0,0 +1,61 @@
|
||||
#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 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.
|
||||
class PaymentForm
|
||||
include ActiveModel::Model
|
||||
include ActiveModel::Validations
|
||||
|
||||
ATTRIBUTES = %i[customer_id customer_name txn_date payment_method_id reference amount deposit memo].freeze
|
||||
|
||||
attr_accessor(*ATTRIBUTES)
|
||||
# Invoices ticked on the page: the payment goes on these (oldest first). None ticked: all open invoices.
|
||||
attr_accessor :invoice_ids
|
||||
|
||||
validate :validate_payment
|
||||
|
||||
def self.from_params(params)
|
||||
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
|
||||
end
|
||||
end
|
||||
|
||||
def initialize(attributes = {})
|
||||
super
|
||||
self.invoice_ids ||= []
|
||||
end
|
||||
|
||||
def amount_value
|
||||
EstimateForm.decimal(amount)
|
||||
end
|
||||
|
||||
def txn_date_value
|
||||
EstimateForm.date(txn_date)
|
||||
end
|
||||
|
||||
# A deposit is kept unapplied (credit on the customer's account) instead of paying invoices
|
||||
def deposit?
|
||||
deposit == true || deposit.to_s == '1'
|
||||
end
|
||||
|
||||
private
|
||||
|
||||
def validate_payment
|
||||
errors.add(:base, I18n.t(:error_estimate_needs_customer)) if customer_id.blank?
|
||||
errors.add(:base, I18n.t(:error_payment_needs_method)) if payment_method_id.blank?
|
||||
value = amount_value
|
||||
errors.add(:base, I18n.t(:error_payment_amount)) if value.nil? || value <= 0
|
||||
errors.add(:base, I18n.t(:error_estimate_field_invalid, field: I18n.t(:label_payment_date))) if txn_date_value.nil?
|
||||
end
|
||||
end
|
||||
end
|
||||
@@ -0,0 +1,158 @@
|
||||
#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
|
||||
# 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.
|
||||
module PaymentWriter
|
||||
Error = EstimateWriter::Error
|
||||
|
||||
METHODS_CACHE_KEY = 'redmine_qbo_billing:payment_methods'
|
||||
|
||||
module_function
|
||||
|
||||
def new_form(customer: nil, user: User.current)
|
||||
PaymentForm.new(customer_id: customer&.id, customer_name: customer&.name, txn_date: user.today.iso8601)
|
||||
end
|
||||
|
||||
# QuickBooks' payment methods (Cash, Check, Credit Card...), cached for an hour: [[name, id], ...]
|
||||
def payment_methods
|
||||
cached = Rails.cache.read(METHODS_CACHE_KEY)
|
||||
return cached if cached
|
||||
|
||||
methods = with_service('PaymentMethod') { |service| service.query.entries }
|
||||
list = Array(methods).select { |m| m.active? != false && m.active? != 'false' }
|
||||
.map { |m| [m.name.to_s, m.id.to_s] }
|
||||
.sort_by { |name, _| name.downcase }
|
||||
Rails.cache.write(METHODS_CACHE_KEY, list, expires_in: 1.hour) if list.any?
|
||||
list
|
||||
rescue StandardError => e
|
||||
Rails.logger.warn "[RedmineQboBilling] Could not read payment methods: #{e.message}"
|
||||
[]
|
||||
end
|
||||
|
||||
# The customer's invoices with a balance, oldest first (by date, then number)
|
||||
def open_invoices(customer)
|
||||
invoices = with_service('Invoice') do |service|
|
||||
service.query("SELECT * FROM Invoice WHERE CustomerRef = '#{customer.id.to_i}' ORDERBY TxnDate", per_page: 1000).entries
|
||||
end
|
||||
|
||||
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|
|
||||
{ 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') }
|
||||
end
|
||||
end
|
||||
|
||||
# Spreads the amount over the invoices in order: [[invoice, applied], ...] and what's left over
|
||||
def allocate(amount, invoices)
|
||||
left = BigDecimal(amount.to_s)
|
||||
applied = []
|
||||
invoices.each do |invoice|
|
||||
break if left <= 0
|
||||
take = [left, BigDecimal(invoice[:balance].to_s)].min
|
||||
next if take <= 0
|
||||
applied << [invoice, take]
|
||||
left -= take
|
||||
end
|
||||
[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.
|
||||
def save(form)
|
||||
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
|
||||
|
||||
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
|
||||
|
||||
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
|
||||
applied.each { |invoice, _| sync_invoice(invoice[:id]) }
|
||||
saved
|
||||
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|
|
||||
service.all("SELECT * FROM Payment WHERE CustomerRef = '#{customer.id.to_i}' ORDERBY TxnDate DESC")
|
||||
end
|
||||
Array(payments).sort_by { |p| [p.txn_date || Date.new(1900), p.id.to_i] }.reverse
|
||||
end
|
||||
|
||||
# Totals for the customer's payment list: amount received and what's still unapplied (credit)
|
||||
def payment_totals(payments)
|
||||
sum = ->(values) { values.sum(BigDecimal('0')) { |v| BigDecimal(v.to_s.presence || '0') } }
|
||||
{ received: sum.call(payments.map(&:total)), unapplied: sum.call(payments.map(&:unapplied_amount)) }
|
||||
end
|
||||
|
||||
def load(id)
|
||||
payment = with_service('Payment') { |service| service.fetch_by_id(id) }
|
||||
raise Error, I18n.t(:notice_payment_not_found) unless payment
|
||||
payment
|
||||
end
|
||||
|
||||
# The payment as QuickBooks prints it (its payment receipt)
|
||||
def pdf(id)
|
||||
with_service('Payment') { |service| service.pdf(Struct.new(:id).new(id)) }
|
||||
end
|
||||
|
||||
# The invoices a payment was applied to: [[invoice_id, number, amount], ...]
|
||||
def applied_invoices(payment)
|
||||
Array(payment.line_items).flat_map do |line|
|
||||
Array(line.linked_transactions).select { |t| t.txn_type.to_s == 'Invoice' }.map do |t|
|
||||
[t.txn_id.to_s, InvoiceWriter.invoice_number(t.txn_id), line.amount]
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
def payment_method_name(payment)
|
||||
ref = payment.payment_method_ref
|
||||
return '' unless ref
|
||||
ref.name.presence || payment_methods.detect { |_, id| id == ref.value.to_s }&.first || ref.value.to_s
|
||||
end
|
||||
|
||||
def with_service(entity, &block)
|
||||
QboConnectionService.with_qbo_service(entity: entity, &block)
|
||||
end
|
||||
|
||||
def sync_invoice(id)
|
||||
InvoiceSyncService.new.sync_by_id(id)
|
||||
rescue StandardError => e
|
||||
Rails.logger.warn "[RedmineQboBilling] Could not sync invoice #{id} after a payment: #{e.message}"
|
||||
end
|
||||
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.
|
||||
|
||||
module RedmineQboBilling
|
||||
# quickbooks-ruby's estimate service, with QuickBooks' newer custom fields and emailing (QboServiceExtras)
|
||||
class QboEstimateService < Quickbooks::Service::Estimate
|
||||
include QboServiceExtras
|
||||
|
||||
def send_estimate(estimate_id, email_address = nil)
|
||||
send_document(estimate_id, email_address)
|
||||
end
|
||||
end
|
||||
end
|
||||
@@ -0,0 +1,21 @@
|
||||
#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
|
||||
# quickbooks-ruby's invoice service, with QuickBooks' newer custom fields and emailing (QboServiceExtras).
|
||||
# (Its own email call is named "send", which hides Ruby's Object#send, so send_invoice is used instead.)
|
||||
class QboInvoiceService < Quickbooks::Service::Invoice
|
||||
include QboServiceExtras
|
||||
|
||||
def send_invoice(invoice_id, email_address = nil)
|
||||
send_document(invoice_id, email_address)
|
||||
end
|
||||
end
|
||||
end
|
||||
@@ -0,0 +1,57 @@
|
||||
#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 plugin's estimate and invoice services add to quickbooks-ruby's: QuickBooks' newer custom
|
||||
# fields on every request, emailing the document, and an authenticated service for a block.
|
||||
module QboServiceExtras
|
||||
# QuickBooks only includes its newer custom fields (the ones made under Settings > Custom fields, which
|
||||
# aren't listed in the company preferences) when asked for them, on minor version 70 or later
|
||||
MINOR_VERSION = 75
|
||||
ENHANCED_CUSTOM_FIELDS = 'enhancedAllCustomFields'.freeze
|
||||
|
||||
def self.included(base)
|
||||
base.extend(ClassMethods)
|
||||
end
|
||||
|
||||
module ClassMethods
|
||||
# Runs the block with an authenticated service, refreshing the QuickBooks token when needed
|
||||
def with_service
|
||||
qbo = QboConnectionService.current!
|
||||
qbo.perform_authenticated_request do |access_token|
|
||||
yield new(company_id: qbo.realm_id, access_token: access_token)
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
# Emails the document to the customer (to email_address, or the document's billing email when blank).
|
||||
# QuickBooks uses its own email template, marks the document as sent and returns it.
|
||||
def send_document(id, email_address = nil)
|
||||
query = email_address.present? ? "?sendTo=#{CGI.escape(email_address.to_s.strip)}" : ""
|
||||
url = "#{url_for_resource(model::REST_RESOURCE)}/#{id}/send#{query}"
|
||||
response = do_http_post(url, "", {}, { 'Content-Type' => 'application/octet-stream' })
|
||||
return nil unless response.code.to_i == 200
|
||||
|
||||
model.from_xml(parse_singular_entity_response(model, response.plain_body))
|
||||
end
|
||||
|
||||
private
|
||||
|
||||
# Every request from these services (reads, queries, saves, emails) asks for all custom fields. Only
|
||||
# these services do, so redmine_qbo's own calls are unchanged.
|
||||
def add_query_string_to_url(url, params = {})
|
||||
params = params.is_a?(Hash) ? params.dup : {}
|
||||
params['minorversion'] = [Quickbooks.minorversion.to_i, MINOR_VERSION].max
|
||||
params['include'] = ENHANCED_CUSTOM_FIELDS
|
||||
delimiter = url.include?('?') ? '&' : '?'
|
||||
url + delimiter + params.map { |key, value| "#{key}=#{value}" }.join('&')
|
||||
end
|
||||
end
|
||||
end
|
||||
@@ -0,0 +1,24 @@
|
||||
#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.
|
||||
|
||||
namespace :redmine_qbo do
|
||||
desc 'Relate all issues created from the same QBO estimate to each other (one-time catch-up; safe to re-run)'
|
||||
task relate_estimate_issues: :environment do
|
||||
total = 0
|
||||
estimates = QboEstimateLineIssue.distinct.pluck(:estimate_id)
|
||||
|
||||
estimates.each do |estimate_id|
|
||||
issues = QboEstimateLineIssue.where(estimate_id: estimate_id).includes(:issue).filter_map(&:issue)
|
||||
total += RedmineQboBilling::EstimateIssueBuilder.relate_all(issues)
|
||||
end
|
||||
|
||||
puts "Checked #{estimates.size} estimate(s), created #{total} relation(s)."
|
||||
end
|
||||
end
|
||||
Reference in new issue
Block a user