Compare commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
40eb6205c4 | ||
|
|
0c5bac855e | ||
|
|
663639b8fd | ||
|
|
ec4e5f681d | ||
|
|
a72b0fa73b | ||
|
|
5b6c1ed2c2 | ||
|
|
4f6f81c87a | ||
|
|
9fa199aa98 | ||
|
|
16f9441568 | ||
|
|
5c48646041 | ||
|
|
90adb96d54 | ||
|
|
8a947483db | ||
|
|
42461e7899 | ||
|
|
461fa79bc5 | ||
|
|
2fb21c34bb | ||
|
|
1c71e3a4c9 | ||
|
|
89f4797bbe | ||
|
|
3bbceacda4 | ||
|
|
d75dee2866 | ||
|
|
c8e2d2d92e | ||
|
|
a1fb88e77c | ||
|
|
0a7b2e34b8 | ||
|
|
895733f534 | ||
|
|
fa1b4eed06 | ||
|
|
95e76a41fd | ||
|
|
92b2a18eb6 | ||
|
|
084df36061 | ||
|
|
3b51625df4 | ||
|
|
7cfc8a370e | ||
|
|
d2cdd798cd | ||
|
|
159420fac1 | ||
|
|
dbee228cdf | ||
|
|
ec00684edd | ||
|
|
839ac976e6 | ||
|
|
dc72b11766 | ||
|
|
778111825b | ||
|
|
4ba96e2dfd | ||
|
|
88160a985d | ||
|
|
e2a871b1e8 | ||
|
|
489edd97fa | ||
|
|
64e4a149ab | ||
|
|
6a638fe7bb | ||
|
|
51159d5034 | ||
|
|
8f2cef2bc8 | ||
|
|
bd29ec2978 | ||
|
|
b1ad2d5b40 | ||
|
|
03af3457ab | ||
|
|
0d35cffb83 | ||
|
|
e348042fef | ||
|
|
846fcad292 | ||
|
|
d91e80199e | ||
|
|
d054b0d872 | ||
|
|
632d81b98b | ||
|
|
331a2d1da7 | ||
|
|
66d96c9e4c | ||
|
|
6ac0e27cb2 | ||
|
|
338b4db237 | ||
|
|
ec6fecbd85 | ||
|
|
09e88232b0 | ||
|
|
6f40308029 | ||
|
|
b739b84917 | ||
|
|
388ac915d7 | ||
|
|
cb705d9525 | ||
|
|
abeb0fe0f5 | ||
|
|
b84f39afce | ||
|
|
28538d4c7f | ||
|
|
bf7c7b0905 | ||
|
|
06a78ebccb | ||
|
|
3304fce92f | ||
|
|
4732c32409 | ||
|
|
616ee13725 | ||
|
|
062ef9b8b3 | ||
|
|
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 | ||
|
|
ea29990cfa | ||
|
|
c31ec82e61 | ||
|
|
938f9d9f3b | ||
|
|
f2b0186ee2 | ||
|
|
9373963c94 | ||
|
|
396a56ceec | ||
|
|
b3c3006b56 | ||
|
|
576ca5a0a9 | ||
|
|
d18a0c180a | ||
|
|
baca0ed6c7 | ||
|
|
6bf84dd61a | ||
|
|
61b02831e3 | ||
|
|
7c79f2388a | ||
|
|
36267893bd | ||
|
|
e681203a45 | ||
|
|
681e7f8047 | ||
|
|
4a6c414d9e | ||
|
|
925cb1d2bc | ||
|
|
1dcccd7b98 | ||
|
|
f73973a4e1 | ||
|
|
7cd388dbd4 | ||
|
|
7149e85d37 | ||
|
|
eacdecd65b | ||
|
|
ee2ab04206 | ||
|
|
8a8c6f5fa0 | ||
|
|
cc36bc16b4 | ||
|
|
874ec7c2dc | ||
|
|
f3fe38cd57 | ||
|
|
977cbfe0e1 | ||
|
|
82712f361c | ||
|
|
4ae7d75478 | ||
|
|
8fb9d74277 | ||
|
|
b0e6236cee | ||
|
|
b367687113 | ||
|
|
460bcd466f | ||
|
|
020ea01d36 | ||
|
|
df079b767c | ||
|
|
7d3908ec41 | ||
|
|
f60e507029 | ||
|
|
3e6650ee65 | ||
|
|
c2d0e5c702 | ||
|
|
a4f461fd4d | ||
|
|
3e81d2840a | ||
|
|
c9a5dc20f9 | ||
|
|
db3c6021c5 | ||
|
|
b8327be5d6 | ||
|
|
c4e1ece82c | ||
|
|
9fd7140e4a | ||
|
|
a6c8923ea9 | ||
|
|
eb1174cf7c | ||
|
|
7993f15441 | ||
|
|
bb57af71ae | ||
|
|
1a10360884 | ||
|
|
cd109f16b5 | ||
|
|
164252cb97 | ||
|
|
fd18205c10 | ||
|
|
6fc8a18e93 | ||
|
|
8abc95c21e | ||
|
|
2bcb1840a4 | ||
|
|
c87e18810b | ||
|
|
eb6954ddf1 | ||
|
|
be1a69217f | ||
|
|
99669f7baa | ||
|
|
29530e2c95 | ||
|
|
beb4a66a93 | ||
|
|
40f7a3335c | ||
|
|
da0f7ffc56 | ||
|
|
4fa8be856a | ||
|
|
ffd8dc6332 | ||
|
|
cd219a0c00 | ||
|
|
cd88ce6217 | ||
|
|
b10665355d | ||
|
|
17ac19e435 | ||
|
|
ef5089438c | ||
|
|
1f64e36892 | ||
|
|
643b15391b | ||
|
|
d8a26f98c0 | ||
|
|
8fc01cd8fb | ||
|
|
fe3da8c452 | ||
|
|
c4c02f8d27 | ||
|
|
00b1baa1f3 | ||
|
|
2520892e2c | ||
|
|
b96678a2e9 | ||
|
|
bccfcd9dbc | ||
|
|
8ba99b7db2 | ||
|
|
aff7d0c48e | ||
|
|
e9b3b1c838 | ||
|
|
2fc2f94cd1 | ||
|
|
9f9810686f | ||
|
|
f041e1bce4 | ||
|
|
d44d5e2fb7 | ||
|
|
4403267abb | ||
|
|
be400c2b2a | ||
|
|
23e565a304 | ||
|
|
2e2b17fac3 | ||
|
|
28db5cb8c8 | ||
|
|
0df15693d2 | ||
|
|
f8b1c72394 | ||
|
|
899237c5ab | ||
|
|
f02b50ae26 | ||
|
|
485a977d1a | ||
|
|
03d5a5d148 | ||
|
|
0deab9dbd3 | ||
|
|
899c9878c4 | ||
|
|
b95a3b6623 | ||
|
|
ef3f00c445 | ||
|
|
46f06df995 | ||
|
|
b15b88f48d | ||
|
|
7b7b07b5fa | ||
|
|
16ca1caabc | ||
|
|
69d266bdca | ||
|
|
3728ec2a12 | ||
|
|
cefa36c880 | ||
|
|
ed111fefe7 | ||
|
|
5a662f67b8 | ||
|
|
6e90548dbb | ||
|
|
f921f227e2 | ||
|
|
a34ae46358 | ||
|
|
e4cfb0674e | ||
|
|
348c521491 | ||
|
|
6cee8c1d81 | ||
|
|
d4a0aa1db5 | ||
|
|
12884a211e | ||
|
|
4ed71f5667 | ||
|
|
8303dec501 | ||
|
|
9b07ae7073 | ||
|
|
baf321d4d6 | ||
|
|
0a2d38a927 | ||
|
|
b80dbaa015 | ||
|
|
9e399b934b | ||
|
|
cc6fd07435 | ||
|
|
7a50df24d9 | ||
|
|
ca02ead9f9 | ||
|
|
9089adaba0 | ||
|
|
dc6eba8566 | ||
|
|
19911b7940 | ||
|
|
a80f59cc45 | ||
|
|
eee99e4d83 | ||
|
|
b3f01bd372 | ||
|
|
d1ba93d61a | ||
|
|
9a688c4841 | ||
|
|
e94352e2c4 | ||
|
|
ea0f42b68e | ||
|
|
5a31c194a5 | ||
|
|
6f8af9bba8 | ||
|
|
03109d5775 | ||
|
|
a1cbf9a0a9 | ||
|
|
9c0f153518 | ||
|
|
f32b48296d | ||
|
|
3d37f01bff | ||
|
|
889e9bf31f | ||
|
|
208e839e6a | ||
|
|
4f55751500 | ||
|
|
a64016eb95 | ||
|
|
5d858ae186 | ||
|
|
b38f850df3 | ||
|
|
138e55933b | ||
|
|
5fbc169ade | ||
|
|
d6737a6747 | ||
|
|
65db8f00a8 | ||
|
|
0197dc2a30 | ||
|
|
cd1caa502d | ||
|
|
4b45d24a75 | ||
|
|
64a4526aa4 | ||
|
|
3514401808 | ||
|
|
3deafd8a6d | ||
|
|
a54de28db5 | ||
|
|
6434eea906 | ||
|
|
9b656534ae | ||
|
|
659a1fbcf0 | ||
|
|
4dc1f5d0bd | ||
|
|
02f34582f4 | ||
|
|
2f9ef6304f | ||
|
|
886d5f4ace | ||
|
|
1ade938eb3 | ||
|
|
3111f391f3 | ||
|
|
d2b9113914 | ||
|
|
447e048819 | ||
|
|
e7dfc3f2ad | ||
|
|
139f5dd618 | ||
|
|
9c11704d03 | ||
|
|
2ae53adf08 | ||
|
|
877c1b78a5 | ||
|
|
1d47703206 | ||
|
|
a069556ed9 | ||
|
|
359c582e22 | ||
|
|
e63b9e4217 | ||
|
|
6fd355d8cc | ||
|
|
e6b57392d1 | ||
|
|
331c1eabeb | ||
|
|
167385bb99 | ||
|
|
11b9876d4f | ||
|
|
9cf72821b0 | ||
|
|
57adcce431 | ||
|
|
7fdb15f7e8 | ||
|
|
6e11e05a24 | ||
|
|
a6751d3f41 | ||
|
|
8944e92ffc |
No files matched your search
@@ -3,12 +3,8 @@ source 'https://rubygems.org'
|
|||||||
gem 'quickbooks-ruby'
|
gem 'quickbooks-ruby'
|
||||||
gem 'oauth2'
|
gem 'oauth2'
|
||||||
gem 'roxml'
|
gem 'roxml'
|
||||||
gem 'will_paginate'
|
|
||||||
gem 'rails-jquery-autocomplete'
|
|
||||||
gem 'jquery-ui-rails'
|
|
||||||
gem 'rexml'
|
gem 'rexml'
|
||||||
gem 'combine_pdf'
|
gem 'combine_pdf'
|
||||||
|
|
||||||
group :assets do
|
# Double Metaphone sound-alike matching for customer search (CustomerSearchService)
|
||||||
gem 'coffee-rails'
|
gem 'text', '~> 1.3'
|
||||||
end
|
|
||||||
@@ -1,14 +1,21 @@
|
|||||||
# Redmine QuickBooks Online
|
# Redmine QuickBooks Online Plugin
|
||||||
|
|
||||||
A plugin for Redmine to connect to QuickBooks Online.
|
A plugin for **Redmine** that integrates with **QuickBooks Online (QBO)** to automatically create **Time Activity entries** from billable hours logged on Issues.
|
||||||
|
|
||||||
The goal of this project is to allow Redmine to connect with QuickBooks Online to create Time Activity Entries for billable hours logged when an Issue is closed.
|
When an Issue associated with a Customer is closed, the plugin generates corresponding Time Activities in QuickBooks based on the Redmine Time Entries recorded for that Issue.
|
||||||
|
|
||||||
## Disclaimer
|
---
|
||||||
|
|
||||||
**Note:** Although the core functionality is complete, this project is still under development and the master branch may be unstable. Tags should be stable and are recommended.
|
# Disclaimer
|
||||||
|
|
||||||
## Compatibility
|
The core functionality is implemented, but the project is **under active development**.
|
||||||
|
|
||||||
|
The `master` branch may contain unstable changes.
|
||||||
|
For production deployments, **use a tagged release**.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
# Compatibility
|
||||||
|
|
||||||
| Plugin Version | Redmine Version |
|
| Plugin Version | Redmine Version |
|
||||||
| :--- | :--- |
|
| :--- | :--- |
|
||||||
@@ -17,85 +24,380 @@ The goal of this project is to allow Redmine to connect with QuickBooks Online t
|
|||||||
| Version 1.0.0+ | Redmine 4 |
|
| Version 1.0.0+ | Redmine 4 |
|
||||||
| Version 0.8.1 | Redmine 3 |
|
| Version 0.8.1 | Redmine 3 |
|
||||||
|
|
||||||
## Features
|
---
|
||||||
|
|
||||||
* **Customer Assignment:** Issues can be assigned to a Customer via a dropdown in the edit Issue form.
|
# Features
|
||||||
* Once a customer is attached to an Issue, you can attach an Estimate to the issue via a dropdown menu.
|
|
||||||
* **Employee Mapping:** An Employee is assigned to a Redmine User via a dropdown in the User Administration page.
|
|
||||||
* **Automatic Billing:** If an Issue has been assigned a Customer, the following happens when the Issue is closed:
|
|
||||||
* A new Time Activity will be billed against the Customer assigned to the issue for each Redmine Time Entry.
|
|
||||||
* Time Entries will be totalled up by Activity name. This allows billing for different activities without having to create separate Issues.
|
|
||||||
* The Time Activity names are used to dynamically lookup Items in QuickBooks.
|
|
||||||
* If there are no Items that match the Activity name, it will be skipped and will not be billed to the Customer.
|
|
||||||
* Labor Rates are set by the corresponding Item in QuickBooks.
|
|
||||||
* **Customer Management:** Customers can be created via the New Customer Page.
|
|
||||||
* Customers can be searched by name or phone number.
|
|
||||||
* Basic information for the Customer can be viewed/edited via the Customer page.
|
|
||||||
* **Webhook Support:**
|
|
||||||
* **Invoices:** Automatically attached to an Issue if a line item contains a hashtag number (e.g., `#123`).
|
|
||||||
* **Custom Fields:** Invoice Custom Fields are matched to Issue Custom Fields and are automatically updated in QuickBooks. (Useful for extracting Mileage In/Out from the Issue to update the Invoice).
|
|
||||||
* **Sync:** Customers are automatically updated in the local database.
|
|
||||||
* **Plugin View Hooks** Allows intergration of other features supported by companion plugins, for example [redmine_qbo_vehicles](https://github.com/rickbarrette/redmine_qbo_vehicles) adds customer vehicle interation
|
|
||||||
|
|
||||||
## Prerequisites
|
## Issue Billing Integration
|
||||||
|
|
||||||
* Sign up to become a developer for Intuit: https://developer.intuit.com/
|
* Assign a **QuickBooks Customer** to a Redmine Issue.
|
||||||
* Create your own application to obtain your API keys.
|
|
||||||
* Set up the webhook service to `https://redmine.yourdomain.com/qbo/webhook`
|
|
||||||
|
|
||||||
## Installation
|
* Optionally associate a **QuickBooks Estimate** with the Issue.
|
||||||
|
|
||||||
1. **Clone the plugin:**
|
* Automatically associates a **QuickBooks Invoice** with the Issue.
|
||||||
Clone this repo into your plugin folder and checkout a tagged version.
|
|
||||||
```bash
|
|
||||||
cd path/to/redmine/plugins
|
|
||||||
git clone git@github.com:rickbarrette/redmine_qbo.git
|
|
||||||
cd redmine_qbo
|
|
||||||
git checkout <tag>
|
|
||||||
```
|
|
||||||
|
|
||||||
2. **Install dependencies:** *Crucial for Redmine 6 / Rails 7 compatibility.*
|
|
||||||
|
|
||||||
Bash
|
|
||||||
|
|
||||||
```
|
|
||||||
bundle install
|
|
||||||
```
|
|
||||||
|
|
||||||
3. **Migrate your database:**
|
|
||||||
|
|
||||||
Bash
|
|
||||||
|
|
||||||
```
|
|
||||||
bundle exec rake redmine:plugins:migrate RAILS_ENV=production
|
|
||||||
```
|
|
||||||
|
|
||||||
4. **Restart Redmine:** You must restart your Redmine server instance for the plugin and hooks to load.
|
|
||||||
|
|
||||||
5. **Configuration:**
|
|
||||||
|
|
||||||
* Navigate to the plugin configuration page (`Administration > Plugins > Configure`).
|
|
||||||
|
|
||||||
* Supply your own OAuth Key & Secret.
|
|
||||||
|
|
||||||
* After saving the Key & Secret, click the **Authenticate** link on the configuration page to connect to QBO.
|
|
||||||
|
|
||||||
6. **User Mapping:**
|
|
||||||
|
|
||||||
* Assign an Employee to each of your users via the **User Administration Page**.
|
|
||||||
|
|
||||||
|
|
||||||
## Usage
|
---
|
||||||
|
|
||||||
To enable automatic Time Activity entries for an Issue, you simply need to assign a Customer to an Issue via the dropdowns in the issue creation/update form.
|
## Automatic Time Activity Creation
|
||||||
|
|
||||||
**Note:** After the initial synchronization, this plugin will receive push notifications via Intuit's webhook service.
|
When an Issue with an assigned Customer is closed:
|
||||||
|
|
||||||
## Companion Plugin Hooks
|
* A **Time Activity** is created in QuickBooks for each relevant Redmine Time Entry.
|
||||||
* :pdf_left, { issue: issue }
|
|
||||||
* :pdf_right, { issue: issue }
|
* Time Entries are **grouped by Activity name**.
|
||||||
* :process_invoice_custom_fields, { issue: issue, invoice: invoice }
|
|
||||||
* :show_customer_view_right, {customer: @customer}
|
* Activity names are used to **dynamically match Items in QuickBooks**.
|
||||||
|
|
||||||
|
* If no matching Item exists, the activity is **skipped**.
|
||||||
|
|
||||||
|
* **Labor rates** are determined by the associated QuickBooks Item.
|
||||||
|
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Employee Mapping
|
||||||
|
|
||||||
|
Redmine Users can be mapped to **QuickBooks Employees** through the **User Administration** page.
|
||||||
|
|
||||||
|
This ensures Time Activities are recorded under the correct employee in QuickBooks.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Customer Management
|
||||||
|
|
||||||
|
The plugin provides basic Customer management:
|
||||||
|
|
||||||
|
* Create Customers directly from Redmine
|
||||||
|
|
||||||
|
* Browse every Customer on the **Customers** page: a Redmine list with phone numbers, issue counts and last update, sortable by column and paged with Redmine's own pagination (and its per-page choices)
|
||||||
|
|
||||||
|
* Search Customers by **name or phone number**: the best matches come first (click a column to sort them instead), and a single match opens that Customer
|
||||||
|
|
||||||
|
* View and edit Customer information
|
||||||
|
|
||||||
|
|
||||||
|
Customers are synchronized with QuickBooks.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Webhook Support
|
||||||
|
|
||||||
|
The plugin listens for **QuickBooks webhook events**.
|
||||||
|
|
||||||
|
Supported automation:
|
||||||
|
|
||||||
|
### Invoice Linking
|
||||||
|
|
||||||
|
Invoices containing an Issue reference (e.g. `#123`) automatically attach to the corresponding Issue.
|
||||||
|
|
||||||
|
### Customer Synchronization
|
||||||
|
|
||||||
|
Customer records are automatically updated in the local database when changes occur in QuickBooks.
|
||||||
|
|
||||||
|
### Estimates, Invoices and Payments
|
||||||
|
|
||||||
|
Estimates and invoices keep their number, date, customer, total, sales tax and **man-hours** (the quantities of the labor products/services, including lines inside bundles). Payments keep their customer, date, amount and unapplied amount. These cached figures feed the business report.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Billing: Estimates, Invoices and Payments
|
||||||
|
|
||||||
|
* **New estimate** from the customer page: Create Estimate opens the Redmine editor. The customer page no longer links to QuickBooks' estimate or payment screens; **Open in QuickBooks** opens their QuickBooks account page as a fallback.
|
||||||
|
* **Edit** any estimate from the Edit link next to it on the customer page or the issue page.
|
||||||
|
* **Keyboard entry**: in a line's product box, Tab picks the product the text points to (an exact name, the only match, or the only name starting with it, e.g. "lab" → Labor) and fills the line. Tabbing into the description, quantity or rate selects it, so typing replaces it. The quantity, rate and amount boxes take simple math (e.g. `33*1.3`, `(120+15)/2`; `+ - * /`, `x` for times, parentheses), worked out when you leave the box; math in the rate or amount is rounded to the nearest penny, and an amount sets the rate from the quantity. Typing `sub`, `subtotal` or `=` in a product box, then Tab or Enter, adds a subtotal there (an empty line becomes the subtotal; a line with a description keeps it and gets the subtotal after it) and moves on to the next line.
|
||||||
|
* **Duplicate** an estimate to start a similar one: same customer, lines, subtotals, custom fields and messages, dated today, with the current user as sales person.
|
||||||
|
* **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.
|
||||||
|
* **Read-only once billed**: an estimate that's Converted or Closed in QuickBooks, or linked to an invoice, can't be changed here either (including redmine_qbo_lineitems' estimates once they're invoiced). Its page lists the invoices it's on; it can still be viewed, emailed and duplicated, and it shows View instead of Edit in lists.
|
||||||
|
* **Create issues** from an estimate's labor lines (moved here from redmine_qbo_calendar): each line with one of the **labor products/services** (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. Creating issues marks a pending estimate **Accepted** in QuickBooks (dated today), since the work is going ahead; estimates that are already accepted, closed, converted or rejected keep their status. 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, custom fields), like QuickBooks' "Create invoice". **Create invoice** on the customer page starts a blank one, and the Edit link next to each invoice on the customer page opens it.
|
||||||
|
* **Import time & estimates** lists the customer's billable QuickBooks time (the time activities redmine_qbo makes from an issue's time entries) and their open estimates (e.g. the ones redmine_qbo_lineitems makes for parts that weren't quoted).
|
||||||
|
* Tick the time to bill and, under **Replace these lines**, the lines it replaces (e.g. the estimate's labor lines). Only lines with one of the **labor products/services** from the plugin settings are offered there. Each time entry takes the place of one ticked line: the one whose description is its issue's subject (issues created from an estimate are named after the line, so "Install #134: Install Lift Kit" replaces the "Install Lift Kit" line), then any others in order. Extra time goes after the last replaced line and extra ticked lines are removed, so the invoice keeps the estimate's order and subtotals.
|
||||||
|
* Ticked estimates go right after the time for the same issue: a redmine_qbo_lineitems estimate starting "Added from: Install #116: …" lands after the time for #116, without that note line, since the time line already names the issue. Estimates with no matching time keep the note and go at the end.
|
||||||
|
* **Undo import** puts the lines back until the invoice is saved.
|
||||||
|
* **An estimate is billed once**: an estimate that's on an invoice (linked to one, or closed) or was rejected can't be made into an invoice or imported, and its page shows the invoice it's billed on. This is checked against QuickBooks again when the invoice is saved, so an estimate invoiced meanwhile (in another tab, by someone else, or in QuickBooks) stops the save.
|
||||||
|
* Time lines are linked to their time activities, so QuickBooks marks the time as billed. Estimates the invoice was made from, or imported into it, are linked and closed when it's saved.
|
||||||
|
* **Custom fields from the work orders**: the issues behind an invoice are the ones its time lines and lineitems estimates name. Plugins can fill custom fields from them when they're imported, and block a save (e.g. redmine_qbo_vehicles fills the VIN and mileage and allows one vehicle per invoice). On its own, redmine_qbo leaves the boxes as typed.
|
||||||
|
* **Sales person**: an invoice credits the sales person on the estimate it was made from (the first linked estimate that names one); if none does, the user who writes the invoice.
|
||||||
|
* Invoices show their status, worked out from the balance and due date like QuickBooks' invoice list: **Paid**, **Partially paid**, **Overdue**, **Open** or **Voided** (a zero total), on the customer page's invoice list and the invoice page. A paid invoice shows the day it was paid in full (e.g. **Paid 11/03/2026**): the later of its date and the last payment or credit memo applied to it.
|
||||||
|
* Invoices with a payment applied open read-only. The due date is left to QuickBooks (from the customer's terms) unless one is picked. The "default message shown on invoices" fills in the message.
|
||||||
|
|
||||||
|
### Payments
|
||||||
|
|
||||||
|
* **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.
|
||||||
|
|
||||||
|
### Refunds
|
||||||
|
|
||||||
|
Refunds for canceled orders and returned parts, following SOP-OPS-014, so they don't have to be made in QuickBooks:
|
||||||
|
|
||||||
|
* **Refund** on the customer page. Pick the canceled order's estimate: its parts (the lines that aren't labor, including those in bundles, before tax) fill in the amount the restocking fee is worked out on, and can be changed (e.g. only some parts are returned). Labor carries no fee.
|
||||||
|
* Choose how the money goes back: **Company check** (with its number) or **Card** (a partial refund on the terminal). There are no cash refunds. The page shows the customer's credit, the fee and the exact amount to refund.
|
||||||
|
* **Refund** then, in QuickBooks:
|
||||||
|
1. makes the restocking fee invoice, its line showing the math ("Restocking fee: 30% × $307.99 parts on E1068 = $92.40"), and pays it from the customer's credit, oldest first (unless QuickBooks already applied the credit to it on its own);
|
||||||
|
2. records the rest of the credit as a refund with the category **Accounts Receivable**, from the bank account in the settings, described "Refund for deposit on E1068": a **Check** for a check, an **Expense** for a card refund;
|
||||||
|
3. applies the customer's remaining credit to that check or expense, so the deposit, the fee invoice and the refund reconcile, and reads back the customer's balance (it should be $0.00).
|
||||||
|
* As ticked on the page, it also marks the estimate **Rejected**, sets the order's work orders to the canceled status with the reason as a note, and emails the customer a summary (through redmine_qbo_reminders' mail settings when that plugin is set up, otherwise Redmine's).
|
||||||
|
* Each refund has its own page, listed on the customer page: what was refunded and how, with the fee invoice (opened in Redmine), a **PDF** of the refund (QuickBooks has no PDF of a check or an expense), the fee invoice's PDF, and **Email the customer** to send the summary again. If a QuickBooks step fails, the refund stops there and its page says which step and what was already done, to finish in QuickBooks.
|
||||||
|
* It refunds all of the customer's remaining credit held as unapplied payments. Credit held as credit memos isn't refunded here.
|
||||||
|
|
||||||
|
### Business report
|
||||||
|
|
||||||
|
**Business report** in the top menu compares, for a period (this or last week, month, quarter or year, or custom dates; weeks start on the day set in Redmine's *Start calendars on* setting, Monday when it follows the language):
|
||||||
|
|
||||||
|
* **Sales**: estimates written, invoices written, invoices paid in full (on the day each was paid in full) and payments received (totals and counts), invoiced vs. estimated, collected vs. invoiced, and what's still owed on those invoices. Estimates and invoices are without sales tax (QuickBooks' tax on each is cached with it); payments are as received, so collected vs. invoiced compares them with the invoices' totals with tax.
|
||||||
|
* **Sales tax**: **tax invoiced**, the sales tax on invoices dated in the period, paid or not (accrual), and **tax collected**, the sales tax on invoices paid in full in the period, counted on the day each was paid in full (cash), each with how many invoices carried tax, a line chart and a month-by-month table. A partly paid invoice's tax counts as collected once it's paid in full. Only invoices are counted: sales receipts, refund receipts and credit memos aren't kept in Redmine, so file sales tax from QuickBooks' *Sales Tax Liability* report.
|
||||||
|
* **Hours**: estimated hours on estimates, issues' estimated time, invoiced hours on invoices and time spent, with spent vs. estimated, and the **cost performance index** (CPI = invoiced hours ÷ spent hours): green at 1.00 or more, yellow below 1, red below 0.80. Each month shows its CPI too.
|
||||||
|
* **Charts**: above each set of bars, a line chart of the same figures in the same colors (Chart.js 4.5.1, MIT licensed, bundled with the plugin in assets/javascripts so it doesn't clash with other plugins' copies such as redmine_indicator's Chart.js 2), with a point per day for a week, per week for up to about three months, and per month beyond. Hovering a point shows its figures. **Compare with last year** adds last year's lines, dashed and faded, without reloading: days and weeks go back 52 weeks so weekdays line up, months go back to the same month. Clicking a figure in the legend hides it (and its last-year line); clicking *last year* stops comparing. Today's line stops at today.
|
||||||
|
* **By month**: every sales and hours figure month by month, with totals (the sales tax has its own table).
|
||||||
|
* **Projects**: pick one or more open projects (Ctrl/Cmd-click; closed and archived projects aren't listed) to count only their issues' estimated time and spent time, in the totals, charts and months; none picked counts every project. Estimates, invoices and payments have no project in QuickBooks, so they always cover the whole business (as do the CPI's invoiced hours). **Remember these projects** saves the choice in your Redmine preferences, and the report opens with it until you save another (saving none goes back to every project).
|
||||||
|
|
||||||
|
Estimates, invoices and payments count by their QuickBooks date; invoices paid in full and tax collected by the day each invoice was paid in full. Issues' estimated time counts issues created in the period, leaving out parents so subtasks aren't counted twice. Spent time counts time logged in the period. While estimates, invoices or payments are syncing, the report says so (with how many have been read) and refreshes every 30 seconds; the settings page's Synchronization table shows the same per type. Estimates and invoices synced before these figures were added have no total, hours or sales tax, and paid invoices no paid-in-full day, until a full sync (the report says how many); run one again after changing the labor products/services.
|
||||||
|
|
||||||
|
### QuickBooks custom fields
|
||||||
|
|
||||||
|
Nothing is configured in Redmine. The plugin reads QuickBooks' sales form settings, and the custom fields on the 20 most recently changed estimates, and shows them on the estimate/invoice editor:
|
||||||
|
|
||||||
|
* Every enabled **text** custom field gets a box in the editor's header (e.g. "Crew #"), saved to that field. Plugins can suggest values and fill them in (e.g. redmine_qbo_vehicles: the VIN and Mileage fields).
|
||||||
|
* 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 no custom fields are found). 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
|
||||||
|
* **View business reports**: the Business report
|
||||||
|
* **Write invoices**: create and edit invoices, and import time and estimates into them
|
||||||
|
* **Email invoices**: email invoices to customers
|
||||||
|
* **Issue refunds**: the Refund page, refunds and their PDFs
|
||||||
|
|
||||||
|
2. Settings (Administration -> Plugins -> Configure)
|
||||||
|
* **Estimates expire after (days)**: new estimates get an expiration date this many days after the estimate date (e.g. 30). Leave blank for none.
|
||||||
|
* **Labor products/services** (e.g. Labor): one list used three ways. An estimate's lines with them can become issues (their quantities are also the estimate's labor hours, which an appointment's hours can't be less than); an invoice's lines with them are offered under Replace these lines when time is imported; and their quantities are the hours on estimates and invoices in the business report. While none are chosen, products/services named Labor are used.
|
||||||
|
* **Issues from estimates**: the default project and the default tracker.
|
||||||
|
* **Refunds**: the restocking fee (SOP-OPS-014: 30%) and the product/service on its invoice (e.g. a "Restocking Fee" service, which sets the income account), the bank accounts refund checks and card refunds come out of (blank: the first bank account), and the status canceled work orders are set to (blank: a closed status named Canceled).
|
||||||
|
* Item and account counts, the default income account and their syncs are under Synchronization.
|
||||||
|
|
||||||
|
3. Writing an estimate
|
||||||
|
|
||||||
|
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.
|
||||||
|
|
||||||
|
Example:
|
||||||
|
|
||||||
|
`redmine_qbo_vehicles`
|
||||||
|
Adds support for tracking **customer vehicles** associated with Issues.
|
||||||
|
|
||||||
|
Available hooks:
|
||||||
|
|
||||||
|
|Type|Hook|Note
|
||||||
|
|--|--|--|
|
||||||
|
View Hook|:view_customers_show_contextual, { customer: @customer } | Used to add action links to the customer page's action area, under the title (return links styled like Redmine's, e.g. `link_to sprite_icon('add', 'Label'), path, class: 'icon icon-add'`). Replaces `customer_actions_top` / `customer_actions_bottom`
|
||||||
|
View Hook|:pdf_left, { issue: issue } | Used to add text to left side of PDF
|
||||||
|
View Hook|:pdf_right, { issue: issue } | Used to add text to right side of PDF
|
||||||
|
View Hook|:show_customer_view_right, { customer: customer } | Used to show partials on right side of customer view
|
||||||
|
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_id => { issue_id => value } }` (QuickBooks custom field id; find yours with `RedmineQboBilling::Company.custom_field_matching(/name/)`) for the work orders behind an invoice, e.g. redmine_qbo_vehicles' VIN and mileage. They're given to the editor with imported time and estimates (the `qbo:imported` event) and put on redmine_qbo_lineitems' estimates
|
||||||
|
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`, `project`, `description`, `return_path`, `return_label`, plus any values your own fields need (e.g. redmine_qbo_calendar's `vehicle_id`), for issues created from an estimate (redmine_qbo_calendar, when opened from an appointment)
|
||||||
|
Hook|:qbo_billing_build_issue, { issue:, estimate:, defaults: } | Set your plugin's own fields on each issue created from an estimate, before it's saved (redmine_qbo_vehicles sets the vehicle: the one in `defaults`, or the customer's vehicle whose VIN is on the estimate)
|
||||||
|
View|:view_qbo_estimate_issues_form, { estimate:, defaults:, project: } | Draw your plugin's fields on the Create issues from estimate page, applied to every issue. Name them `issue_plugin_fields[name]`; the posted values reach `:qbo_billing_build_issue` in `defaults` (redmine_qbo_vehicles: the Vehicle, preselected from the estimate's VIN)
|
||||||
|
Hook|:qbo_billing_issues_created, { estimate:, issues:, params: } | Called after issues are created from an estimate
|
||||||
|
Hook|:qbo_billing_field_defaults, { customer:, issues: } | Return `{ field_id => value }` for a document's work orders: used when an invoice is made from an estimate, for the fields it leaves blank. New estimates and invoices start blank (redmine_qbo_vehicles: the work orders' VIN and highest mileage)
|
||||||
|
Hook|:qbo_billing_field_options, { customer: } | Return `{ field_id => [{ value:, label: }, ...] }` to suggest in the editor's custom field boxes for a customer (redmine_qbo_vehicles: the customer's vehicles for the VIN box)
|
||||||
|
View|:view_qbo_estimate_form_bottom, { form:, document: } | Add your plugin's script to the estimate/invoice editor. It can use `window.qboEditor` (`field(id)`, `fieldNamed(/name/)`, `setFieldOptions(id, options)`) and listen for `qbo:customer-changed` and `qbo:imported` on the form (redmine_qbo_vehicles fills the VIN and mileage)
|
||||||
|
View|checkboxes with `data-new-issue-param="issue[field]"` on the customer page | Ticking one adds `issue[field]=value` to the New issue link, one per field (redmine_qbo's estimates, redmine_qbo_vehicles' vehicles)
|
||||||
|
View Hook|:view_qbo_estimate_contextual, { estimate_id:, customer_id:, custom_fields:, doc_number: } | Adds links to an estimate page's action area (e.g. redmine_qbo_calendar's Add appointment); `custom_fields` is `{ field_id => value }`
|
||||||
|
View Hook|:view_qbo_invoice_contextual, { invoice_id:, customer_id:, doc_number: } | Adds links to an invoice page's action area (e.g. redmine_qbo_labels' Print label)
|
||||||
|
|
||||||
|
Other plugins create estimates with `RedmineQboBilling::EstimateWriter.create_estimate(customer:, lines:, private_note:, custom_fields:, user:)`; `custom_fields` is `{ field_id => value }`, and each line is a hash of `description`, `item_id`, `quantity`, `rate` and `taxable`.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
# Prerequisites
|
||||||
|
|
||||||
|
Before installing the plugin:
|
||||||
|
|
||||||
|
1. Create a QuickBooks developer account:
|
||||||
|
|
||||||
|
|
||||||
|
[https://developer.intuit.com/](https://developer.intuit.com/)
|
||||||
|
|
||||||
|
2. Create an **Intuit application** to obtain:
|
||||||
|
|
||||||
|
|
||||||
|
* Client ID
|
||||||
|
|
||||||
|
* Client Secret
|
||||||
|
|
||||||
|
|
||||||
|
3. Configure the QuickBooks webhook endpoint:
|
||||||
|
|
||||||
|
|
||||||
|
https://redmine.yourdomain.com/qbo/webhook
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
# Installation
|
||||||
|
|
||||||
|
## 1. Clone the Plugin
|
||||||
|
|
||||||
|
Install the plugin into your Redmine plugins directory.
|
||||||
|
|
||||||
|
```bash
|
||||||
|
cd /path/to/redmine/plugins
|
||||||
|
git clone https://github.com/rickbarrette/redmine_qbo.git
|
||||||
|
cd redmine_qbo
|
||||||
|
git checkout <tag>
|
||||||
|
```
|
||||||
|
|
||||||
|
Use a **tagged release** for stability.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 2. Install Dependencies
|
||||||
|
|
||||||
|
```bash
|
||||||
|
bundle install
|
||||||
|
```
|
||||||
|
|
||||||
|
Required for **Redmine 6 / Rails 7 compatibility**.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 3. Run Database Migrations
|
||||||
|
|
||||||
|
```bash
|
||||||
|
bundle exec rake redmine:plugins:migrate RAILS_ENV=production
|
||||||
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 4. Restart Redmine
|
||||||
|
|
||||||
|
Restart your Redmine server so the plugin and hooks are loaded.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
# Configuration
|
||||||
|
|
||||||
|
1. Navigate to:
|
||||||
|
|
||||||
|
|
||||||
|
Administration → Plugins → Configure
|
||||||
|
|
||||||
|
2. Enter your **QuickBooks Client ID and Client Secret**.
|
||||||
|
|
||||||
|
3. Save the configuration.
|
||||||
|
|
||||||
|
4. Click **Authenticate** to complete the OAuth connection with QuickBooks Online.
|
||||||
|
|
||||||
|
|
||||||
|
Once authentication succeeds, the plugin performs an **initial synchronization**.
|
||||||
|
|
||||||
|
The settings page has three sections:
|
||||||
|
|
||||||
|
* **QuickBooks connection**: client ID and secret, webhook token, sandbox, when the access token expires, and Connect to QuickBooks.
|
||||||
|
* **Synchronization**: customers, employees, estimates, invoices, payments, products/services (items) and accounts, with how many of each are stored, when each last synced and a **Sync** link for each (it re-reads every record of that type). **Sync changes** reads only what changed since the last sync; **Full sync** re-reads everything. The default income account for new products/services is shown here too.
|
||||||
|
* **Billing**: estimate expiration, the labor products/services and the issues-from-estimates defaults.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
# User Mapping
|
||||||
|
|
||||||
|
Each Redmine user must be mapped to a QuickBooks Employee.
|
||||||
|
|
||||||
|
Navigate to:
|
||||||
|
|
||||||
|
Administration → Users
|
||||||
|
|
||||||
|
Then assign the corresponding **QuickBooks Employee** to each user.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
# Usage
|
||||||
|
|
||||||
|
To enable automatic billing:
|
||||||
|
|
||||||
|
1. Assign a **Customer** to an Issue.
|
||||||
|
|
||||||
|
2. Log billable time using **Redmine Time Entries**.
|
||||||
|
|
||||||
|
3. Close the Issue.
|
||||||
|
|
||||||
|
|
||||||
|
When the Issue is closed, the plugin automatically generates the corresponding **Time Activity entries in QuickBooks Online**.
|
||||||
|
|
||||||
|
After the initial synchronization, the plugin receives updates through **Intuit webhooks**.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
# Troubleshooting
|
||||||
|
|
||||||
|
### Time Activities Not Created
|
||||||
|
|
||||||
|
Verify that:
|
||||||
|
|
||||||
|
* The Issue has a **Customer assigned**
|
||||||
|
|
||||||
|
* Time Entries exist for the Issue
|
||||||
|
|
||||||
|
* Activity names match **QuickBooks Item names**
|
||||||
|
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### Webhooks Not Triggering
|
||||||
|
|
||||||
|
Ensure the QuickBooks webhook endpoint is reachable:
|
||||||
|
|
||||||
|
https://redmine.yourdomain.com/qbo/webhook
|
||||||
|
|
||||||
|
Also verify webhook configuration in the Intuit developer dashboard.
|
||||||
|
|
||||||
## License
|
## License
|
||||||
|
|
||||||
|
|||||||
|
After Width: | Height: | Size: 724 KiB |
|
After Width: | Height: | Size: 520 KiB |
|
Before Width: | Height: | Size: 346 KiB After Width: | Height: | Size: 269 KiB |
|
Before Width: | Height: | Size: 303 KiB After Width: | Height: | Size: 539 KiB |
|
Before Width: | Height: | Size: 240 KiB |
|
Before Width: | Height: | Size: 512 KiB |
@@ -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_back fallback_location: home_path, flash: { notice: I18n.t(:label_syncing) }
|
||||||
|
end
|
||||||
|
end
|
||||||
@@ -0,0 +1,75 @@
|
|||||||
|
#The MIT License (MIT)
|
||||||
|
#
|
||||||
|
#Copyright (c) 2026 rick barrette
|
||||||
|
#
|
||||||
|
#Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
|
||||||
|
#
|
||||||
|
#The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
|
||||||
|
#
|
||||||
|
#THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
||||||
|
|
||||||
|
# Drafts on the new estimate and new invoice editors (see QboDraft). "Save draft" keeps what's filled in, even
|
||||||
|
# if it isn't complete, and reopens it (new?draft_id=). Saving to QuickBooks deletes the draft.
|
||||||
|
module QboDraftHandling
|
||||||
|
extend ActiveSupport::Concern
|
||||||
|
|
||||||
|
private
|
||||||
|
|
||||||
|
# The draft named by draft_id (in the URL, or the editor's hidden field), if the user may open it
|
||||||
|
def find_draft(document)
|
||||||
|
@draft = (QboDraft.visible.for_document(document).find_by(id: params[:draft_id]) if params[:draft_id].present?)
|
||||||
|
end
|
||||||
|
|
||||||
|
# The editor form filled in from a draft, with the details the editor shows but doesn't post
|
||||||
|
def form_from_draft(draft)
|
||||||
|
form = draft.form
|
||||||
|
customer = Customer.find_by(id: form.customer_id) if form.customer_id.present?
|
||||||
|
if customer
|
||||||
|
form.billing_address = RedmineQboBilling::EstimateWriter.customer_address(customer)
|
||||||
|
form.customer_name = customer.name if form.customer_name.blank?
|
||||||
|
end
|
||||||
|
# Invoices keep the sales person shown on the editor (e.g. from an estimate); estimates are always the user's
|
||||||
|
form.sales_person = (draft.invoice? && draft.fields['sales_person'].presence) || User.current.name
|
||||||
|
form.lines = form.lines.reject(&:blank?)
|
||||||
|
form.lines += Array.new([2 - form.lines.size, 1].max) { RedmineQboBilling::EstimateForm::Line.new(quantity: '', taxable: true) }
|
||||||
|
form
|
||||||
|
end
|
||||||
|
|
||||||
|
# Saves what's on the editor as a draft (no checks: a draft can be missing anything) and reopens it
|
||||||
|
def save_draft(document, fields)
|
||||||
|
draft = @draft || QboDraft.new(document: document)
|
||||||
|
fields = fields.to_h.stringify_keys
|
||||||
|
draft.fields = fields
|
||||||
|
draft.customer_id = (Customer.where(id: fields['customer_id']).pick(:id) if fields['customer_id'].present?)
|
||||||
|
draft.user = User.current
|
||||||
|
draft.save!
|
||||||
|
flash[:notice] = l(:notice_qbo_draft_saved)
|
||||||
|
redirect_to draft_editor_path(draft)
|
||||||
|
end
|
||||||
|
|
||||||
|
# Saved to QuickBooks: the draft isn't needed any more
|
||||||
|
def discard_draft
|
||||||
|
@draft&.destroy
|
||||||
|
@draft = nil
|
||||||
|
end
|
||||||
|
|
||||||
|
# A new document for a customer who already has drafts of it: the editor points them out
|
||||||
|
def load_customer_drafts(document, customer_id)
|
||||||
|
@customer_drafts =
|
||||||
|
if @draft.nil? && customer_id.present?
|
||||||
|
QboDraft.visible.for_document(document).where(customer_id: customer_id).newest_first.to_a
|
||||||
|
else
|
||||||
|
[]
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
# A draft_id that's gone (e.g. finished or deleted by someone else): say so and list the drafts
|
||||||
|
def draft_missing
|
||||||
|
flash[:error] = l(:error_qbo_draft_not_found)
|
||||||
|
redirect_to qbo_drafts_path
|
||||||
|
end
|
||||||
|
|
||||||
|
def draft_editor_path(draft)
|
||||||
|
draft.invoice? ? new_qbo_invoice_path(draft_id: draft.id) : new_qbo_estimate_path(draft_id: draft.id)
|
||||||
|
end
|
||||||
|
end
|
||||||
@@ -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.
|
#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
|
class CustomersController < ApplicationController
|
||||||
|
|
||||||
include AuthHelper
|
include AuthHelper
|
||||||
@@ -26,205 +25,236 @@ class CustomersController < ApplicationController
|
|||||||
include SortHelper
|
include SortHelper
|
||||||
helper :timelog
|
helper :timelog
|
||||||
|
|
||||||
before_action :add_customer, only: :new
|
# This tells Redmine to check global permissions for the current controller/action
|
||||||
before_action :view_customer, except: [:new, :view]
|
# 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]
|
skip_before_action :verify_authenticity_token, :check_if_login_required, only: [:view]
|
||||||
|
|
||||||
default_search_scope :names
|
def address_to_s(address)
|
||||||
|
return if address.nil?
|
||||||
|
|
||||||
autocomplete :customer, :name, full: true, extra_data: [:id]
|
lines = [
|
||||||
|
address.line1,
|
||||||
|
address.line2,
|
||||||
|
address.line3,
|
||||||
|
address.line4,
|
||||||
|
address.line5
|
||||||
|
].compact_blank
|
||||||
|
|
||||||
|
city_line = [
|
||||||
|
address.city,
|
||||||
|
address.country_sub_division_code,
|
||||||
|
address.postal_code
|
||||||
|
].compact_blank.join(" ")
|
||||||
|
|
||||||
|
lines << city_line unless city_line.blank?
|
||||||
|
|
||||||
|
lines.join("\n")
|
||||||
|
end
|
||||||
|
|
||||||
|
def add_customer
|
||||||
|
global_check_permission(:add_customers)
|
||||||
|
end
|
||||||
|
|
||||||
def allowed_params
|
def allowed_params
|
||||||
params.require(:customer).permit(:name, :email, :primary_phone, :mobile_phone, :phone_number, :notes)
|
params.require(:customer).permit(:name, :email, :primary_phone, :mobile_phone, :phone_number, :notes)
|
||||||
end
|
end
|
||||||
|
|
||||||
# getter method for a customer's invoices
|
# Used for autocomplete forms. Fuzzy matching (nicknames, typos, word order, phone digits) helps
|
||||||
# used for customer autocomplete field / issue form
|
# staff spot an existing customer before creating a duplicate. See CustomerSearchService.
|
||||||
def filter_invoices_by_customer
|
def autocomplete
|
||||||
@filtered_invoices = Invoice.all.where(customer_id: params[:selected_customer])
|
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 }
|
||||||
|
}
|
||||||
|
end
|
||||||
|
|
||||||
|
def create
|
||||||
|
@customer = Customer.new(allowed_params)
|
||||||
|
|
||||||
|
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}"
|
||||||
|
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
|
||||||
|
@customer = Customer.find_by_id(params[:id])
|
||||||
|
return render_404 unless @customer
|
||||||
|
rescue => e
|
||||||
|
log "Failed to edit customer"
|
||||||
|
flash[:error] = e.message
|
||||||
|
render_404
|
||||||
end
|
end
|
||||||
|
|
||||||
# getter method for a customer's estimates
|
|
||||||
# used for customer autocomplete field / issue form
|
|
||||||
def filter_estimates_by_customer
|
def filter_estimates_by_customer
|
||||||
@filtered_estimates = Estimate.all.where(customer_id: params[:selected_customer])
|
@filtered_estimates = Estimate.all.where(customer_id: params[:selected_customer])
|
||||||
end
|
end
|
||||||
|
|
||||||
# display a list of all customers
|
def filter_invoices_by_customer
|
||||||
|
@filtered_invoices = Invoice.all.where(customer_id: params[:selected_customer])
|
||||||
|
end
|
||||||
|
|
||||||
|
# Most matches a search lists (best first)
|
||||||
|
SEARCH_LIMIT = 200
|
||||||
|
|
||||||
|
# Every customer, sortable and paged like Redmine's lists; a search narrows it to the best matches (a single
|
||||||
|
# match opens that customer). Sorting a search's results by a column replaces the best-first order.
|
||||||
def index
|
def index
|
||||||
if params[:search]
|
sort_init 'name', 'asc'
|
||||||
@customers = Customer.search(params[:search]).paginate(page: params[:page])
|
sort_update 'name' => "#{Customer.table_name}.name",
|
||||||
if only_one_non_zero?(@customers)
|
'phone' => "#{Customer.table_name}.phone_number",
|
||||||
redirect_to @customers.first
|
'mobile' => "#{Customer.table_name}.mobile_phone_number",
|
||||||
end
|
'updated' => "#{Customer.table_name}.updated_at"
|
||||||
|
|
||||||
|
@search = params[:search].to_s.strip
|
||||||
|
if @search.present?
|
||||||
|
scope = CustomerSearchService.call(name: @search, limit: SEARCH_LIMIT)
|
||||||
|
@best_first = params[:sort].blank?
|
||||||
|
else
|
||||||
|
scope = Customer.all
|
||||||
end
|
end
|
||||||
|
scope = scope.reorder(sort_clause).order(:id) unless @best_first
|
||||||
|
|
||||||
|
@customer_count = scope.count
|
||||||
|
return redirect_to(scope.first) if @search.present? && @customer_count == 1
|
||||||
|
|
||||||
|
@customer_pages = Paginator.new @customer_count, per_page_option, params['page']
|
||||||
|
@customers = scope.limit(@customer_pages.per_page).offset(@customer_pages.offset).to_a
|
||||||
|
@issue_counts = Issue.where(customer_id: @customers.map(&:id)).group(:customer_id).count
|
||||||
|
end
|
||||||
|
|
||||||
|
def load_issue_data
|
||||||
|
@journals = @issue.journals.preload(:details).preload(user: :email_address).reorder(:created_on, :id).to_a
|
||||||
|
|
||||||
|
@journals.each_with_index { |j, i| j.indice = i + 1 }
|
||||||
|
@journals.reject!(&:private_notes?) unless User.current.allowed_to?(:view_private_notes, @issue.project)
|
||||||
|
Journal.preload_journals_details_custom_fields(@journals)
|
||||||
|
@journals.select! { |journal| journal.notes? || journal.visible_details.any? }
|
||||||
|
@journals.reverse! if User.current.wants_comments_in_reverse_order?
|
||||||
|
|
||||||
|
@changesets = @issue.changesets.visible.preload(:repository, :user).to_a
|
||||||
|
@changesets.reverse! if User.current.wants_comments_in_reverse_order?
|
||||||
|
|
||||||
|
@relations = @issue.relations.select { |r| r.other_issue(@issue)&.visible? }
|
||||||
|
@allowed_statuses = @issue.new_statuses_allowed_to(User.current)
|
||||||
|
@priorities = IssuePriority.active
|
||||||
|
@time_entry = TimeEntry.new(issue: @issue, project: @issue.project)
|
||||||
|
@relation = IssueRelation.new
|
||||||
|
end
|
||||||
|
|
||||||
|
def log(msg)
|
||||||
|
Rails.logger.info "[CustomersController] #{msg}"
|
||||||
end
|
end
|
||||||
|
|
||||||
# initialize a new customer
|
|
||||||
def new
|
def new
|
||||||
@customer = Customer.new
|
@customer = Customer.new
|
||||||
|
|
||||||
|
if request.xhr?
|
||||||
|
render partial: 'form', layout: false, locals: { hide_submit: true, hide_toolbar: true }
|
||||||
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
# create a new customer
|
def share
|
||||||
def create
|
issue = Issue.visible.find(params[:id])
|
||||||
@customer = Customer.new(allowed_params)
|
token = issue.share_token
|
||||||
if @customer.save
|
return render_403 unless token
|
||||||
flash[:notice] = t :notice_customer_created
|
|
||||||
|
redirect_to view_path(token.token)
|
||||||
|
rescue ActiveRecord::RecordNotFound
|
||||||
|
flash[:error] = t(:notice_issue_not_found)
|
||||||
|
render_404
|
||||||
|
end
|
||||||
|
|
||||||
|
def show
|
||||||
|
@customer = Customer.find_by_id(params[:id])
|
||||||
|
return render_404 unless @customer
|
||||||
|
|
||||||
|
@open_issues = @customer.issues
|
||||||
|
.joins(:status)
|
||||||
|
.includes(:status, :project, :tracker, :priority)
|
||||||
|
.where(issue_statuses: { is_closed: false })
|
||||||
|
.order(id: :desc)
|
||||||
|
|
||||||
|
@closed_issues = @customer.issues
|
||||||
|
.joins(:status)
|
||||||
|
.includes(:status, :project, :tracker, :priority)
|
||||||
|
.where(issue_statuses: { is_closed: true })
|
||||||
|
.order(id: :desc)
|
||||||
|
|
||||||
|
@hours = TimeEntry
|
||||||
|
.joins(:issue)
|
||||||
|
.where(issues: { id: @open_issues.select(:id) })
|
||||||
|
.sum(:hours)
|
||||||
|
|
||||||
|
@closed_hours = TimeEntry
|
||||||
|
.joins(:issue)
|
||||||
|
.where(issues: { id: @closed_issues.select(:id) })
|
||||||
|
.sum(:hours)
|
||||||
|
|
||||||
|
rescue => e
|
||||||
|
Rails.logger.error "Failed to load customer ##{params[:id]}: #{e.message}\n#{e.backtrace.join("\n")}"
|
||||||
|
flash[:error] = e.message
|
||||||
|
render_404
|
||||||
|
end
|
||||||
|
|
||||||
|
def sync
|
||||||
|
Customer.sync
|
||||||
|
redirect_back fallback_location: home_path, flash: { notice: I18n.t(:label_syncing) }
|
||||||
|
end
|
||||||
|
|
||||||
|
def update
|
||||||
|
@customer = Customer.find_by_id(params[:id])
|
||||||
|
return render_404 unless @customer
|
||||||
|
|
||||||
|
if @customer.update(allowed_params)
|
||||||
|
flash[:notice] = t :notice_customer_updated
|
||||||
redirect_to @customer
|
redirect_to @customer
|
||||||
else
|
else
|
||||||
flash[:error] = @customer.errors.full_messages.to_sentence
|
render :edit, status: :unprocessable_entity
|
||||||
redirect_to new_customer_path
|
|
||||||
end
|
end
|
||||||
|
rescue => e
|
||||||
|
log "Failed to update customer: #{e.message}"
|
||||||
|
flash[:error] = e.message
|
||||||
|
redirect_to edit_customer_path
|
||||||
end
|
end
|
||||||
|
|
||||||
# display a specific customer
|
|
||||||
def show
|
|
||||||
begin
|
|
||||||
@customer = Customer.find_by_id(params[:id])
|
|
||||||
@issues = @customer.issues.order(id: :desc)
|
|
||||||
@billing_address = address_to_s(@customer.billing_address)
|
|
||||||
@shipping_address = address_to_s(@customer.shipping_address)
|
|
||||||
@closed_issues = (@issues - @issues.open)
|
|
||||||
@hours = 0
|
|
||||||
@closed_hours = 0
|
|
||||||
@issues.open.each { |i| @hours+= i.total_spent_hours }
|
|
||||||
@closed_issues.each { |i| @closed_hours+= i.total_spent_hours }
|
|
||||||
rescue
|
|
||||||
flash[:error] = t :notice_customer_not_found
|
|
||||||
render_404
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
# return an HTML form for editing a customer
|
|
||||||
def edit
|
|
||||||
begin
|
|
||||||
@customer = Customer.find_by_id(params[:id])
|
|
||||||
rescue
|
|
||||||
flash[:error] = t :notice_customer_not_found
|
|
||||||
render_404
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
# update a specific customer
|
|
||||||
def update
|
|
||||||
begin
|
|
||||||
@customer = Customer.find_by_id(params[:id])
|
|
||||||
if @customer.update(allowed_params)
|
|
||||||
flash[:notice] = t :notice_customer_updated
|
|
||||||
redirect_to @customer
|
|
||||||
else
|
|
||||||
redirect_to edit_customer_path
|
|
||||||
flash[:error] = @customer.errors.full_messages.to_sentence if @customer.errors
|
|
||||||
end
|
|
||||||
rescue
|
|
||||||
flash[:error] = t :notice_customer_not_found
|
|
||||||
render_404
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
# delete a customer
|
|
||||||
def destroy
|
|
||||||
begin
|
|
||||||
Customer.find_by_id(params[:id]).destroy
|
|
||||||
flash[:notice] = t :notice_customer_deleted
|
|
||||||
redirect_to action: :index
|
|
||||||
rescue
|
|
||||||
flash[:error] = t :notice_customer_not_deleted
|
|
||||||
render_404
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
# creates new customer view tokens, removes expired tokens & redirects to newly created customer view with new token.
|
|
||||||
def share
|
|
||||||
|
|
||||||
Thread.new do
|
|
||||||
logger.info "Removing expired customer tokens"
|
|
||||||
CustomerToken.remove_expired_tokens
|
|
||||||
ActiveRecord::Base.connection.close
|
|
||||||
end
|
|
||||||
|
|
||||||
begin
|
|
||||||
issue = Issue.find_by_id(params[:id])
|
|
||||||
redirect_to view_path issue.share_token.token
|
|
||||||
rescue
|
|
||||||
flash[:error] = t :notice_issue_not_found
|
|
||||||
render_404
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
# displays an issue for a customer with a provided security CustomerToken
|
|
||||||
def view
|
def view
|
||||||
|
User.current = User.anonymous
|
||||||
User.current = User.find_by lastname: 'Anonymous'
|
@token = CustomerToken.active.find_by(token: params[:token])
|
||||||
|
return render_403 unless @token
|
||||||
@token = CustomerToken.find_by token: params[:token]
|
@issue = @token.issue
|
||||||
begin
|
return render_403 unless @issue
|
||||||
@token.destroy if @token.expired?
|
session[:token] = @token.token
|
||||||
raise "Token Expired" if @token.destroyed
|
load_issue_data
|
||||||
|
rescue ActiveRecord::RecordNotFound
|
||||||
session[:token] = @token.token
|
render_403
|
||||||
@issue = Issue.find @token.issue_id
|
|
||||||
@journals = @issue.journals.
|
|
||||||
preload(:details).
|
|
||||||
preload(user: :email_address).
|
|
||||||
reorder(:created_on, :id).to_a
|
|
||||||
@journals.each_with_index {|j,i| j.indice = i+1}
|
|
||||||
@journals.reject!(&:private_notes?) unless User.current.allowed_to?(:view_private_notes, @issue.project)
|
|
||||||
Journal.preload_journals_details_custom_fields(@journals)
|
|
||||||
@journals.select! {|journal| journal.notes? || journal.visible_details.any?}
|
|
||||||
@journals.reverse! if User.current.wants_comments_in_reverse_order?
|
|
||||||
|
|
||||||
@changesets = @issue.changesets.visible.preload(:repository, :user).to_a
|
|
||||||
@changesets.reverse! if User.current.wants_comments_in_reverse_order?
|
|
||||||
|
|
||||||
@relations = @issue.relations.select {|r| r.other_issue(@issue) && r.other_issue(@issue).visible? }
|
|
||||||
@allowed_statuses = @issue.new_statuses_allowed_to(User.current)
|
|
||||||
@priorities = IssuePriority.active
|
|
||||||
@time_entry = TimeEntry.new(issue: @issue, project: @issue.project)
|
|
||||||
@relation = IssueRelation.new
|
|
||||||
rescue
|
|
||||||
flash[:error] = t :notice_forbidden
|
|
||||||
render_403
|
|
||||||
end
|
|
||||||
end
|
end
|
||||||
|
|
||||||
private
|
|
||||||
|
|
||||||
# redmine permission - add customers
|
|
||||||
def add_customer
|
|
||||||
global_check_permission(:add_customers)
|
|
||||||
end
|
|
||||||
|
|
||||||
# redmine permission - view customers
|
|
||||||
def view_customer
|
def view_customer
|
||||||
global_check_permission(:view_customers)
|
global_check_permission(:view_customers)
|
||||||
end
|
end
|
||||||
|
|
||||||
# checks to see if there is only one item in an array
|
|
||||||
# @return true if array only has one item
|
|
||||||
def only_one_non_zero?( array )
|
|
||||||
found_non_zero = false
|
|
||||||
array.each do |val|
|
|
||||||
if val!=0
|
|
||||||
return false if found_non_zero
|
|
||||||
found_non_zero = true
|
|
||||||
end
|
|
||||||
end
|
|
||||||
found_non_zero
|
|
||||||
end
|
|
||||||
|
|
||||||
# format a quickbooks address to a human readable string
|
|
||||||
def address_to_s (address)
|
|
||||||
return if address.nil?
|
|
||||||
string = address.line1 if address.line1
|
|
||||||
string << "\n" + address.line2 if address.line2
|
|
||||||
string << "\n" + address.line3 if address.line3
|
|
||||||
string << "\n" + address.line4 if address.line4
|
|
||||||
string << "\n" + address.line5 if address.line5
|
|
||||||
string << " " + address.city if address.city
|
|
||||||
string << ", " + address.country_sub_division_code if address.country_sub_division_code
|
|
||||||
string << " " + address.postal_code if address.postal_code
|
|
||||||
return string
|
|
||||||
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.
|
||||||
|
class EmployeesController < ApplicationController
|
||||||
|
include AuthHelper
|
||||||
|
|
||||||
|
# Syncing is admin-only
|
||||||
|
before_action :require_admin
|
||||||
|
|
||||||
|
def sync
|
||||||
|
Employee.sync
|
||||||
|
redirect_back fallback_location: home_path, flash: { notice: I18n.t(:label_syncing) }
|
||||||
|
end
|
||||||
|
|
||||||
|
private
|
||||||
|
|
||||||
|
# Logs messages with a consistent prefix for easier debugging.
|
||||||
|
def log(msg)
|
||||||
|
Rails.logger.info "[EmployeeController] #{msg}"
|
||||||
|
end
|
||||||
|
end
|
||||||
@@ -1,58 +0,0 @@
|
|||||||
#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.
|
|
||||||
class EstimateController < ApplicationController
|
|
||||||
|
|
||||||
include AuthHelper
|
|
||||||
|
|
||||||
before_action :require_user, unless: proc {|c| session[:token].nil? }
|
|
||||||
skip_before_action :verify_authenticity_token, :check_if_login_required, unless: proc {|c| session[:token].nil? }
|
|
||||||
|
|
||||||
def get_estimate
|
|
||||||
# Force sync for estimate by doc number if not found
|
|
||||||
if Estimate.find_by_doc_number(params[:search]).nil?
|
|
||||||
begin
|
|
||||||
Estimate.sync_by_doc_number(params[:search]) if params[:search]
|
|
||||||
rescue
|
|
||||||
logger.info "Estimate.find_by_doc_number failed"
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
estimate = Estimate.find_by_id(params[:id]) if params[:id]
|
|
||||||
estimate = Estimate.find_by_doc_number(params[:search]) if params[:search]
|
|
||||||
return estimate
|
|
||||||
end
|
|
||||||
|
|
||||||
#
|
|
||||||
# Downloads and forwards the estimate pdf
|
|
||||||
#
|
|
||||||
def show
|
|
||||||
estimate = get_estimate
|
|
||||||
|
|
||||||
begin
|
|
||||||
send_data estimate.pdf, filename: "estimate #{estimate.doc_number}.pdf", disposition: :inline, type: "application/pdf"
|
|
||||||
rescue
|
|
||||||
redirect_to :back, flash: { error: I18n.t(:notice_estimate_not_found) }
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
#
|
|
||||||
# Downloads estimate by document number
|
|
||||||
#
|
|
||||||
def doc
|
|
||||||
estimate = get_estimate
|
|
||||||
|
|
||||||
begin
|
|
||||||
send_data estimate.pdf, filename: "estimate #{estimate.doc_number}.pdf", disposition: :inline, type: "application/pdf"
|
|
||||||
rescue
|
|
||||||
redirect_to :back, flash: { error: I18n.t(:notice_estimate_not_found) }
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
end
|
|
||||||
@@ -0,0 +1,108 @@
|
|||||||
|
#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.
|
||||||
|
class EstimatesController < ApplicationController
|
||||||
|
include AuthHelper
|
||||||
|
|
||||||
|
# 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
|
||||||
|
render_pdf(@estimate)
|
||||||
|
end
|
||||||
|
|
||||||
|
# Displays the estimate PDF in the browser or redirects with an error if not found.
|
||||||
|
def show
|
||||||
|
render_pdf(@estimate)
|
||||||
|
end
|
||||||
|
|
||||||
|
def sync
|
||||||
|
Estimate.sync
|
||||||
|
redirect_back fallback_location: home_path, flash: { notice: I18n.t(:label_syncing) }
|
||||||
|
end
|
||||||
|
|
||||||
|
private
|
||||||
|
|
||||||
|
# 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
|
||||||
|
redirect_back fallback_location: root_path, flash: { error: I18n.t(:notice_estimate_not_found) }
|
||||||
|
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?
|
||||||
|
return Estimate.find_by(id: params[:id]) if params[:id].present?
|
||||||
|
end
|
||||||
|
|
||||||
|
# If the estimate is not found locally, attempts to sync it from the source and find it again.
|
||||||
|
def sync_and_find_estimate
|
||||||
|
|
||||||
|
if params[:search].present?
|
||||||
|
log "Estimate #{params[:search]} not found locally. Syncing by doc number."
|
||||||
|
Estimate.sync_by_doc_number(params[:search])
|
||||||
|
return Estimate.find_by(doc_number: params[:search])
|
||||||
|
end
|
||||||
|
|
||||||
|
if params[:id].present?
|
||||||
|
log "Estimate #{params[:id]} not found locally. Syncing by ID."
|
||||||
|
Estimate.sync_by_id(params[:id])
|
||||||
|
return Estimate.find_by(id: params[:id])
|
||||||
|
end
|
||||||
|
|
||||||
|
nil
|
||||||
|
rescue StandardError => e
|
||||||
|
log "Estimate sync failed: #{e.message}"
|
||||||
|
nil
|
||||||
|
end
|
||||||
|
|
||||||
|
# Renders the estimate PDF or redirects with an error if rendering fails.
|
||||||
|
def render_pdf(estimate)
|
||||||
|
pdf, ref = PdfService.new(entity: Estimate).fetch_pdf(doc_ids: [estimate.id])
|
||||||
|
send_data( pdf, filename: "estimate #{ref}.pdf", disposition: :inline, type: "application/pdf" )
|
||||||
|
rescue StandardError => e
|
||||||
|
log "PDF render failed for Estimate #{estimate&.id}: #{e.message}"
|
||||||
|
redirect_back fallback_location: root_path, flash: { error: I18n.t(:notice_estimate_not_found) }
|
||||||
|
end
|
||||||
|
|
||||||
|
# Logs messages with a consistent prefix for easier debugging.
|
||||||
|
def log(msg)
|
||||||
|
Rails.logger.info "[EstimateController] #{msg}"
|
||||||
|
end
|
||||||
|
end
|
||||||
@@ -1,54 +0,0 @@
|
|||||||
#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.
|
|
||||||
class InvoiceController < ApplicationController
|
|
||||||
|
|
||||||
include AuthHelper
|
|
||||||
require 'combine_pdf'
|
|
||||||
|
|
||||||
before_action :require_user, unless: proc {|c| session[:token].nil? }
|
|
||||||
skip_before_action :verify_authenticity_token, :check_if_login_required, unless: proc {|c| session[:token].nil? }
|
|
||||||
|
|
||||||
#
|
|
||||||
# Downloads and forwards the invoice pdf
|
|
||||||
#
|
|
||||||
def show
|
|
||||||
logger.info("Processing request for URL: #{request.original_url}")
|
|
||||||
begin
|
|
||||||
qbo = Qbo.first
|
|
||||||
qbo.perform_authenticated_request do |access_token|
|
|
||||||
service = Quickbooks::Service::Invoice.new(company_id: qbo.realm_id, access_token: access_token)
|
|
||||||
|
|
||||||
# If multiple id's then pull each pdf & combine them
|
|
||||||
if params[:invoice_ids]
|
|
||||||
logger.info("Grabbing pdfs for " + params[:invoice_ids].join(', '))
|
|
||||||
ref = ""
|
|
||||||
params[:invoice_ids].each do |i|
|
|
||||||
logger.info("processing " + i)
|
|
||||||
invoice = service.fetch_by_id(i)
|
|
||||||
ref += " #{invoice.doc_number}"
|
|
||||||
@pdf << CombinePDF.parse(service.pdf(invoice)) unless @pdf.nil?
|
|
||||||
if @pdf.nil?
|
|
||||||
@pdf = CombinePDF.parse(service.pdf(invoice))
|
|
||||||
end
|
|
||||||
end
|
|
||||||
@pdf = @pdf.to_pdf
|
|
||||||
else
|
|
||||||
invoice = service.fetch_by_id(params[:id])
|
|
||||||
@pdf = service.pdf(invoice)
|
|
||||||
ref = invoice.doc_number
|
|
||||||
end
|
|
||||||
|
|
||||||
send_data @pdf, filename: "invoice #{ref}.pdf", disposition: :inline, type: "application/pdf"
|
|
||||||
end
|
|
||||||
rescue
|
|
||||||
redirect_to :back, flash: { error: I18n.t(:notice_invoice_not_found) }
|
|
||||||
end
|
|
||||||
end
|
|
||||||
end
|
|
||||||
@@ -0,0 +1,58 @@
|
|||||||
|
#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.
|
||||||
|
class InvoicesController < ApplicationController
|
||||||
|
include AuthHelper
|
||||||
|
|
||||||
|
# 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}"
|
||||||
|
|
||||||
|
pdf, ref = PdfService.new(entity: Invoice).fetch_pdf(doc_ids: invoice_ids)
|
||||||
|
|
||||||
|
send_data pdf, filename: "invoice #{ref}.pdf", disposition: :inline, type: "application/pdf"
|
||||||
|
|
||||||
|
rescue StandardError => e
|
||||||
|
log "Invoice PDF failure: #{e.message}"
|
||||||
|
redirect_back fallback_location: root_path, flash: { error: I18n.t(:notice_invoice_not_found) }
|
||||||
|
end
|
||||||
|
|
||||||
|
def sync
|
||||||
|
Invoice.sync
|
||||||
|
redirect_back fallback_location: home_path, flash: { notice: I18n.t(:label_syncing) }
|
||||||
|
end
|
||||||
|
|
||||||
|
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}"
|
||||||
|
end
|
||||||
|
end
|
||||||
@@ -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}%")
|
||||||
|
.merge(Item.sellable)
|
||||||
|
.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_back fallback_location: home_path, 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
|
||||||
@@ -9,149 +9,89 @@
|
|||||||
#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 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 QboController < ApplicationController
|
class QboController < ApplicationController
|
||||||
|
|
||||||
require 'openssl'
|
|
||||||
|
|
||||||
include AuthHelper
|
include AuthHelper
|
||||||
|
|
||||||
before_action :require_user, except: :webhook
|
# Connecting to QuickBooks and syncing are admin-only. Billing needs the "Bill issues" permission.
|
||||||
skip_before_action :verify_authenticity_token, :check_if_login_required, only: [:webhook]
|
# 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
|
||||||
|
|
||||||
def allowed_params
|
# Session key for the OAuth "state" value, which ties the callback to the admin who started connecting
|
||||||
params.permit(:code, :state, :realmId, :id)
|
OAUTH_STATE_SESSION_KEY = :qbo_oauth_state
|
||||||
end
|
|
||||||
|
|
||||||
#
|
# 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.
|
||||||
# Called when the user requests that Redmine to connect to QBO
|
|
||||||
#
|
|
||||||
def authenticate
|
def authenticate
|
||||||
redirect_uri = "#{Setting.protocol}://#{Setting.host_name + qbo_oauth_callback_path}"
|
state = SecureRandom.urlsafe_base64(32)
|
||||||
logger.info "redirect_uri: #{redirect_uri}"
|
session[OAUTH_STATE_SESSION_KEY] = state
|
||||||
oauth2_client = Qbo.construct_oauth2_client
|
redirect_to QboOauthService.authorization_url(callback_url: callback_url, state: state), allow_other_host: true
|
||||||
grant_url = oauth2_client.auth_code.authorize_url(redirect_uri: redirect_uri, response_type: "code", state: SecureRandom.hex(12), scope: "com.intuit.quickbooks.accounting")
|
|
||||||
redirect_to grant_url
|
|
||||||
end
|
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.
|
||||||
# Called by QBO after authentication has been processed
|
|
||||||
#
|
|
||||||
def oauth_callback
|
def oauth_callback
|
||||||
if params[:state].present?
|
# Only accept a callback for a connection this admin started (prevents swapping in another QBO company)
|
||||||
oauth2_client = Qbo.construct_oauth2_client
|
expected_state = session.delete(OAUTH_STATE_SESSION_KEY).to_s
|
||||||
# use the state value to retrieve from your backend any information you need to identify the customer in your system
|
unless expected_state.present? && ActiveSupport::SecurityUtils.secure_compare(expected_state, params[:state].to_s)
|
||||||
redirect_uri = "#{Setting.protocol}://#{Setting.host_name + qbo_oauth_callback_path}"
|
log "OAuth callback rejected: state did not match"
|
||||||
if resp = oauth2_client.auth_code.get_token(params[:code], redirect_uri: redirect_uri)
|
return redirect_to plugin_settings_path(:redmine_qbo), flash: { error: I18n.t(:notice_qbo_oauth_state_mismatch) }
|
||||||
|
|
||||||
# Remove the last authentication information
|
|
||||||
Qbo.delete_all
|
|
||||||
|
|
||||||
# Save the authentication information
|
|
||||||
qbo = Qbo.new
|
|
||||||
qbo.update(oauth2_access_token: resp.token, oauth2_refresh_token: resp.refresh_token, realm_id: params[:realmId])
|
|
||||||
qbo.refresh_token!
|
|
||||||
|
|
||||||
if qbo.save!
|
|
||||||
redirect_to qbo_sync_path, flash: { notice: I18n.t(:label_connected) }
|
|
||||||
else
|
|
||||||
redirect_to plugin_settings_path(:redmine_qbo), flash: { error: I18n.t(:label_error) }
|
|
||||||
end
|
|
||||||
|
|
||||||
end
|
|
||||||
end
|
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) }
|
||||||
|
|
||||||
|
rescue StandardError => e
|
||||||
|
log "OAuth failure: #{e.message}"
|
||||||
|
redirect_to plugin_settings_path(:redmine_qbo), flash: { error: I18n.t(:label_error) }
|
||||||
end
|
end
|
||||||
|
|
||||||
# Manual Billing
|
# 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
|
def bill
|
||||||
i = Issue.find_by_id params[:id]
|
issue = Issue.visible.find_by(id: params[:id])
|
||||||
if i.customer
|
return render_404 unless issue
|
||||||
i.bill_time
|
return deny_access unless User.current.allowed_to?(:bill_issues, issue.project)
|
||||||
redirect_to i, flash: { notice: I18n.t(:label_billed_success) + i.customer.name }
|
|
||||||
else
|
raise I18n.t(:notice_billing_error_no_customer) unless issue.customer
|
||||||
redirect_to i, flash: { error: I18n.t(:label_billing_error) }
|
raise I18n.t(:notice_billing_error_no_employee) unless issue.assigned_to&.employee_id.present?
|
||||||
end
|
raise I18n.t(:notice_billing_error_no_qbo) unless Qbo.exists?
|
||||||
|
|
||||||
|
BillIssueTimeJob.perform_later(issue.id)
|
||||||
|
|
||||||
|
redirect_to issue, flash: { notice: "#{I18n.t(:label_billing_enqueued)} #{issue.customer.name}"}
|
||||||
|
|
||||||
|
rescue StandardError => e
|
||||||
|
redirect_to issue || root_path, flash: { error: e.message }
|
||||||
end
|
end
|
||||||
|
|
||||||
# Quickbooks Webhook Callback
|
# Manual sync endpoint to trigger synchronization of QuickBooks entities
|
||||||
def webhook
|
# with the local database. Supports full or partial sync depending on
|
||||||
|
# the `full_sync` boolean parameter.
|
||||||
logger.info "Quickbooks is calling webhook"
|
|
||||||
|
|
||||||
# check the payload
|
|
||||||
signature = request.headers['intuit-signature']
|
|
||||||
key = Setting.plugin_redmine_qbo['settingsWebhookToken']
|
|
||||||
data = request.body.read
|
|
||||||
hash = Base64.encode64(OpenSSL::HMAC.digest(OpenSSL::Digest::Digest.new('sha256'), key, data)).strip()
|
|
||||||
|
|
||||||
# proceed if the request is good
|
|
||||||
if hash.eql? signature
|
|
||||||
Thread.new do
|
|
||||||
if request.headers['content-type'] == 'application/json'
|
|
||||||
data = JSON.parse(data)
|
|
||||||
else
|
|
||||||
# application/x-www-form-urlencoded
|
|
||||||
data = params.as_json
|
|
||||||
end
|
|
||||||
# Process the information
|
|
||||||
entities = data['eventNotifications'][0]['dataChangeEvent']['entities']
|
|
||||||
entities.each do |entity|
|
|
||||||
id = entity['id'].to_i
|
|
||||||
name = entity['name']
|
|
||||||
|
|
||||||
logger.info "Casting #{name.constantize} to obj"
|
|
||||||
|
|
||||||
# Magicly initialize the correct class
|
|
||||||
obj = name.constantize
|
|
||||||
|
|
||||||
# for merge events
|
|
||||||
obj.destroy(entity['deletedId']) if entity['deletedId']
|
|
||||||
|
|
||||||
#Check to see if we are deleting a record
|
|
||||||
if entity['operation'].eql? "Delete"
|
|
||||||
obj.destroy(id)
|
|
||||||
#if not then update!
|
|
||||||
else
|
|
||||||
begin
|
|
||||||
obj.sync_by_id(id)
|
|
||||||
rescue => e
|
|
||||||
logger.error "Failed to call sync_by_id on obj"
|
|
||||||
logger.error e.message
|
|
||||||
logger.error e.backtrace.join("\n")
|
|
||||||
end
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
# Record that last time we updated
|
|
||||||
Qbo.update_time_stamp
|
|
||||||
ActiveRecord::Base.connection.close
|
|
||||||
end
|
|
||||||
# The webhook doesn't require a response but let's make sure we don't send anything
|
|
||||||
render nothing: true, status: 200
|
|
||||||
else
|
|
||||||
render nothing: true, status: 400
|
|
||||||
end
|
|
||||||
|
|
||||||
logger.info "Quickbooks webhook complete"
|
|
||||||
end
|
|
||||||
|
|
||||||
#
|
|
||||||
# Synchronizes the QboCustomer table with QBO
|
|
||||||
#
|
|
||||||
def sync
|
def sync
|
||||||
logger.info "Syncing EVERYTHING"
|
full_sync = ActiveModel::Type::Boolean.new.cast(params[:full_sync])
|
||||||
# Update info in background
|
QboSyncDispatcher.sync!(full_sync: full_sync)
|
||||||
Thread.new do
|
|
||||||
if Qbo.exists?
|
|
||||||
Customer.sync
|
|
||||||
Invoice.sync
|
|
||||||
Employee.sync
|
|
||||||
Estimate.sync
|
|
||||||
|
|
||||||
# Record the last sync time
|
redirect_back fallback_location: home_path, flash: { notice: I18n.t(:label_syncing) }
|
||||||
Qbo.update_time_stamp
|
end
|
||||||
end
|
|
||||||
ActiveRecord::Base.connection.close
|
|
||||||
end
|
|
||||||
|
|
||||||
redirect_to :home, flash: { notice: I18n.t(:label_syncing) }
|
# Endpoint to receive QuickBooks webhook notifications. Validates the request and processes the payload to sync relevant data to Redmine. Responds with appropriate HTTP status codes based on success or failure of processing.
|
||||||
|
def webhook
|
||||||
|
QboWebhookProcessor.process!(request: request)
|
||||||
|
head :ok
|
||||||
|
|
||||||
|
rescue StandardError => e
|
||||||
|
log "Webhook failure: #{e.message}"
|
||||||
|
head :unauthorized
|
||||||
|
end
|
||||||
|
|
||||||
|
private
|
||||||
|
|
||||||
|
# Constructs the OAuth callback URL based on the application's settings and routes. This URL is used during the OAuth flow to redirect users back to the application after authentication with QuickBooks.
|
||||||
|
def callback_url
|
||||||
|
"#{Setting.protocol}://#{Setting.host_name}#{qbo_oauth_callback_path}"
|
||||||
|
end
|
||||||
|
|
||||||
|
# Logs messages with a consistent prefix for easier debugging and monitoring.
|
||||||
|
def log(msg)
|
||||||
|
Rails.logger.info "[QboController] #{msg}"
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
@@ -0,0 +1,31 @@
|
|||||||
|
#The MIT License (MIT)
|
||||||
|
#
|
||||||
|
#Copyright (c) 2026 rick barrette
|
||||||
|
#
|
||||||
|
#Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
|
||||||
|
#
|
||||||
|
#The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
|
||||||
|
#
|
||||||
|
#THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
||||||
|
|
||||||
|
# Estimate and invoice drafts (QboDraft): all of them, and deleting one. Drafts are continued on the new
|
||||||
|
# estimate/invoice editor (new?draft_id=). Users see the drafts of the documents they may write.
|
||||||
|
class QboDraftsController < ApplicationController
|
||||||
|
|
||||||
|
before_action :authorize_global
|
||||||
|
|
||||||
|
def index
|
||||||
|
@drafts = QboDraft.visible.includes(:customer, :user).newest_first.to_a
|
||||||
|
end
|
||||||
|
|
||||||
|
def destroy
|
||||||
|
draft = QboDraft.visible.find_by(id: params[:id])
|
||||||
|
if draft
|
||||||
|
draft.destroy
|
||||||
|
flash[:notice] = l(:notice_qbo_draft_deleted)
|
||||||
|
else
|
||||||
|
flash[:error] = l(:error_qbo_draft_not_found)
|
||||||
|
end
|
||||||
|
redirect_back_or_default qbo_drafts_path
|
||||||
|
end
|
||||||
|
end
|
||||||
@@ -0,0 +1,342 @@
|
|||||||
|
#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
|
||||||
|
include QboDraftHandling
|
||||||
|
|
||||||
|
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, a copy of another one (?duplicate=<estimate id>), or a draft (?draft_id=, see QboDraft)
|
||||||
|
def new
|
||||||
|
if params[:draft_id].present?
|
||||||
|
return draft_missing unless find_draft('estimate')
|
||||||
|
@form = form_from_draft(@draft)
|
||||||
|
elsif params[:duplicate].present?
|
||||||
|
@form = RedmineQboBilling::EstimateWriter.duplicate_form(params[:duplicate], user: User.current)
|
||||||
|
else
|
||||||
|
customer = Customer.find_by(id: params[:customer_id]) if params[:customer_id].present?
|
||||||
|
@form = RedmineQboBilling::EstimateWriter.new_form(customer: customer, user: User.current)
|
||||||
|
end
|
||||||
|
load_customer_drafts('estimate', @form.customer_id)
|
||||||
|
rescue *QBO_ERRORS => e
|
||||||
|
flash[:error] = qbo_message(e)
|
||||||
|
redirect_back_or_default home_path
|
||||||
|
end
|
||||||
|
|
||||||
|
def create
|
||||||
|
find_draft('estimate')
|
||||||
|
return save_draft('estimate', estimate_params) if params[:save_draft].present?
|
||||||
|
|
||||||
|
@form = RedmineQboBilling::EstimateForm.from_params(estimate_params)
|
||||||
|
# Shown again if the save fails; the sales person is always the user creating the estimate
|
||||||
|
@form.sales_person = User.current.name
|
||||||
|
return show_invalid(:new) unless @form.valid?
|
||||||
|
|
||||||
|
saved = RedmineQboBilling::EstimateWriter.save(@form, user: User.current)
|
||||||
|
discard_draft
|
||||||
|
finish_save(saved, l(:notice_estimate_saved_in_quickbooks, number: saved.doc_number))
|
||||||
|
rescue *QBO_ERRORS => e
|
||||||
|
show_error(e, :new)
|
||||||
|
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
|
||||||
|
# A parent was entered but can't be used: create nothing rather than top-level issues
|
||||||
|
created = @parent_issue_error ? [] : @builder.create_issues(project: @target_project, rows: @rows, custom_field_values: @custom_field_values)
|
||||||
|
|
||||||
|
if created.any?
|
||||||
|
Redmine::Hook.call_hook(:qbo_billing_issues_created, { estimate: @estimate, issues: created, params: params })
|
||||||
|
# The work is going ahead: a pending estimate becomes Accepted in QuickBooks
|
||||||
|
accepted = RedmineQboBilling::EstimateWriter.accept(@estimate.id, user: User.current)
|
||||||
|
flash[:notice] = l(:notice_estimate_issues_created, count: created.size)
|
||||||
|
flash[:notice] += " #{l(:notice_estimate_accepted, number: @estimate.doc_number)}" if accepted.accepted?
|
||||||
|
flash[:warning] = l(:warning_estimate_not_accepted, number: @estimate.doc_number, message: accepted.message) if accepted.failed?
|
||||||
|
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 the suggestions
|
||||||
|
# plugins give for the custom field boxes (RedmineQboBilling.field_options)
|
||||||
|
def customer_info
|
||||||
|
customer = Customer.find_by(id: params[:customer_id])
|
||||||
|
return render(json: {}, status: :not_found) unless customer
|
||||||
|
|
||||||
|
info = {
|
||||||
|
id: customer.id,
|
||||||
|
name: customer.name,
|
||||||
|
email: RedmineQboBilling::EstimateWriter.customer_email(customer),
|
||||||
|
billing_address: RedmineQboBilling::EstimateWriter.customer_address(customer),
|
||||||
|
field_options: RedmineQboBilling.field_options(customer)
|
||||||
|
}
|
||||||
|
# A new invoice warns about the customer's open issues
|
||||||
|
if params[:document] == 'invoice'
|
||||||
|
info[:open_issues_html] = render_to_string(partial: 'qbo_invoices/open_issues', formats: [:html],
|
||||||
|
locals: { customer: customer })
|
||||||
|
end
|
||||||
|
render json: info
|
||||||
|
end
|
||||||
|
|
||||||
|
# Product/service search for the line table (the QuickBooks item list)
|
||||||
|
def items
|
||||||
|
|
||||||
|
term = "%#{ActiveRecord::Base.sanitize_sql_like(params[:q].to_s.strip)}%"
|
||||||
|
items = Item.sellable
|
||||||
|
.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
|
||||||
|
|
||||||
|
load_parent_issue
|
||||||
|
|
||||||
|
@defaults = build_defaults
|
||||||
|
@return_path = @defaults[:return_path].presence || edit_qbo_estimate_path(@estimate.id)
|
||||||
|
@return_label = @defaults[:return_label].presence || "#{l(:label_estimate)} ##{@estimate.doc_number}"
|
||||||
|
@available_projects = Project.allowed_to(User.current, :add_issues).sorted.to_a
|
||||||
|
|
||||||
|
# A project chosen on the page wins, then the parent issue's, then the one from another plugin (e.g. the
|
||||||
|
# appointment's), then the default project from the settings, then the first project the user can add issues to
|
||||||
|
chosen = @available_projects.detect { |p| p.id == params[:project_id].to_i } if params[:project_id].present?
|
||||||
|
from_parent = @parent_issue.project if @parent_issue && @available_projects.include?(@parent_issue.project)
|
||||||
|
from_hook = @defaults[:project] if @available_projects.include?(@defaults[:project])
|
||||||
|
default_project = @available_projects.detect { |p| p.id == RedmineQboBilling::EstimateIssueBuilder.default_project_id }
|
||||||
|
@target_project = chosen || from_parent || from_hook || default_project || @available_projects.first
|
||||||
|
return deny_access unless @target_project
|
||||||
|
|
||||||
|
# Subtasks need the "Manage subtasks" permission in the project they're created in
|
||||||
|
@can_add_subtasks = User.current.allowed_to?(:manage_subtasks, @target_project)
|
||||||
|
if @parent_issue && !@can_add_subtasks
|
||||||
|
@parent_issue_error = l(:error_estimate_parent_not_allowed, project: @target_project.name)
|
||||||
|
@parent_issue = nil
|
||||||
|
@defaults = build_defaults
|
||||||
|
end
|
||||||
|
@builder = RedmineQboBilling::EstimateIssueBuilder.new(@estimate, defaults: @defaults, parent: @parent_issue)
|
||||||
|
|
||||||
|
@trackers = Issue.allowed_target_trackers(@target_project, User.current).to_a
|
||||||
|
@default_tracker = @trackers.detect { |t| t.id == RedmineQboBilling::EstimateIssueBuilder.default_tracker_id } || @trackers.first
|
||||||
|
@templates = RedmineQboBilling::IssueTemplateSupport.templates_for(@target_project)
|
||||||
|
# With a parent issue, the shared fields start out with the parent's values
|
||||||
|
@field_set = RedmineQboBilling::IssueFieldSet.new(project: @target_project, trackers: @trackers,
|
||||||
|
values: parent_custom_field_values)
|
||||||
|
@rows ||= {}
|
||||||
|
rescue *QBO_ERRORS => e
|
||||||
|
flash[:error] = qbo_message(e)
|
||||||
|
redirect_back_or_default home_path
|
||||||
|
end
|
||||||
|
|
||||||
|
# The optional parent issue (parent_issue_id, "#123" or "123"): the new issues become its subtasks.
|
||||||
|
# Only an issue the user can see; an unknown one is reported and nothing is created.
|
||||||
|
def load_parent_issue
|
||||||
|
@parent_issue_id = params[:parent_issue_id].to_s.delete('#').strip
|
||||||
|
return if @parent_issue_id.blank?
|
||||||
|
|
||||||
|
@parent_issue = Issue.visible.find_by(id: @parent_issue_id.to_i) if @parent_issue_id.match?(/\A\d+\z/)
|
||||||
|
@parent_issue_error = l(:error_estimate_parent_not_found, id: @parent_issue_id) unless @parent_issue
|
||||||
|
end
|
||||||
|
|
||||||
|
# What the new issues start from:
|
||||||
|
# - dates: another plugin's (e.g. the appointment's), else the parent issue's
|
||||||
|
# - vehicle: the parent issue's, else another plugin's (e.g. the appointment's)
|
||||||
|
# Values posted with the form (the dates, plugins' fields such as redmine_qbo_vehicles' vehicle) win.
|
||||||
|
def build_defaults
|
||||||
|
parent_dates = {}
|
||||||
|
parent_vehicle = {}
|
||||||
|
if @parent_issue
|
||||||
|
parent_dates = { start_date: @parent_issue.start_date, due_date: @parent_issue.due_date }.compact
|
||||||
|
if @parent_issue.respond_to?(:vehicle_id) && @parent_issue.vehicle_id.present?
|
||||||
|
parent_vehicle = { vehicle_id: @parent_issue.vehicle_id.to_s }
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
parent_dates.merge(issue_defaults.compact).merge(parent_vehicle).merge(submitted_plugin_fields).merge(submitted_dates)
|
||||||
|
end
|
||||||
|
|
||||||
|
# The Start date / Due date entered on the page, only when the form was posted. A blank one means no date.
|
||||||
|
def submitted_dates
|
||||||
|
return {} unless request.post? && params[:issue_dates].respond_to?(:to_unsafe_h)
|
||||||
|
|
||||||
|
values = params[:issue_dates].to_unsafe_h
|
||||||
|
%w[start_date due_date].each_with_object({}) do |key, dates|
|
||||||
|
dates[key.to_sym] = parse_date(values[key]) if values.key?(key)
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
def parse_date(value)
|
||||||
|
Date.iso8601(value.to_s.strip) if value.present?
|
||||||
|
rescue ArgumentError
|
||||||
|
nil
|
||||||
|
end
|
||||||
|
|
||||||
|
# The parent issue's custom field values the user can see, to start the shared fields from: { id => value }
|
||||||
|
def parent_custom_field_values
|
||||||
|
return {} unless @parent_issue
|
||||||
|
|
||||||
|
@parent_issue.visible_custom_field_values.each_with_object({}) do |custom_value, values|
|
||||||
|
next if Array(custom_value.value).all?(&:blank?)
|
||||||
|
|
||||||
|
values[custom_value.custom_field_id.to_s] = custom_value.value
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
# The first non-empty hash a plugin returns for :qbo_billing_issue_defaults
|
||||||
|
def issue_defaults
|
||||||
|
results = Redmine::Hook.call_hook(:qbo_billing_issue_defaults, { estimate: @estimate, params: params })
|
||||||
|
(results.detect { |r| r.is_a?(Hash) && r.any? } || {}).symbolize_keys
|
||||||
|
end
|
||||||
|
|
||||||
|
# Plugins' own fields on the preview form (issue_plugin_fields[...], drawn by :view_qbo_estimate_issues_form),
|
||||||
|
# only when the form was posted: { vehicle_id: "5" }
|
||||||
|
def submitted_plugin_fields
|
||||||
|
return {} unless request.post?
|
||||||
|
|
||||||
|
values = params[:issue_plugin_fields]
|
||||||
|
values.respond_to?(:to_unsafe_h) ? values.to_unsafe_h.to_h.transform_keys(&:to_sym).transform_values(&:to_s) : {}
|
||||||
|
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,
|
||||||
|
custom_fields: {},
|
||||||
|
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,175 @@
|
|||||||
|
#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
|
||||||
|
include QboDraftHandling
|
||||||
|
|
||||||
|
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, one made from an estimate (?estimate_id=<estimate id>), or a draft (?draft_id=, see
|
||||||
|
# QboDraft). A draft stays in Redmine, so QuickBooks can't apply a deposit to it while it's being written.
|
||||||
|
def new
|
||||||
|
if params[:draft_id].present?
|
||||||
|
return draft_missing unless find_draft('invoice')
|
||||||
|
@form = form_from_draft(@draft)
|
||||||
|
return
|
||||||
|
end
|
||||||
|
|
||||||
|
@form =
|
||||||
|
if params[:estimate_id].present?
|
||||||
|
RedmineQboBilling::InvoiceWriter.from_estimate(params[:estimate_id], user: User.current)
|
||||||
|
else
|
||||||
|
customer = Customer.find_by(id: params[:customer_id]) if params[:customer_id].present?
|
||||||
|
RedmineQboBilling::InvoiceWriter.new_form(customer: customer, user: User.current)
|
||||||
|
end
|
||||||
|
load_customer_drafts('invoice', @form.customer_id)
|
||||||
|
rescue *QBO_ERRORS => e
|
||||||
|
flash[:error] = qbo_message(e)
|
||||||
|
redirect_back_or_default home_path
|
||||||
|
end
|
||||||
|
|
||||||
|
def create
|
||||||
|
find_draft('invoice')
|
||||||
|
# The sales person shown on the editor is kept with the draft
|
||||||
|
return save_draft('invoice', invoice_params.to_h.merge('sales_person' => params.dig(:estimate, :sales_person).to_s)) if params[:save_draft].present?
|
||||||
|
|
||||||
|
@form = RedmineQboBilling::EstimateForm.from_params(invoice_params, document: 'invoice')
|
||||||
|
# Display only (e.g. the estimate's sales person); InvoiceWriter.save works out what's saved
|
||||||
|
@form.sales_person = params.dig(:estimate, :sales_person).presence || User.current.name
|
||||||
|
return show_invalid(:new) unless @form.valid?
|
||||||
|
|
||||||
|
saved = RedmineQboBilling::InvoiceWriter.save(@form, user: User.current)
|
||||||
|
discard_draft
|
||||||
|
finish_save(saved, l(:notice_invoice_saved_in_quickbooks, number: saved.doc_number))
|
||||||
|
rescue *QBO_ERRORS => e
|
||||||
|
show_error(e, :new)
|
||||||
|
end
|
||||||
|
|
||||||
|
# ?unlock=1 opens a paid invoice for editing anyway (after the editor's confirmation)
|
||||||
|
def edit
|
||||||
|
@form = RedmineQboBilling::InvoiceWriter.load(params[:id])
|
||||||
|
unlock_form if unlock?
|
||||||
|
rescue *QBO_ERRORS => e
|
||||||
|
flash[:error] = qbo_message(e)
|
||||||
|
redirect_back_or_default home_path
|
||||||
|
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
|
||||||
|
unlock_form if unlock?
|
||||||
|
return show_invalid(:edit) unless @form.valid?
|
||||||
|
|
||||||
|
saved = RedmineQboBilling::InvoiceWriter.save(@form, user: User.current, unlock: unlock?)
|
||||||
|
finish_save(saved, l(:notice_invoice_saved_in_quickbooks, number: saved.doc_number))
|
||||||
|
rescue RedmineQboBilling::InvoiceWriter::Conflict => e
|
||||||
|
@conflict = true
|
||||||
|
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: [],
|
||||||
|
custom_fields: {},
|
||||||
|
lines: RedmineQboBilling::EstimateForm::Line::PARAMS
|
||||||
|
)
|
||||||
|
end
|
||||||
|
|
||||||
|
def unlock?
|
||||||
|
params[:unlock].to_s == '1'
|
||||||
|
end
|
||||||
|
|
||||||
|
# Shows a paid invoice editable, with the amount paid on it (posted back with the form when saving), for
|
||||||
|
# users allowed to edit it (paid off or partly paid). InvoiceWriter.save checks again against QuickBooks.
|
||||||
|
def unlock_form
|
||||||
|
@form.amount_paid ||= RedmineQboBilling::EstimateForm.decimal(params.dig(:estimate, :amount_paid))
|
||||||
|
return unless @form.locked == :paid || @form.locked.nil?
|
||||||
|
return unless RedmineQboBilling.paid_invoice_editor?(@form.fully_paid?)
|
||||||
|
|
||||||
|
@form.locked = nil
|
||||||
|
@form.unlocked = true
|
||||||
|
end
|
||||||
|
|
||||||
|
def save_and_send?
|
||||||
|
params[:save_and_send].present?
|
||||||
|
end
|
||||||
|
|
||||||
|
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,138 @@
|
|||||||
|
#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 edited and printed (QuickBooks' payment PDF). A customer's
|
||||||
|
# payments are listed on their payments page.
|
||||||
|
class QboPaymentsController < ApplicationController
|
||||||
|
|
||||||
|
before_action :authorize_global, except: :sync
|
||||||
|
before_action :require_admin, only: :sync
|
||||||
|
|
||||||
|
QBO_ERRORS = QboEstimatesController::QBO_ERRORS
|
||||||
|
|
||||||
|
# Re-reads every payment from QuickBooks into the local cache (admin, from the plugin settings)
|
||||||
|
def sync
|
||||||
|
Payment.sync
|
||||||
|
redirect_back fallback_location: home_path, flash: { notice: I18n.t(:label_syncing) }
|
||||||
|
end
|
||||||
|
|
||||||
|
# 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 edit
|
||||||
|
@form = RedmineQboBilling::PaymentWriter.load_form(params[:id])
|
||||||
|
load_choices
|
||||||
|
rescue *QBO_ERRORS => e
|
||||||
|
flash[:error] = qbo_message(e)
|
||||||
|
redirect_back_or_default home_path
|
||||||
|
end
|
||||||
|
|
||||||
|
def update
|
||||||
|
@form = RedmineQboBilling::PaymentForm.from_params(payment_params, id: params[:id])
|
||||||
|
return show_form unless @form.valid?
|
||||||
|
|
||||||
|
payment = RedmineQboBilling::PaymentWriter.save(@form)
|
||||||
|
flash[:notice] = l(:notice_payment_updated, amount: view_context.number_to_currency(payment.total))
|
||||||
|
redirect_to qbo_payment_path(payment.id)
|
||||||
|
rescue RedmineQboBilling::PaymentWriter::Conflict => e
|
||||||
|
@conflict = true
|
||||||
|
@form.errors.add(:base, qbo_message(e))
|
||||||
|
show_form
|
||||||
|
rescue *QBO_ERRORS => e
|
||||||
|
logger.warn "[RedmineQboBilling] #{e.class}: #{qbo_message(e)}"
|
||||||
|
@form.errors.add(:base, qbo_message(e))
|
||||||
|
show_form
|
||||||
|
end
|
||||||
|
|
||||||
|
def show
|
||||||
|
@payment = RedmineQboBilling::PaymentWriter.load(params[:id])
|
||||||
|
@customer = Customer.find_by(id: @payment.customer_ref&.value)
|
||||||
|
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, :sync_token, invoice_ids: [])
|
||||||
|
end
|
||||||
|
|
||||||
|
def load_choices
|
||||||
|
@payment_methods = RedmineQboBilling::PaymentWriter.payment_methods
|
||||||
|
customer = Customer.find_by(id: @form.customer_id) if @form.customer_id.present?
|
||||||
|
# Editing: the invoices this payment pays count as open (by what it paid on them)
|
||||||
|
payment = RedmineQboBilling::PaymentWriter.load(@form.id) if @form.persisted?
|
||||||
|
@open_invoices = customer ? RedmineQboBilling::PaymentWriter.open_invoices(customer, payment: payment) : []
|
||||||
|
rescue *QBO_ERRORS => e
|
||||||
|
@open_invoices = []
|
||||||
|
flash.now[:error] = qbo_message(e)
|
||||||
|
end
|
||||||
|
|
||||||
|
def show_form
|
||||||
|
load_choices
|
||||||
|
render(@form.persisted? ? :edit : :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
|
||||||
@@ -0,0 +1,108 @@
|
|||||||
|
#The MIT License (MIT)
|
||||||
|
#
|
||||||
|
#Copyright (c) 2026 rick barrette
|
||||||
|
#
|
||||||
|
#Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
|
||||||
|
#
|
||||||
|
#The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
|
||||||
|
#
|
||||||
|
#THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
||||||
|
|
||||||
|
# Customer refunds (SOP-OPS-014): the Refund page for a customer with credit, and a refund once it's made
|
||||||
|
class QboRefundsController < ApplicationController
|
||||||
|
before_action :authorize_global
|
||||||
|
|
||||||
|
QBO_ERRORS = QboEstimatesController::QBO_ERRORS
|
||||||
|
|
||||||
|
def new
|
||||||
|
@customer = Customer.find_by(id: params[:customer_id])
|
||||||
|
return render_404 unless @customer
|
||||||
|
|
||||||
|
@form = RedmineQboBilling::RefundForm.new(customer_id: @customer.id.to_s, estimate_id: params[:estimate_id].to_s,
|
||||||
|
txn_date: User.current.today.iso8601, method: 'check',
|
||||||
|
close_estimate: '1', cancel_issues: '1', email_customer: '1')
|
||||||
|
@form.parts_amount = estimate_parts(@form.estimate_id)
|
||||||
|
load_page
|
||||||
|
end
|
||||||
|
|
||||||
|
def create
|
||||||
|
@form = RedmineQboBilling::RefundForm.from_params(params.require(:refund).permit(*RedmineQboBilling::RefundForm::ATTRIBUTES))
|
||||||
|
@customer = Customer.find_by(id: @form.customer_id)
|
||||||
|
return render_404 unless @customer
|
||||||
|
return show_form unless @form.valid?
|
||||||
|
|
||||||
|
refund = RedmineQboBilling::RefundWriter.refund!(@form)
|
||||||
|
if refund.done?
|
||||||
|
flash[:notice] = l(:notice_refund_done, amount: RedmineQboBilling::RefundWriter.money(refund.refund_amount))
|
||||||
|
else
|
||||||
|
flash[:error] = refund.message
|
||||||
|
end
|
||||||
|
redirect_to qbo_refund_path(refund)
|
||||||
|
rescue RedmineQboBilling::RefundWriter::Error, *QBO_ERRORS => e
|
||||||
|
@form.errors.add(:base, qbo_message(e))
|
||||||
|
show_form
|
||||||
|
end
|
||||||
|
|
||||||
|
def show
|
||||||
|
@refund = QboRefund.find_by(id: params[:id])
|
||||||
|
return render_404 unless @refund
|
||||||
|
|
||||||
|
@customer = @refund.customer
|
||||||
|
end
|
||||||
|
|
||||||
|
# The refund as a PDF, shown in the browser to print or save
|
||||||
|
def pdf
|
||||||
|
refund = QboRefund.find_by(id: params[:id])
|
||||||
|
return render_404 unless refund
|
||||||
|
|
||||||
|
document = RedmineQboBilling::RefundPdf.new(refund)
|
||||||
|
send_data document.render, type: 'application/pdf', disposition: 'inline', filename: document.filename
|
||||||
|
end
|
||||||
|
|
||||||
|
# Emails the customer the refund's summary (again, or after fixing their email in QuickBooks)
|
||||||
|
def email
|
||||||
|
refund = QboRefund.find_by(id: params[:id])
|
||||||
|
return render_404 unless refund&.done?
|
||||||
|
|
||||||
|
warning = RedmineQboBilling::RefundWriter.email_customer(refund, refund.customer, QboRefundMailer)
|
||||||
|
if warning
|
||||||
|
flash[:error] = warning
|
||||||
|
else
|
||||||
|
flash[:notice] = l(:notice_refund_emailed, email: refund.emailed_to)
|
||||||
|
end
|
||||||
|
redirect_to qbo_refund_path(refund)
|
||||||
|
end
|
||||||
|
|
||||||
|
private
|
||||||
|
|
||||||
|
# The estimate's parts (its lines that aren't labor), before tax, for the restocking fee
|
||||||
|
def estimate_parts(estimate_id)
|
||||||
|
return '' if estimate_id.blank?
|
||||||
|
|
||||||
|
estimate = RedmineQboBilling::RefundGateway.new.estimate(estimate_id)
|
||||||
|
estimate ? format('%.2f', RedmineQboBilling::RefundWriter.parts_amount(estimate)) : ''
|
||||||
|
rescue *QBO_ERRORS => e
|
||||||
|
flash.now[:error] = qbo_message(e)
|
||||||
|
''
|
||||||
|
end
|
||||||
|
|
||||||
|
def load_page
|
||||||
|
@estimates = RedmineQboBilling::RefundWriter.estimate_choices(@customer)
|
||||||
|
@preview = RedmineQboBilling::RefundWriter.preview(@customer, parts: @form.parts_value || BigDecimal('0'))
|
||||||
|
@statuses = IssueStatus.sorted.to_a
|
||||||
|
rescue *QBO_ERRORS => e
|
||||||
|
@preview = nil
|
||||||
|
flash.now[:error] = qbo_message(e)
|
||||||
|
end
|
||||||
|
|
||||||
|
def show_form
|
||||||
|
load_page
|
||||||
|
render :new, status: :unprocessable_entity
|
||||||
|
end
|
||||||
|
|
||||||
|
def qbo_message(error)
|
||||||
|
detail = error.respond_to?(:detail) ? error.detail.to_s : ''
|
||||||
|
message = error.message.to_s
|
||||||
|
detail.present? && !message.include?(detail) ? "#{message}: #{detail}" : message
|
||||||
|
end
|
||||||
|
end
|
||||||
@@ -0,0 +1,62 @@
|
|||||||
|
#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.
|
||||||
|
|
||||||
|
|
||||||
|
# Business report: estimates and invoices written and payments received, and estimated, invoiced and spent
|
||||||
|
# hours, for a period (RedmineQboBilling::BusinessReport)
|
||||||
|
class QboReportsController < ApplicationController
|
||||||
|
|
||||||
|
before_action :authorize_global
|
||||||
|
|
||||||
|
# The user's preference holding the projects the report opens with
|
||||||
|
PROJECTS_PREF = :qbo_report_project_ids
|
||||||
|
|
||||||
|
def index
|
||||||
|
# Projects for the issues and spent time: the projects picker can choose some of the open ones
|
||||||
|
@projects = Project.visible.active.to_a
|
||||||
|
@project_ids = report_project_ids
|
||||||
|
@report = RedmineQboBilling::BusinessReport.new(period: params[:period].presence || 'this_year',
|
||||||
|
from: params[:from], to: params[:to], today: User.current.today,
|
||||||
|
week_start: RedmineQboBilling::BusinessReport.week_start_from_setting(Setting.start_of_week),
|
||||||
|
project_ids: @project_ids)
|
||||||
|
# Last year's lines on the charts
|
||||||
|
@compare = params[:compare] == '1'
|
||||||
|
# Syncs still running for what the report counts: its figures are incomplete until they finish
|
||||||
|
@syncing = QboSyncStatus.by_entity(%w[Estimate Invoice Payment]).values.sort_by(&:entity)
|
||||||
|
end
|
||||||
|
|
||||||
|
private
|
||||||
|
|
||||||
|
# The form's projects (none picked is every project), or the user's saved ones when the address has none.
|
||||||
|
# "Remember these projects" saves the form's choice. Only open projects the user can see are kept.
|
||||||
|
def report_project_ids
|
||||||
|
visible = @projects.map(&:id)
|
||||||
|
if params.key?(:project_ids)
|
||||||
|
ids = Array(params[:project_ids]).map(&:to_i) & visible
|
||||||
|
save_project_ids(ids) if params[:save_projects] == '1'
|
||||||
|
else
|
||||||
|
ids = saved_project_ids & visible
|
||||||
|
end
|
||||||
|
@saved_project_ids = saved_project_ids & visible
|
||||||
|
ids
|
||||||
|
end
|
||||||
|
|
||||||
|
def saved_project_ids
|
||||||
|
return [] unless User.current.logged?
|
||||||
|
Array(User.current.pref[PROJECTS_PREF]).map(&:to_i)
|
||||||
|
end
|
||||||
|
|
||||||
|
def save_project_ids(ids)
|
||||||
|
return unless User.current.logged?
|
||||||
|
pref = User.current.pref
|
||||||
|
pref[PROJECTS_PREF] = ids
|
||||||
|
pref.save
|
||||||
|
end
|
||||||
|
end
|
||||||
@@ -10,20 +10,40 @@
|
|||||||
|
|
||||||
module AuthHelper
|
module AuthHelper
|
||||||
|
|
||||||
|
# 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
|
def require_user
|
||||||
return unless session[:token].nil?
|
return true if User.current.logged?
|
||||||
if !User.current.logged?
|
|
||||||
flash[:error] = t :notice_forbidden
|
require_login
|
||||||
render_403
|
|
||||||
end
|
|
||||||
end
|
end
|
||||||
|
|
||||||
def allowed_to?(action)
|
def allowed_to?(action)
|
||||||
return false if User.current.nil?
|
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 false if project.nil?
|
||||||
return true if User.current.allowed_to?(action, project)
|
User.current.allowed_to?(action, project)
|
||||||
false
|
|
||||||
end
|
end
|
||||||
|
|
||||||
def check_permission(permission)
|
def check_permission(permission)
|
||||||
@@ -33,7 +53,6 @@ module AuthHelper
|
|||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
|
|
||||||
def global_check_permission(permission)
|
def global_check_permission(permission)
|
||||||
if !globaly_allowed_to?(permission)
|
if !globaly_allowed_to?(permission)
|
||||||
flash[:error] = t :notice_forbidden
|
flash[:error] = t :notice_forbidden
|
||||||
@@ -41,16 +60,11 @@ module AuthHelper
|
|||||||
end
|
end
|
||||||
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?
|
return false if User.current.nil?
|
||||||
|
|
||||||
projects = Project.all
|
User.current.allowed_to?(action, nil, global: true)
|
||||||
projects.each { |p|
|
|
||||||
if User.current.allowed_to?(action, p)
|
|
||||||
return true
|
|
||||||
end
|
|
||||||
}
|
|
||||||
false
|
|
||||||
end
|
end
|
||||||
|
|
||||||
end
|
end
|
||||||
@@ -0,0 +1,135 @@
|
|||||||
|
#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.
|
||||||
|
|
||||||
|
class BillIssueTimeJob < ActiveJob::Base
|
||||||
|
queue_as :default
|
||||||
|
retry_on StandardError, wait: 5.minutes, attempts: 5
|
||||||
|
|
||||||
|
# Perform billing of unbilled time entries for a given issue by creating corresponding TimeActivity records in QuickBooks Online, and then marking those entries as billed in Redmine. This job is typically triggered after an invoice is created or updated to ensure all relevant time is captured for billing.
|
||||||
|
def perform(issue_id)
|
||||||
|
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.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}"
|
||||||
|
|
||||||
|
# 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
|
||||||
|
|
||||||
|
# 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
|
||||||
|
log "Billing failed for issue ##{issue_id} - #{e.message}"
|
||||||
|
raise e
|
||||||
|
end
|
||||||
|
|
||||||
|
private
|
||||||
|
|
||||||
|
# Aggregate time entries by activity name and sum their hours
|
||||||
|
def aggregate_hours(entries)
|
||||||
|
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
|
||||||
|
# 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 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)
|
||||||
|
unless item
|
||||||
|
log "No QBO item named #{activity_name.inspect}; skipping"
|
||||||
|
done << activity_name
|
||||||
|
next
|
||||||
|
end
|
||||||
|
|
||||||
|
hours, minutes = convert_hours(hours_float)
|
||||||
|
|
||||||
|
time_entry = Quickbooks::Model::TimeActivity.new
|
||||||
|
time_entry.description = build_description(issue)
|
||||||
|
time_entry.employee_id = issue.assigned_to.employee_id
|
||||||
|
time_entry.customer_id = issue.customer_id
|
||||||
|
time_entry.billable_status = "Billable"
|
||||||
|
time_entry.hours = hours
|
||||||
|
time_entry.minutes = minutes
|
||||||
|
time_entry.name_of = "Employee"
|
||||||
|
time_entry.txn_date = Date.today
|
||||||
|
time_entry.hourly_rate = item.unit_price
|
||||||
|
time_entry.item_id = item.id
|
||||||
|
|
||||||
|
log "Creating TimeActivity for #{activity_name} (#{hours}h #{minutes}m)"
|
||||||
|
|
||||||
|
time_service.create(time_entry)
|
||||||
|
done << activity_name
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
# Convert a decimal hours float into separate hours and minutes components for QBO TimeActivity
|
||||||
|
def convert_hours(hours_float)
|
||||||
|
total_minutes = (hours_float.to_f * 60).round
|
||||||
|
hours = total_minutes / 60
|
||||||
|
minutes = total_minutes % 60
|
||||||
|
[hours, minutes]
|
||||||
|
end
|
||||||
|
|
||||||
|
# Build a descriptive string for the TimeActivity based on the issue's tracker, ID, subject, and completion status
|
||||||
|
def build_description(issue)
|
||||||
|
base = "#{issue.tracker} ##{issue.id}: #{issue.subject}"
|
||||||
|
return base if issue.closed?
|
||||||
|
"#{base} (Partial @ #{issue.done_ratio}%)"
|
||||||
|
end
|
||||||
|
|
||||||
|
# Find an item in QBO by name, escaping single quotes to prevent query issues. Returns nil if not found.
|
||||||
|
def find_item(item_service, name)
|
||||||
|
safe = name.gsub("'", "\\\\'")
|
||||||
|
item_service.query("SELECT * FROM Item WHERE Name = '#{safe}'").first
|
||||||
|
end
|
||||||
|
|
||||||
|
def log(msg)
|
||||||
|
Rails.logger.info "[BillIssueTimeJob] #{msg}"
|
||||||
|
end
|
||||||
|
end
|
||||||
@@ -0,0 +1,54 @@
|
|||||||
|
#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.
|
||||||
|
|
||||||
|
class QboSyncDispatcher
|
||||||
|
|
||||||
|
# Payments before invoices: an invoice's paid-in-full day is worked out from the local payments' dates
|
||||||
|
SYNC_JOBS = [
|
||||||
|
Customer,
|
||||||
|
Estimate,
|
||||||
|
Payment,
|
||||||
|
Invoice,
|
||||||
|
Employee
|
||||||
|
].freeze
|
||||||
|
|
||||||
|
# Dispatches all synchronization jobs to perform a full sync of QuickBooks entities with the local database.
|
||||||
|
# Each job is enqueued with the `full_sync` flag set to true.
|
||||||
|
def self.sync!(full_sync: false)
|
||||||
|
log "Manual Sync initated for #{full_sync ? "full sync" : "incremental sync"}"
|
||||||
|
enque_jobs full_sync: full_sync
|
||||||
|
end
|
||||||
|
|
||||||
|
private
|
||||||
|
|
||||||
|
# Dynamically enques all sync jobs
|
||||||
|
def self.enque_jobs(full_sync: false)
|
||||||
|
jobs = SYNC_JOBS.dup
|
||||||
|
|
||||||
|
# Allow other plugins to add addtional sync jobs via Hooks
|
||||||
|
Redmine::Hook.call_hook( :qbo_full_sync ).each do |context|
|
||||||
|
next unless context
|
||||||
|
Array(context).each do |entity|
|
||||||
|
jobs.push(entity)
|
||||||
|
log "Added additional QBO Sync Job for #{entity.to_s}"
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
jobs.each do |job|
|
||||||
|
QboSyncStatus.queued(job.to_s)
|
||||||
|
QboSyncJob.perform_later(entity: job, full_sync: full_sync)
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
def self.log(msg)
|
||||||
|
Rails.logger.info "[QboSyncDispatcher] #{msg}"
|
||||||
|
end
|
||||||
|
|
||||||
|
end
|
||||||
@@ -0,0 +1,44 @@
|
|||||||
|
#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.
|
||||||
|
|
||||||
|
class QboSyncJob < ApplicationJob
|
||||||
|
queue_as :default
|
||||||
|
retry_on StandardError, wait: 5.minutes, attempts: 5
|
||||||
|
|
||||||
|
# Perform a full sync of all records for the entity, or an incremental sync of only those updated since the last sync
|
||||||
|
def perform(full_sync: false, id: nil, entity: nil, doc_number: nil)
|
||||||
|
raise "An entity to sync is required" unless entity
|
||||||
|
@entity = entity
|
||||||
|
|
||||||
|
log "Starting #{full_sync ? 'full' : 'incremental'} sync for #{entity} ##{id || doc_number || 'all'}..."
|
||||||
|
service = "#{entity}SyncService".constantize.new
|
||||||
|
|
||||||
|
if id.present?
|
||||||
|
service.sync_by_id(id)
|
||||||
|
elsif doc_number.present?
|
||||||
|
service.sync_by_doc_number(doc_number)
|
||||||
|
else
|
||||||
|
# Shown on the business report and the settings page while it runs
|
||||||
|
QboSyncStatus.running(entity)
|
||||||
|
begin
|
||||||
|
service.sync(full_sync: full_sync)
|
||||||
|
ensure
|
||||||
|
QboSyncStatus.finished(entity)
|
||||||
|
end
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
private
|
||||||
|
|
||||||
|
# Log messages with the entity type for better traceability
|
||||||
|
def log(msg)
|
||||||
|
Rails.logger.info "[#{@entity}SyncJob] #{msg}"
|
||||||
|
end
|
||||||
|
end
|
||||||
@@ -0,0 +1,42 @@
|
|||||||
|
#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.
|
||||||
|
|
||||||
|
class QboWebhookProcessor
|
||||||
|
|
||||||
|
# Processes the incoming QuickBooks webhook request by validating the signature and enqueuing a background job to handle the webhook payload. Raises an error if the signature is invalid.
|
||||||
|
def self.process!(request:)
|
||||||
|
body = request.raw_post
|
||||||
|
signature = request.headers['intuit-signature']
|
||||||
|
secret = RedmineQbo.webhook_token_secret
|
||||||
|
|
||||||
|
raise "Invalid signature" unless valid_signature?(body, signature, secret)
|
||||||
|
|
||||||
|
WebhookProcessJob.perform_later(body)
|
||||||
|
end
|
||||||
|
|
||||||
|
private
|
||||||
|
|
||||||
|
# Validates the QuickBooks webhook request by computing the HMAC signature and comparing it to the provided signature. Returns false if either the signature or secret is blank, or if the computed signature does not match the provided signature.
|
||||||
|
def self.valid_signature?(body, signature, secret)
|
||||||
|
return false if signature.blank? || secret.blank?
|
||||||
|
log "Validating signature"
|
||||||
|
|
||||||
|
digest = OpenSSL::Digest.new('sha256')
|
||||||
|
computed = Base64.strict_encode64(
|
||||||
|
OpenSSL::HMAC.digest(digest, secret, body)
|
||||||
|
)
|
||||||
|
|
||||||
|
ActiveSupport::SecurityUtils.secure_compare(computed, signature)
|
||||||
|
end
|
||||||
|
|
||||||
|
def self.log(msg)
|
||||||
|
Rails.logger.info "[QboWebhookProcessor] #{msg}"
|
||||||
|
end
|
||||||
|
end
|
||||||
@@ -0,0 +1,78 @@
|
|||||||
|
#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.
|
||||||
|
|
||||||
|
class WebhookProcessJob < ActiveJob::Base
|
||||||
|
queue_as :default
|
||||||
|
retry_on StandardError, wait: 5.minutes, attempts: 5
|
||||||
|
|
||||||
|
ALLOWED_ENTITIES = %w[
|
||||||
|
Customer
|
||||||
|
Invoice
|
||||||
|
Estimate
|
||||||
|
Employee
|
||||||
|
Payment
|
||||||
|
].freeze
|
||||||
|
|
||||||
|
# Process incoming QBO webhook notifications and sync relevant data to Redmine
|
||||||
|
def perform(raw_body)
|
||||||
|
log "Received webhook: #{raw_body}"
|
||||||
|
data = JSON.parse(raw_body)
|
||||||
|
|
||||||
|
data.fetch('eventNotifications', []).each do |notification|
|
||||||
|
entities = notification.dig('dataChangeEvent', 'entities') || []
|
||||||
|
|
||||||
|
entities.each do |entity|
|
||||||
|
process_entity(entity)
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
Qbo.update_time_stamp
|
||||||
|
end
|
||||||
|
|
||||||
|
private
|
||||||
|
|
||||||
|
# Process a single entity from the webhook payload and sync it to Redmine if it's an allowed type
|
||||||
|
def process_entity(entity)
|
||||||
|
log "Processing entity: #{entity}"
|
||||||
|
name = entity['name']
|
||||||
|
id = entity['id']&.to_i
|
||||||
|
|
||||||
|
entities = ALLOWED_ENTITIES.dup
|
||||||
|
# Allow other plugins to add addtional qbo entities via Hooks
|
||||||
|
Redmine::Hook.call_hook( :qbo_additional_entities ).each do |context|
|
||||||
|
next unless context
|
||||||
|
Array(context).each do |entity|
|
||||||
|
entities.push(entity)
|
||||||
|
log "Added additional QBO entity #{entity}"
|
||||||
|
end
|
||||||
|
end
|
||||||
|
return unless entities.include?(name)
|
||||||
|
|
||||||
|
model = name.safe_constantize
|
||||||
|
return unless model
|
||||||
|
|
||||||
|
if entity['deletedId']
|
||||||
|
model.delete(entity['deletedId'])
|
||||||
|
return
|
||||||
|
end
|
||||||
|
|
||||||
|
if entity['operation'] == "Delete"
|
||||||
|
model.delete(id)
|
||||||
|
else
|
||||||
|
model.sync_by_id(id)
|
||||||
|
end
|
||||||
|
rescue => e
|
||||||
|
log "#{e.message}"
|
||||||
|
end
|
||||||
|
|
||||||
|
def log(msg)
|
||||||
|
Rails.logger.info "[WebhookProcessJob] #{msg}"
|
||||||
|
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.
|
||||||
|
|
||||||
|
# Emails a customer the summary of their refund (SOP-OPS-014). It goes out like redmine_qbo_reminders' appointment
|
||||||
|
# reminders when that plugin is installed (its From, Reply-To and SMTP server, e.g. the shop's sales mailbox);
|
||||||
|
# otherwise through Redmine's own email settings, from Redmine's emission address. Not Redmine's Mailer, which only
|
||||||
|
# writes to Redmine users and adds Redmine's headers and footer.
|
||||||
|
class QboRefundMailer < ActionMailer::Base
|
||||||
|
layout false
|
||||||
|
self.raise_delivery_errors = true
|
||||||
|
|
||||||
|
class DeliveryOff < StandardError; end
|
||||||
|
|
||||||
|
def refund_summary(refund, email)
|
||||||
|
@refund = refund
|
||||||
|
@customer = refund.customer
|
||||||
|
reminders = defined?(RedmineQboReminders::Settings) ? RedmineQboReminders::Settings.current : nil
|
||||||
|
@shop_name = reminders&.[]('shop_name').to_s.presence || Setting.app_title
|
||||||
|
delivery = reminders ? reminders.delivery_options : {}
|
||||||
|
if delivery.empty? && !ActionMailer::Base.perform_deliveries
|
||||||
|
raise DeliveryOff, I18n.t(:text_refund_email_off)
|
||||||
|
end
|
||||||
|
|
||||||
|
options = { to: email, from: reminders&.from.presence || Setting.mail_from.to_s,
|
||||||
|
subject: I18n.t(:text_refund_email_subject, shop: @shop_name, amount: RedmineQboBilling::RefundWriter.money(refund.refund_amount)) }
|
||||||
|
options[:reply_to] = reminders.reply_to if reminders&.reply_to
|
||||||
|
message = mail(options.merge(delivery)) do |format|
|
||||||
|
format.text
|
||||||
|
end
|
||||||
|
message.perform_deliveries = true unless delivery.empty?
|
||||||
|
message
|
||||||
|
end
|
||||||
|
end
|
||||||
@@ -0,0 +1,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
|
||||||
@@ -0,0 +1,71 @@
|
|||||||
|
#The MIT License (MIT)
|
||||||
|
#
|
||||||
|
#Copyright (c) 2016 - 2026 rick barrette
|
||||||
|
#
|
||||||
|
#Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
|
||||||
|
#
|
||||||
|
#The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
|
||||||
|
#
|
||||||
|
#THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
||||||
|
|
||||||
|
# Estimates, invoices and payments on Redmine's activity page. They come from QuickBooks and belong to no
|
||||||
|
# project, so they show on the overall activity page only (not a project's, nor a user's), and each kind only to
|
||||||
|
# users with one of its global permissions.
|
||||||
|
module QboActivity
|
||||||
|
extend ActiveSupport::Concern
|
||||||
|
|
||||||
|
class_methods do
|
||||||
|
# event_type: the activity type registered in init.rb (e.g. 'qbo_estimates'); icon: the event's CSS class
|
||||||
|
# and icon in this plugin's sprite (assets/images/icons.svg); permissions: any one of these shows it
|
||||||
|
def qbo_activity(event_type, icon:, permissions:, title:, description:, url:)
|
||||||
|
# These models can load before Redmine adds acts_as_event to every model
|
||||||
|
include Redmine::Acts::Event unless respond_to?(:acts_as_event)
|
||||||
|
acts_as_event title: title, description: description, url: url, type: icon,
|
||||||
|
datetime: :activity_datetime, author: nil
|
||||||
|
class_attribute :qbo_activity_permissions, instance_writer: false, default: permissions
|
||||||
|
class_attribute :qbo_activity_event_type, instance_writer: false, default: event_type
|
||||||
|
end
|
||||||
|
|
||||||
|
def qbo_activity_visible_to?(user)
|
||||||
|
qbo_activity_permissions.any? { |permission| user.allowed_to?(permission, nil, global: true) }
|
||||||
|
end
|
||||||
|
|
||||||
|
# What Redmine::Activity::Fetcher reads for a project's activity page; these never show there
|
||||||
|
def activity_provider_options
|
||||||
|
{ qbo_activity_event_type => { permission: qbo_activity_permissions.first } }
|
||||||
|
end
|
||||||
|
|
||||||
|
# Documents dated from..to (the page's days, to not included), newest first. From the QuickBooks date, so
|
||||||
|
# a sync bringing in old documents doesn't pile them onto the day it ran.
|
||||||
|
def find_events(event_type, user, from, to, options)
|
||||||
|
return [] if options[:project] || options[:author] || !qbo_activity_visible_to?(user)
|
||||||
|
|
||||||
|
scope = includes(:customer).where.not(txn_date: nil)
|
||||||
|
scope = scope.where('txn_date >= ?', from.to_date) if from
|
||||||
|
scope = scope.where('txn_date < ?', to.to_date) if to
|
||||||
|
scope = scope.order(txn_date: :desc, id: :desc).limit(options[:limit]) if options[:limit]
|
||||||
|
scope.to_a
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
# When it happened: the time it reached Redmine when that was its QuickBooks date (created or changed in
|
||||||
|
# QuickBooks and sent by the webhook moments later), else midday on its QuickBooks date (e.g. a full sync)
|
||||||
|
def activity_datetime
|
||||||
|
return created_at if created_at && created_at.getlocal.to_date == txn_date
|
||||||
|
|
||||||
|
Time.local(txn_date.year, txn_date.month, txn_date.day, 12)
|
||||||
|
end
|
||||||
|
|
||||||
|
# Activity events have a project; these don't
|
||||||
|
def project
|
||||||
|
nil
|
||||||
|
end
|
||||||
|
|
||||||
|
def activity_money(amount)
|
||||||
|
ActiveSupport::NumberHelper.number_to_currency(amount) if amount
|
||||||
|
end
|
||||||
|
|
||||||
|
def activity_customer
|
||||||
|
customer&.name.presence || I18n.t(:label_none)
|
||||||
|
end
|
||||||
|
end
|
||||||
@@ -13,12 +13,13 @@ module QuickbooksOauth
|
|||||||
|
|
||||||
#== Instance Methods
|
#== Instance Methods
|
||||||
|
|
||||||
|
# This method will attempt to execute the block and if it encounters an OAuth2::Error or Quickbooks::AuthorizationFailure it will attempt to refresh the token and retry the block. It will try this up to 3 times before giving up and raising an exception.
|
||||||
def perform_authenticated_request(&block)
|
def perform_authenticated_request(&block)
|
||||||
attempts = 0
|
attempts = 0
|
||||||
begin
|
begin
|
||||||
yield oauth_access_token
|
yield oauth_access_token
|
||||||
rescue OAuth2::Error, Quickbooks::AuthorizationFailure => ex
|
rescue OAuth2::Error, Quickbooks::AuthorizationFailure => ex
|
||||||
Rails.logger.error("QuickbooksOauth.perform: #{ex.message}")
|
log "perform_authenticated_request: #{ex.message}"
|
||||||
|
|
||||||
# to prevent an infinite loop here keep a counter and bail out after N times...
|
# to prevent an infinite loop here keep a counter and bail out after N times...
|
||||||
attempts += 1
|
attempts += 1
|
||||||
@@ -32,8 +33,9 @@ module QuickbooksOauth
|
|||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
|
# This method will attempt to refresh the access token and update the record with the new access token, refresh token and their respective expiration times. If the refresh token expires in more than 0 seconds then we will set the refresh token expiration time to that value, otherwise we will set it to 100 days from now.
|
||||||
def refresh_token!
|
def refresh_token!
|
||||||
Rails.logger.info("QuickbooksOauth.refresh_token!")
|
log "refresh_token!"
|
||||||
t = oauth_access_token
|
t = oauth_access_token
|
||||||
refreshed = t.refresh!
|
refreshed = t.refresh!
|
||||||
|
|
||||||
@@ -43,7 +45,7 @@ module QuickbooksOauth
|
|||||||
oauth2_refresh_token_expires_at = 100.days.from_now
|
oauth2_refresh_token_expires_at = 100.days.from_now
|
||||||
end
|
end
|
||||||
|
|
||||||
Rails.logger.info("QuickbooksOauth.refresh_token!: #{oauth2_refresh_token_expires_at}")
|
log "refresh_token!: #{oauth2_refresh_token_expires_at}"
|
||||||
|
|
||||||
update!(
|
update!(
|
||||||
oauth2_access_token: refreshed.token,
|
oauth2_access_token: refreshed.token,
|
||||||
@@ -53,36 +55,44 @@ module QuickbooksOauth
|
|||||||
)
|
)
|
||||||
end
|
end
|
||||||
|
|
||||||
|
# This method will return an instance of the OAuth2::Client class that is configured with the consumer key, consumer secret and the appropriate URLs for the Intuit OAuth2 service. It will also set the sandbox mode based on the plugin settings.
|
||||||
def oauth_client
|
def oauth_client
|
||||||
self.class.construct_oauth2_client
|
self.class.construct_oauth2_client
|
||||||
end
|
end
|
||||||
|
|
||||||
|
# This method will return an instance of the OAuth2::AccessToken class that is configured with the current access token, refresh token and the OAuth2 client. This access token can be used to make authenticated requests to the Intuit API.
|
||||||
def oauth_access_token
|
def oauth_access_token
|
||||||
OAuth2::AccessToken.new(oauth_client, oauth2_access_token, refresh_token: oauth2_refresh_token)
|
OAuth2::AccessToken.new(oauth_client, oauth2_access_token, refresh_token: oauth2_refresh_token)
|
||||||
end
|
end
|
||||||
|
|
||||||
|
# This method is an alias for the oauth_access_token method and is used to provide a more intuitive name for the access token when making authenticated requests.
|
||||||
def consumer
|
def consumer
|
||||||
oauth_access_token
|
oauth_access_token
|
||||||
end
|
end
|
||||||
|
|
||||||
module ClassMethods
|
module ClassMethods
|
||||||
|
|
||||||
|
# This method will construct and return an instance of the OAuth2::Client class that is configured with the consumer key, consumer secret and the appropriate URLs for the Intuit OAuth2 service. It will also set the sandbox mode based on the plugin settings. This method is used by the instance method oauth_client to create a new OAuth2 client for each instance of the model that includes this concern.
|
||||||
def construct_oauth2_client
|
def construct_oauth2_client
|
||||||
|
|
||||||
oauth_consumer_key = Setting.plugin_redmine_qbo['settingsOAuthConsumerKey']
|
|
||||||
oauth_consumer_secret = Setting.plugin_redmine_qbo['settingsOAuthConsumerSecret']
|
|
||||||
|
|
||||||
# Are we are playing in the sandbox?
|
# Are we are playing in the sandbox?
|
||||||
Quickbooks.sandbox_mode = Setting.plugin_redmine_qbo[:sandbox] ? true : false
|
Quickbooks.sandbox_mode = RedmineQbo.sandbox_mode?
|
||||||
logger.info "Sandbox mode: #{Quickbooks.sandbox_mode}"
|
log "Sandbox mode: #{Quickbooks.sandbox_mode}"
|
||||||
|
|
||||||
options = {
|
options = {
|
||||||
site: "https://appcenter.intuit.com/connect/oauth2",
|
site: "https://appcenter.intuit.com/connect/oauth2",
|
||||||
authorize_url: "https://appcenter.intuit.com/connect/oauth2",
|
authorize_url: "https://appcenter.intuit.com/connect/oauth2",
|
||||||
token_url: "https://oauth.platform.intuit.com/oauth2/v1/tokens/bearer"
|
token_url: "https://oauth.platform.intuit.com/oauth2/v1/tokens/bearer"
|
||||||
}
|
}
|
||||||
OAuth2::Client.new(oauth_consumer_key, oauth_consumer_secret, options)
|
OAuth2::Client.new(RedmineQbo.oauth_consumer_key, RedmineQbo.oauth_consumer_secret, options)
|
||||||
end
|
end
|
||||||
|
|
||||||
end
|
end
|
||||||
|
|
||||||
|
|
||||||
|
private
|
||||||
|
|
||||||
|
def log(msg)
|
||||||
|
Rails.logger.info "[QuickbooksOauth] #{msg}"
|
||||||
|
end
|
||||||
end
|
end
|
||||||
@@ -8,231 +8,117 @@
|
|||||||
#
|
#
|
||||||
#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 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 Customer < ActiveRecord::Base
|
class Customer < QboBaseModel
|
||||||
|
|
||||||
|
include Redmine::Acts::Searchable
|
||||||
|
include Redmine::Acts::Event
|
||||||
|
|
||||||
has_many :issues
|
has_many :issues
|
||||||
has_many :invoices
|
has_many :invoices
|
||||||
has_many :estimates
|
has_many :estimates
|
||||||
|
has_many :payments
|
||||||
validates_presence_of :id, :name
|
validates_presence_of :name
|
||||||
|
validates :id, uniqueness: true, allow_nil: true
|
||||||
|
before_validation :normalize_phone_numbers
|
||||||
self.primary_key = :id
|
self.primary_key = :id
|
||||||
|
qbo_sync push: true
|
||||||
|
|
||||||
|
# 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) },
|
||||||
|
date_column: :updated_at
|
||||||
|
|
||||||
|
acts_as_event :title => Proc.new {|o| "#{o}"},
|
||||||
|
:url => Proc.new {|o| { :controller => 'customers', :action => 'show', :id => o.id} },
|
||||||
|
:type => :to_s,
|
||||||
|
:description => Proc.new {|o| "#{I18n.t :label_primary_phone}: #{o.phone_number} #{I18n.t:label_mobile_phone}: #{o.mobile_phone_number}"},
|
||||||
|
:datetime => Proc.new {|o| o.updated_at || o.created_at}
|
||||||
|
|
||||||
|
# Returns the customer's email address
|
||||||
|
def email
|
||||||
|
return details&.email_address&.address
|
||||||
|
end
|
||||||
|
|
||||||
|
# Updates the customer's email address
|
||||||
|
def email=(s)
|
||||||
|
details.email_address = s
|
||||||
|
end
|
||||||
|
|
||||||
|
# Customers are not bound by a project
|
||||||
|
# but we need to implement this method for the Redmine::Acts::Searchable interface
|
||||||
|
def project
|
||||||
|
nil
|
||||||
|
end
|
||||||
|
|
||||||
|
# returns the customer's mobile phone
|
||||||
|
def mobile_phone
|
||||||
|
return details&.mobile_phone&.free_form_number
|
||||||
|
end
|
||||||
|
|
||||||
|
# Updates the custome's mobile phone number
|
||||||
|
def mobile_phone=(n)
|
||||||
|
pn = Quickbooks::Model::TelephoneNumber.new
|
||||||
|
pn.free_form_number = n
|
||||||
|
details.mobile_phone = pn
|
||||||
|
end
|
||||||
|
|
||||||
|
# Updates Both local DB name & QBO display_name
|
||||||
|
def name=(s)
|
||||||
|
super(s)
|
||||||
|
# Write the normalized value from Active Record to QBO details
|
||||||
|
details.display_name = self.name
|
||||||
|
end
|
||||||
|
|
||||||
|
# Normalizes phone numbers by removing non-digit characters. This method is called before validation to ensure that phone numbers are stored in a consistent format, which can help with searching and integration with external systems like QuickBooks Online.
|
||||||
|
def normalize_phone_numbers
|
||||||
|
self.phone_number = phone_number.to_s.gsub(/\D/, '') if phone_number.present?
|
||||||
|
self.mobile_phone_number = mobile_phone_number.to_s.gsub(/\D/, '') if mobile_phone_number.present?
|
||||||
|
end
|
||||||
|
|
||||||
|
# Sets the notes for the customer
|
||||||
|
def notes=(s)
|
||||||
|
details.notes = s
|
||||||
|
end
|
||||||
|
|
||||||
|
# returns the customer's primary phone
|
||||||
|
def primary_phone
|
||||||
|
return details&.primary_phone&.free_form_number
|
||||||
|
end
|
||||||
|
|
||||||
|
# Updates the customer's primary phone number
|
||||||
|
def primary_phone=(n)
|
||||||
|
pn = Quickbooks::Model::TelephoneNumber.new
|
||||||
|
pn.free_form_number = n
|
||||||
|
details.primary_phone = pn
|
||||||
|
end
|
||||||
|
|
||||||
|
# Seach for customers by name or phone number
|
||||||
|
def self.search(search)
|
||||||
|
#return none if search.blank?
|
||||||
|
search = sanitize_sql_like(search)
|
||||||
|
where("name LIKE ? OR phone_number LIKE ? OR mobile_phone_number LIKE ?", "%#{search}%", "%#{search}%", "%#{search}%")
|
||||||
|
end
|
||||||
|
|
||||||
|
# Override the defult redmine seach method to rank results by id
|
||||||
|
def self.search_result_ranks_and_ids(tokens, user, project = nil, options = {})
|
||||||
|
return {} if tokens.blank?
|
||||||
|
|
||||||
|
scope = self.all
|
||||||
|
|
||||||
|
tokens.each do |token|
|
||||||
|
scope = scope.search(token)
|
||||||
|
end
|
||||||
|
|
||||||
|
ids = scope.distinct.limit(options[:limit] || 100).pluck(:id)
|
||||||
|
ids.index_with { |id| id }
|
||||||
|
end
|
||||||
|
|
||||||
# returns a human readable string
|
# returns a human readable string
|
||||||
def to_s
|
def to_s
|
||||||
return "#{self[:name]} - #{phone_number.split(//).last(4).join unless phone_number.nil?}"
|
last4 = phone_number&.last(4)
|
||||||
end
|
last4.present? ? "#{name} - #{last4}" : name.to_s
|
||||||
|
|
||||||
# Convenience Method
|
|
||||||
# returns the customer's email
|
|
||||||
def email
|
|
||||||
pull unless @details
|
|
||||||
begin
|
|
||||||
return @details.email_address.address
|
|
||||||
rescue
|
|
||||||
return nil
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
# Convenience Method
|
|
||||||
# Sets the email
|
|
||||||
def email=(s)
|
|
||||||
pull unless @details
|
|
||||||
@details.email_address = s
|
|
||||||
end
|
|
||||||
|
|
||||||
# Convenience Method
|
|
||||||
# returns the customer's primary phone
|
|
||||||
def primary_phone
|
|
||||||
pull unless @details
|
|
||||||
begin
|
|
||||||
return @details.primary_phone.free_form_number
|
|
||||||
rescue
|
|
||||||
return nil
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
# Convenience Method
|
|
||||||
# Updates the customer's primary phone number
|
|
||||||
def primary_phone=(n)
|
|
||||||
pull unless @details
|
|
||||||
pn = Quickbooks::Model::TelephoneNumber.new
|
|
||||||
pn.free_form_number = n
|
|
||||||
@details.primary_phone = pn
|
|
||||||
#update our locally stored number too
|
|
||||||
update_phone_number
|
|
||||||
end
|
|
||||||
|
|
||||||
# Convenience Method
|
|
||||||
# returns the customer's mobile phone
|
|
||||||
def mobile_phone
|
|
||||||
pull unless @details
|
|
||||||
begin
|
|
||||||
return @details.mobile_phone.free_form_number
|
|
||||||
rescue
|
|
||||||
return nil
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
# Convenience Method
|
|
||||||
# Updates the custome's mobile phone number
|
|
||||||
def mobile_phone=(n)
|
|
||||||
pull unless @details
|
|
||||||
pn = Quickbooks::Model::TelephoneNumber.new
|
|
||||||
pn.free_form_number = n
|
|
||||||
@details.mobile_phone = pn
|
|
||||||
#update our locally stored number too
|
|
||||||
update_mobile_phone_number
|
|
||||||
end
|
|
||||||
|
|
||||||
# Convenience Method
|
|
||||||
# Sets the notes
|
|
||||||
def notes=(s)
|
|
||||||
pull unless @details
|
|
||||||
@details.notes = s
|
|
||||||
end
|
|
||||||
|
|
||||||
# update the localy stored phone number as a plain string with no special chars
|
|
||||||
def update_phone_number
|
|
||||||
begin
|
|
||||||
self.phone_number = self.primary_phone.tr('^0-9', '')
|
|
||||||
rescue
|
|
||||||
return nil
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
# update the localy stored phone number as a plain string with no special chars
|
|
||||||
def update_mobile_phone_number
|
|
||||||
begin
|
|
||||||
self.mobile_phone_number = self.mobile_phone.tr('^0-9', '')
|
|
||||||
rescue
|
|
||||||
return nil
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
# Convenience Method
|
|
||||||
# Updates Both local DB name & QBO display_name
|
|
||||||
def name=(s)
|
|
||||||
pull unless @details
|
|
||||||
@details.display_name = s
|
|
||||||
super
|
|
||||||
end
|
|
||||||
|
|
||||||
# Magic Method
|
|
||||||
# Maps Get/Set methods to QBO customer object
|
|
||||||
def method_missing(sym, *arguments)
|
|
||||||
# Check to see if the method exists
|
|
||||||
if Quickbooks::Model::Customer.method_defined?(sym)
|
|
||||||
# download details if required
|
|
||||||
pull unless @details
|
|
||||||
method_name = sym.to_s
|
|
||||||
# Setter
|
|
||||||
if method_name[-1, 1] == "="
|
|
||||||
@details.method(method_name).call(arguments[0])
|
|
||||||
# Getter
|
|
||||||
else
|
|
||||||
return @details.method(method_name).call
|
|
||||||
end
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
# proforms a bruteforce sync operation
|
|
||||||
# This needs to be simplified
|
|
||||||
def self.sync
|
|
||||||
# Sync ALL customers if the database is empty
|
|
||||||
qbo = Qbo.first
|
|
||||||
customers = qbo.perform_authenticated_request do |access_token|
|
|
||||||
service = Quickbooks::Service::Customer.new(company_id: qbo.realm_id, access_token: access_token)
|
|
||||||
service.all
|
|
||||||
end
|
|
||||||
|
|
||||||
return unless customers
|
|
||||||
|
|
||||||
customers.each do |c|
|
|
||||||
logger.info "Processing customer #{c.id}"
|
|
||||||
customer = Customer.find_or_create_by(id: c.id)
|
|
||||||
if c.active?
|
|
||||||
#if not customer.name.eql? c.display_name
|
|
||||||
customer.name = c.display_name
|
|
||||||
customer.id = c.id
|
|
||||||
customer.phone_number = c.primary_phone.free_form_number.tr('^0-9', '') unless c.primary_phone.nil?
|
|
||||||
customer.mobile_phone_number = c.mobile_phone.free_form_number.tr('^0-9', '') unless c.mobile_phone.nil?
|
|
||||||
customer.save_without_push
|
|
||||||
#end
|
|
||||||
else
|
|
||||||
if not c.new_record?
|
|
||||||
customer.delete
|
|
||||||
end
|
|
||||||
end
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
# Searchs the database for a customer by name or phone number with out special chars
|
|
||||||
def self.search(search)
|
|
||||||
customers = where("name LIKE ? OR phone_number LIKE ? OR mobile_phone_number LIKE ?", "%#{search}%", "%#{search}%", "%#{search}%")
|
|
||||||
return customers.order(:name)
|
|
||||||
end
|
|
||||||
|
|
||||||
# proforms a bruteforce sync operation
|
|
||||||
# This needs to be simplified
|
|
||||||
def self.sync_by_id(id)
|
|
||||||
qbo = Qbo.first
|
|
||||||
c = qbo.perform_authenticated_request do |access_token|
|
|
||||||
service = Quickbooks::Service::Customer.new(company_id: qbo.realm_id, access_token: access_token)
|
|
||||||
service.fetch_by_id(id)
|
|
||||||
end
|
|
||||||
|
|
||||||
return unless c
|
|
||||||
|
|
||||||
customer = Customer.find_or_create_by(id: c.id)
|
|
||||||
if c.active?
|
|
||||||
#if not customer.name.eql? c.display_name
|
|
||||||
customer.name = c.display_name
|
|
||||||
customer.id = c.id
|
|
||||||
customer.phone_number = c.primary_phone.free_form_number.tr('^0-9', '') unless c.primary_phone.nil?
|
|
||||||
customer.mobile_phone_number = c.mobile_phone.free_form_number.tr('^0-9', '') unless c.mobile_phone.nil?
|
|
||||||
customer.save_without_push
|
|
||||||
#end
|
|
||||||
else
|
|
||||||
if not customer.new_record?
|
|
||||||
customer.delete
|
|
||||||
end
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
# Push the updates
|
|
||||||
def save_with_push
|
|
||||||
begin
|
|
||||||
qbo = Qbo.first
|
|
||||||
@details = qbo.perform_authenticated_request do |access_token|
|
|
||||||
service = Quickbooks::Service::Customer.new(company_id: qbo.realm_id, access_token: access_token)
|
|
||||||
service.update(@details)
|
|
||||||
end
|
|
||||||
#raise "QBO Fault" if @details.fault?
|
|
||||||
self.id = @details.id
|
|
||||||
rescue Exception => e
|
|
||||||
errors.add(e.message)
|
|
||||||
end
|
|
||||||
save_without_push
|
|
||||||
end
|
|
||||||
|
|
||||||
alias_method :save_without_push, :save
|
|
||||||
alias_method :save, :save_with_push
|
|
||||||
|
|
||||||
private
|
|
||||||
|
|
||||||
# pull the details
|
|
||||||
def pull
|
|
||||||
begin
|
|
||||||
raise Exception unless self.id
|
|
||||||
qbo = Qbo.first
|
|
||||||
@details = qbo.perform_authenticated_request do |access_token|
|
|
||||||
service = Quickbooks::Service::Customer.new(company_id: qbo.realm_id, access_token: access_token)
|
|
||||||
service.fetch_by_id(self.id)
|
|
||||||
end
|
|
||||||
rescue Exception => e
|
|
||||||
@details = Quickbooks::Model::Customer.new
|
|
||||||
end
|
|
||||||
end
|
end
|
||||||
|
|
||||||
end
|
end
|
||||||
@@ -8,54 +8,49 @@
|
|||||||
#
|
#
|
||||||
#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 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 CustomerToken < ActiveRecord::Base
|
class CustomerToken < ApplicationRecord
|
||||||
|
belongs_to :issue
|
||||||
|
|
||||||
has_many :issues
|
validates :issue_id, presence: true
|
||||||
validates_presence_of :issue_id
|
validates :token, presence: true, uniqueness: true
|
||||||
before_create :generate_token, :generate_expire_date
|
|
||||||
attr_accessor :destroyed
|
|
||||||
after_destroy :mark_as_destroyed
|
|
||||||
|
|
||||||
OAUTH_CONSUMER_SECRET = Setting.plugin_redmine_qbo['settingsOAuthConsumerSecret'] || 'CONFIGURE__' + SecureRandom.uuid
|
before_validation :generate_token, on: :create
|
||||||
|
before_validation :generate_expire_date, on: :create
|
||||||
|
|
||||||
# generates a random token using the plugin setting settingsOAuthConsumerSecret for salt
|
scope :active, -> { where("expires_at > ?", Time.current) }
|
||||||
def generate_token
|
|
||||||
self.token = SecureRandom.base64(15).tr('+/=lIO0', OAUTH_CONSUMER_SECRET)
|
|
||||||
end
|
|
||||||
|
|
||||||
# generates an expiring date
|
TOKEN_EXPIRATION = 1.month
|
||||||
def generate_expire_date
|
|
||||||
self.expires_at = Time.now + 1.month
|
|
||||||
end
|
|
||||||
|
|
||||||
# set destroyed flag
|
# Check if the token has expired
|
||||||
def mark_as_destroyed
|
|
||||||
self.destroyed = true
|
|
||||||
end
|
|
||||||
|
|
||||||
# purge expired tokens
|
|
||||||
def self.remove_expired_tokens
|
|
||||||
where("expires_at < ?", Time.now).destroy_all
|
|
||||||
end
|
|
||||||
|
|
||||||
# has the token expired?
|
|
||||||
def expired?
|
def expired?
|
||||||
self.expires_at < Time.now
|
expires_at.present? && expires_at <= Time.current
|
||||||
end
|
end
|
||||||
|
|
||||||
# Getter convenience method for tokens
|
# Remove expired tokens from the database
|
||||||
|
def self.remove_expired_tokens
|
||||||
|
where("expires_at <= ?", Time.current).delete_all
|
||||||
|
end
|
||||||
|
|
||||||
|
# Get or create a token for the given issue
|
||||||
def self.get_token(issue)
|
def self.get_token(issue)
|
||||||
|
return unless issue
|
||||||
|
return unless User.current.allowed_to?(:view_issues, issue.project)
|
||||||
|
|
||||||
# check to see if token exists & if it is expired
|
token = active.find_by(issue_id: issue.id)
|
||||||
token = find_by_issue_id issue.id
|
return token if token
|
||||||
unless token.nil?
|
|
||||||
return token unless token.expired?
|
|
||||||
# remove expired tokens
|
|
||||||
token.destroy
|
|
||||||
end
|
|
||||||
|
|
||||||
# only create new token if we have an issue to attach it to
|
create!(issue: issue)
|
||||||
return create(issue_id: issue.id) if User.current.logged?
|
|
||||||
end
|
end
|
||||||
|
|
||||||
|
private
|
||||||
|
|
||||||
|
# Generate a unique token for the customer
|
||||||
|
def generate_token
|
||||||
|
self.token ||= SecureRandom.urlsafe_base64(32)
|
||||||
|
end
|
||||||
|
|
||||||
|
# Generate an expiration date for the token
|
||||||
|
def generate_expire_date
|
||||||
|
self.expires_at ||= Time.current + TOKEN_EXPIRATION
|
||||||
|
end
|
||||||
end
|
end
|
||||||
@@ -8,42 +8,12 @@
|
|||||||
#
|
#
|
||||||
#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 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 Employee < ActiveRecord::Base
|
class Employee < QboBaseModel
|
||||||
|
|
||||||
has_many :users
|
has_many :users
|
||||||
validates_presence_of :id, :name
|
validates_presence_of :id, :name
|
||||||
|
validates :id, uniqueness: true
|
||||||
|
self.primary_key = :id
|
||||||
|
qbo_sync push: false
|
||||||
|
|
||||||
def self.sync
|
|
||||||
qbo = Qbo.first
|
|
||||||
employees = qbo.perform_authenticated_request do |access_token|
|
|
||||||
service = Quickbooks::Service::Employee.new(company_id: qbo.realm_id, access_token: access_token)
|
|
||||||
service.all
|
|
||||||
end
|
|
||||||
|
|
||||||
return unless employees
|
|
||||||
|
|
||||||
transaction do
|
|
||||||
employees.each { |e|
|
|
||||||
logger.info "Processing employee #{e.id}"
|
|
||||||
employee = find_or_create_by(id: e.id)
|
|
||||||
employee.name = e.display_name
|
|
||||||
employee.id = e.id
|
|
||||||
employee.save!
|
|
||||||
}
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
def self.sync_by_id(id)
|
|
||||||
qbo = Qbo.first
|
|
||||||
employee = qbo.perform_authenticated_request do |access_token|
|
|
||||||
service = Quickbooks::Service::Employee.new(company_id: qbo.realm_id, access_token: access_token)
|
|
||||||
service.fetch_by_id(id)
|
|
||||||
end
|
|
||||||
|
|
||||||
return unless employee
|
|
||||||
employee = find_or_create_by(id: employee.id)
|
|
||||||
employee.name = employee.display_name
|
|
||||||
employee.id = employee.id
|
|
||||||
employee.save!
|
|
||||||
end
|
|
||||||
end
|
end
|
||||||
@@ -8,126 +8,39 @@
|
|||||||
#
|
#
|
||||||
#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 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 Estimate < ActiveRecord::Base
|
class Estimate < QboBaseModel
|
||||||
|
|
||||||
has_and_belongs_to_many :issues
|
has_many :issues
|
||||||
belongs_to :customer
|
belongs_to :customer
|
||||||
validates_presence_of :doc_number, :id
|
validates_presence_of :doc_number, :id
|
||||||
|
validates :id, uniqueness: true
|
||||||
self.primary_key = :id
|
self.primary_key = :id
|
||||||
|
qbo_sync push: false
|
||||||
|
|
||||||
|
include QboActivity
|
||||||
|
qbo_activity 'qbo_estimates', icon: 'qbo-estimate', permissions: %i[view_customers write_estimates],
|
||||||
|
title: ->(e) { I18n.t(:label_activity_estimate, number: e.doc_number, customer: e.activity_customer) },
|
||||||
|
description: ->(e) { [e.activity_money(e[:total_amount]), e[:txn_status]].compact.join(' · ') },
|
||||||
|
url: ->(e) { { controller: 'estimates', action: 'show', id: e.id } }
|
||||||
|
|
||||||
|
def name
|
||||||
|
to_s
|
||||||
|
end
|
||||||
|
|
||||||
|
# True once QuickBooks has turned it into an invoice (status cached by the sync). The estimate page also
|
||||||
|
# checks for a linked invoice; either way a billed estimate can't be changed in Redmine.
|
||||||
|
def billed?
|
||||||
|
RedmineQboBilling::EstimateWriter::BILLED_STATUSES.include?(self[:txn_status].to_s)
|
||||||
|
end
|
||||||
|
|
||||||
# returns a human readable string
|
# returns a human readable string
|
||||||
def to_s
|
def to_s
|
||||||
return self[:doc_number]
|
return self[:doc_number]
|
||||||
end
|
end
|
||||||
|
|
||||||
# sync all estimates
|
# sync only one estimate by document number
|
||||||
def self.sync
|
|
||||||
logger.info "Syncing ALL estimates"
|
|
||||||
qbo = Qbo.first
|
|
||||||
estimates = qbo.perform_authenticated_request do |access_token|
|
|
||||||
service = Quickbooks::Service::Estimate.new(company_id: qbo.realm_id, access_token: access_token)
|
|
||||||
service.all
|
|
||||||
end
|
|
||||||
|
|
||||||
return unless estimates
|
|
||||||
|
|
||||||
estimates.each { |estimate|
|
|
||||||
process_estimate(estimate)
|
|
||||||
}
|
|
||||||
|
|
||||||
#remove deleted estimates
|
|
||||||
where.not(estimates.map(&:id)).destroy_all
|
|
||||||
end
|
|
||||||
|
|
||||||
# sync only one estimate
|
|
||||||
def self.sync_by_id(id)
|
|
||||||
logger.info "Syncing estimate #{id}"
|
|
||||||
qbo = Qbo.first
|
|
||||||
qbo.perform_authenticated_request do |access_token|
|
|
||||||
service = Quickbooks::Service::Estimate.new(company_id: qbo.realm_id, access_token: access_token)
|
|
||||||
process_estimate(service.fetch_by_id(id))
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
# sync only one estimate
|
|
||||||
def self.sync_by_doc_number(number)
|
def self.sync_by_doc_number(number)
|
||||||
logger.info "Syncing estimate by doc number #{number}"
|
QboSyncJob.perform_later(entity: model_name.name, doc_number: number)
|
||||||
qbo = Qbo.first
|
|
||||||
qbo.perform_authenticated_request do |access_token|
|
|
||||||
service = Quickbooks::Service::Estimate.new(company_id: qbo.realm_id, access_token: access_token)
|
|
||||||
process_estimate(service.find_by( :doc_number, number).first)
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
# update an estimate
|
|
||||||
def self.update(id)
|
|
||||||
qbo = Qbo.first
|
|
||||||
estimate = qbo.perform_authenticated_request do |access_token|
|
|
||||||
service = Quickbooks::Service::Estimate.new(company_id: qbo.realm_id, access_token: access_token)
|
|
||||||
service.fetch_by_id(id)
|
|
||||||
end
|
|
||||||
|
|
||||||
return unless estimate
|
|
||||||
|
|
||||||
e = find_or_create_by(id: id)
|
|
||||||
e.doc_number = estimate.doc_number
|
|
||||||
e.txn_date = estimate.txn_date
|
|
||||||
e.save!
|
|
||||||
end
|
|
||||||
|
|
||||||
# process an estimate into the database
|
|
||||||
def self.process_estimate(qbo_estimate)
|
|
||||||
logger.info "Processing estimate #{qbo_estimate.id}"
|
|
||||||
estimate = find_or_create_by(id: qbo_estimate.id)
|
|
||||||
estimate.doc_number = qbo_estimate.doc_number
|
|
||||||
estimate.customer_id = qbo_estimate.customer_ref.value
|
|
||||||
estimate.id = qbo_estimate.id
|
|
||||||
estimate.txn_date = qbo_estimate.txn_date
|
|
||||||
estimate.save!
|
|
||||||
end
|
|
||||||
|
|
||||||
# download the pdf from quickbooks
|
|
||||||
def pdf
|
|
||||||
qbo = Qbo.first
|
|
||||||
qbo.perform_authenticated_request do |access_token|
|
|
||||||
service = Quickbooks::Service::Estimate.new(company_id: qbo.realm_id, access_token: access_token)
|
|
||||||
estimate = service.fetch_by_id(id)
|
|
||||||
service.pdf(estimate)
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
# Magic Method
|
|
||||||
# Maps Get/Set methods to QBO estimate object
|
|
||||||
def method_missing(sym, *arguments)
|
|
||||||
# Check to see if the method exists
|
|
||||||
if Quickbooks::Model::Estimate.method_defined?(sym)
|
|
||||||
# download details if required
|
|
||||||
pull unless @details
|
|
||||||
method_name = sym.to_s
|
|
||||||
# Setter
|
|
||||||
if method_name[-1, 1] == "="
|
|
||||||
@details.method(method_name).call(arguments[0])
|
|
||||||
# Getter
|
|
||||||
else
|
|
||||||
return @details.method(method_name).call
|
|
||||||
end
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
private
|
|
||||||
|
|
||||||
# pull the details
|
|
||||||
def pull
|
|
||||||
begin
|
|
||||||
raise Exception unless self.id
|
|
||||||
qbo = Qbo.first
|
|
||||||
@details = qbo.perform_authenticated_request do |access_token|
|
|
||||||
service = Quickbooks::Service::Estimate.new(company_id: qbo.realm_id, access_token: access_token)
|
|
||||||
service(:estimate).fetch_by_id(self.id)
|
|
||||||
end
|
|
||||||
rescue Exception => e
|
|
||||||
@details = Quickbooks::Model::Estimate.new
|
|
||||||
end
|
|
||||||
end
|
end
|
||||||
|
|
||||||
end
|
end
|
||||||
@@ -8,201 +8,40 @@
|
|||||||
#
|
#
|
||||||
#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 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 Invoice < ActiveRecord::Base
|
class Invoice < QboBaseModel
|
||||||
|
|
||||||
has_and_belongs_to_many :issues
|
has_and_belongs_to_many :issues
|
||||||
belongs_to :customer
|
belongs_to :customer
|
||||||
validates_presence_of :doc_number, :id, :customer_id, :txn_date
|
validates :id, presence: true, uniqueness: true
|
||||||
|
validates :doc_number, :txn_date, presence: true
|
||||||
self.primary_key = :id
|
self.primary_key = :id
|
||||||
|
qbo_sync push: false
|
||||||
|
|
||||||
# returns a human readable string
|
include QboActivity
|
||||||
|
qbo_activity 'qbo_invoices', icon: 'qbo-invoice', permissions: %i[view_customers write_invoices],
|
||||||
|
title: ->(i) { I18n.t(:label_activity_invoice, number: i.doc_number, customer: i.activity_customer) },
|
||||||
|
description: ->(i) { i.activity_description },
|
||||||
|
url: ->(i) { { controller: 'invoices', action: 'show', id: i.id } }
|
||||||
|
|
||||||
|
# Return the invoice's document number as its string representation
|
||||||
def to_s
|
def to_s
|
||||||
return self[:doc_number]
|
doc_number
|
||||||
end
|
end
|
||||||
|
|
||||||
# sync ALL the invoices
|
# Amount and where it stands, e.g. "$1,250.00 · Partially paid ($400.00 owed)"
|
||||||
def self.sync
|
def activity_description
|
||||||
logger.info "Syncing all invoices"
|
state = status
|
||||||
last = Qbo.first.last_sync
|
owed = activity_money(self[:balance]) if state && self[:balance].to_d.positive?
|
||||||
|
[activity_money(self[:total_amount]),
|
||||||
query = "SELECT Id, DocNumber FROM Invoice"
|
(I18n.t(:"label_invoice_status_#{state}", default: state.to_s.humanize) if state),
|
||||||
query << " WHERE Metadata.LastUpdatedTime >= '#{last.iso8601}' " if last
|
(I18n.t(:text_activity_invoice_owed, amount: owed) if owed && state != :open && state != :overdue)].compact.join(' · ')
|
||||||
|
|
||||||
# TODO actually do something with the above query
|
|
||||||
# .all() is never called since count is never initialized
|
|
||||||
qbo = Qbo.first
|
|
||||||
invoices = qbo.perform_authenticated_request do |access_token|
|
|
||||||
service = Quickbooks::Service::Invoice.new(company_id: qbo.realm_id, access_token: access_token)
|
|
||||||
service.all
|
|
||||||
end
|
|
||||||
|
|
||||||
return unless invoices
|
|
||||||
|
|
||||||
invoices.each { | invoice |
|
|
||||||
process_invoice invoice
|
|
||||||
}
|
|
||||||
end
|
end
|
||||||
|
|
||||||
#sync by invoice ID
|
# Paid, partially paid, overdue, open or voided, from the cached total, balance and due date
|
||||||
def self.sync_by_id(id)
|
# (RedmineQboBilling::InvoiceStatus); nil when the balance isn't cached
|
||||||
logger.info "Syncing invoice #{id}"
|
def status(today: User.current.today)
|
||||||
qbo = Qbo.first
|
RedmineQboBilling::InvoiceStatus.status(total: self[:total_amount], balance: self[:balance],
|
||||||
qbo.perform_authenticated_request do |access_token|
|
due_date: self[:due_date], today: today)
|
||||||
service = Quickbooks::Service::Invoice.new(company_id: qbo.realm_id, access_token: access_token)
|
|
||||||
invoice = service.fetch_by_id(id)
|
|
||||||
process_invoice invoice
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
private
|
|
||||||
|
|
||||||
# Attach the invoice to the issue
|
|
||||||
def self.attach_to_issue(issue, invoice)
|
|
||||||
return if issue.nil?
|
|
||||||
|
|
||||||
# skip this issue if the issue customer is not the same as the invoice customer
|
|
||||||
return if issue.customer_id != invoice.customer_ref.value.to_i
|
|
||||||
|
|
||||||
logger.info "Attaching invoice #{invoice.id} to issue #{issue.id}"
|
|
||||||
|
|
||||||
invoice = Invoice.find_or_create_by(id: invoice.id)
|
|
||||||
|
|
||||||
unless issue.invoices.include?(invoice)
|
|
||||||
issue.invoices << invoice
|
|
||||||
issue.save!
|
|
||||||
end
|
|
||||||
|
|
||||||
compare_custom_fields(issue, invoice)
|
|
||||||
end
|
|
||||||
|
|
||||||
# processes the invoice into the database
|
|
||||||
def self.process_invoice(i)
|
|
||||||
logger.info "Processing invoice #{i.id}"
|
|
||||||
|
|
||||||
# Load the invoice into the database
|
|
||||||
invoice = Invoice.find_or_create_by(id: i.id)
|
|
||||||
invoice.doc_number = i.doc_number
|
|
||||||
invoice.id = i.id
|
|
||||||
invoice.customer_id = i.customer_ref
|
|
||||||
invoice.txn_date = i.txn_date
|
|
||||||
invoice.save!
|
|
||||||
|
|
||||||
# Scan the private notes for hashtags and attach to the applicable issues
|
|
||||||
if not i.private_note.nil?
|
|
||||||
i.private_note.scan(/#(\w+)/).flatten.each { |issue|
|
|
||||||
attach_to_issue(Issue.find_by_id(issue.to_i), invoice)
|
|
||||||
}
|
|
||||||
end
|
|
||||||
|
|
||||||
# Scan the line items for hashtags and attach to the applicable issues
|
|
||||||
i.line_items.each { |line|
|
|
||||||
if line.description
|
|
||||||
line.description.scan(/#(\w+)/).flatten.each { |issue|
|
|
||||||
attach_to_issue(Issue.find_by_id(issue.to_i), invoice)
|
|
||||||
}
|
|
||||||
end
|
|
||||||
}
|
|
||||||
end
|
|
||||||
|
|
||||||
# compares the custome fields on invoices & issues and updates the invoice as needed
|
|
||||||
#
|
|
||||||
# the issue here is when two or more issues share an invoice with the same custom field, but diffrent values
|
|
||||||
# this condions causes an infinite loop as the webhook is called when an invoice is updated
|
|
||||||
# TODO maybe add a cf_sync_confict flag to invoices
|
|
||||||
def self.compare_custom_fields(issue, invoice)
|
|
||||||
logger.info "Comparing custom fields"
|
|
||||||
# TODO break if Invoice.find(invoice.id).cf_sync_confict
|
|
||||||
is_changed = false
|
|
||||||
|
|
||||||
logger.debug "Calling :process_invoice_custom_fields hook"
|
|
||||||
context = Redmine::Hook.call_hook :process_invoice_custom_fields, { issue: issue, invoice: invoice }
|
|
||||||
|
|
||||||
# Process updates from the hooks
|
|
||||||
context.each do |c|
|
|
||||||
unless c.nil?
|
|
||||||
logger.debug "Invoice.compare_custom_fields: We have a responce from a hook"
|
|
||||||
push_updates c[:invoice] if c[:is_changed]
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
# Process Issue Custom Values
|
|
||||||
begin
|
|
||||||
value = issue.custom_values.find_by(custom_field_id: CustomField.find_by_name(cf.name).id)
|
|
||||||
|
|
||||||
# Check to see if the value is blank...
|
|
||||||
if not value.value.to_s.blank?
|
|
||||||
# Check to see if the value is diffrent
|
|
||||||
if not cf.string_value.to_s.eql? value.value.to_s
|
|
||||||
# update the custom field on the invoice
|
|
||||||
cf.string_value = value.value.to_s
|
|
||||||
is_changed = true
|
|
||||||
end
|
|
||||||
end
|
|
||||||
rescue
|
|
||||||
# Nothing to do here, there is no match
|
|
||||||
end
|
|
||||||
|
|
||||||
push_updates invoice if is_changed
|
|
||||||
end
|
|
||||||
|
|
||||||
# pushes invoice updates
|
|
||||||
def self.push_updates(invoice)
|
|
||||||
begin
|
|
||||||
logger.info "Invoice.push_updates"
|
|
||||||
qbo = Qbo.first
|
|
||||||
qbo.perform_authenticated_request do |access_token|
|
|
||||||
service = Quickbooks::Service::Invoice.new(company_id: qbo.realm_id, access_token: access_token)
|
|
||||||
service.update invoice
|
|
||||||
end
|
|
||||||
rescue
|
|
||||||
# Do nothing, probaly custome field sync confict on the invoice.
|
|
||||||
# This is a problem with how it's billed
|
|
||||||
# TODO Add notes in memo area
|
|
||||||
# TODO flag Invoice.cf_sync_confict here
|
|
||||||
logger.error "Failed to update invoice"
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
# download the pdf from quickbooks
|
|
||||||
def pdf
|
|
||||||
qbo = Qbo.first
|
|
||||||
qbo.perform_authenticated_request do |access_token|
|
|
||||||
service = Quickbooks::Service::Invoice.new(company_id: qbo.realm_id, access_token: access_token)
|
|
||||||
invoice = service.fetch_by_id(id)
|
|
||||||
return service.pdf(invoice)
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
# Magic Method
|
|
||||||
# Maps Get/Set methods to QBO invoice object
|
|
||||||
def method_missing(sym, *arguments)
|
|
||||||
# Check to see if the method exists
|
|
||||||
if Quickbooks::Model::Invoice.method_defined?(sym)
|
|
||||||
# download details if required
|
|
||||||
pull unless @details
|
|
||||||
method_name = sym.to_s
|
|
||||||
# Setter
|
|
||||||
if method_name[-1, 1] == "="
|
|
||||||
@details.method(method_name).call(arguments[0])
|
|
||||||
# Getter
|
|
||||||
else
|
|
||||||
return @details.method(method_name).call
|
|
||||||
end
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
# pull the details from quickbooks
|
|
||||||
def pull
|
|
||||||
begin
|
|
||||||
raise Exception unless self.id
|
|
||||||
qbo = Qbo.first
|
|
||||||
@details = qbo.perform_authenticated_request do |access_token|
|
|
||||||
service = Quickbooks::Service::Invoice.new(company_id: qbo.realm_id, access_token: access_token)
|
|
||||||
service.fetch_by_id(self.id)
|
|
||||||
end
|
|
||||||
rescue Exception => e
|
|
||||||
@details = Quickbooks::Model::Invoice.new
|
|
||||||
end
|
|
||||||
end
|
end
|
||||||
|
|
||||||
end
|
end
|
||||||
@@ -0,0 +1,76 @@
|
|||||||
|
#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
|
||||||
|
|
||||||
|
# QuickBooks only requires a name: services such as Labor often have no description or rate
|
||||||
|
validates_presence_of :id, :name
|
||||||
|
validates :unit_price, numericality: { greater_than_or_equal_to: 0 }
|
||||||
|
|
||||||
|
# QuickBooks item types that can't go on an estimate or invoice line themselves
|
||||||
|
UNSELLABLE_TYPES = %w[Category Group].freeze
|
||||||
|
|
||||||
|
# Active products/services that can go on a line (services, non-inventory and inventory items), for the
|
||||||
|
# pickers and the labor products/services setting
|
||||||
|
scope :sellable, -> { where(active: true).where.not(type: UNSELLABLE_TYPES).or(where(active: true, type: nil)) }
|
||||||
|
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,38 @@
|
|||||||
|
#The MIT License (MIT)
|
||||||
|
#
|
||||||
|
#Copyright (c) 2026 rick barrette
|
||||||
|
#
|
||||||
|
#Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
|
||||||
|
#
|
||||||
|
#The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
|
||||||
|
#
|
||||||
|
#THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
||||||
|
|
||||||
|
|
||||||
|
# A customer payment, cached from QuickBooks for reporting: id, customer, date and amount. Kept current by the
|
||||||
|
# webhook and the sync; payments are received through the Receive payment page (RedmineQboBilling::PaymentWriter).
|
||||||
|
class Payment < QboBaseModel
|
||||||
|
|
||||||
|
belongs_to :customer, optional: true
|
||||||
|
validates :id, presence: true, uniqueness: true
|
||||||
|
self.primary_key = :id
|
||||||
|
qbo_sync push: false
|
||||||
|
|
||||||
|
include QboActivity
|
||||||
|
qbo_activity 'qbo_payments', icon: 'qbo-payment', permissions: %i[view_payments receive_payments],
|
||||||
|
title: ->(p) { I18n.t(:label_activity_payment, customer: p.activity_customer, amount: p.activity_money(p.total_amount)) },
|
||||||
|
description: ->(p) { p.activity_description },
|
||||||
|
url: ->(p) { { controller: 'qbo_payments', action: 'show', id: p.id } }
|
||||||
|
|
||||||
|
# Money not yet applied to an invoice, when there is some
|
||||||
|
def activity_description
|
||||||
|
return '' unless unapplied_amount.to_d.positive?
|
||||||
|
|
||||||
|
I18n.t(:text_activity_payment_unapplied, amount: activity_money(unapplied_amount))
|
||||||
|
end
|
||||||
|
|
||||||
|
def to_s
|
||||||
|
"#{txn_date} #{total_amount}"
|
||||||
|
end
|
||||||
|
|
||||||
|
end
|
||||||
@@ -13,16 +13,48 @@ class Qbo < ActiveRecord::Base
|
|||||||
include QuickbooksOauth
|
include QuickbooksOauth
|
||||||
include Redmine::I18n
|
include Redmine::I18n
|
||||||
|
|
||||||
|
validate :single_record_only, on: :create
|
||||||
|
|
||||||
|
# Returns the last sync time formatted for display. If no sync has occurred, returns a default message.
|
||||||
|
def self.last_sync
|
||||||
|
qbo = QboConnectionService.current!
|
||||||
|
format_time(qbo.last_sync)
|
||||||
|
rescue
|
||||||
|
return I18n.t(:label_qbo_never_synced)
|
||||||
|
end
|
||||||
|
|
||||||
|
# Token expiry times, or nil when QuickBooks isn't connected (the settings page shows N/A)
|
||||||
|
def self.oauth2_access_token_expires_at
|
||||||
|
QboConnectionService.current!.oauth2_access_token_expires_at
|
||||||
|
rescue
|
||||||
|
nil
|
||||||
|
end
|
||||||
|
|
||||||
|
def self.oauth2_refresh_token_expires_at
|
||||||
|
QboConnectionService.current!.oauth2_refresh_token_expires_at
|
||||||
|
rescue
|
||||||
|
nil
|
||||||
|
end
|
||||||
|
|
||||||
# Updates last sync time stamp
|
# Updates last sync time stamp
|
||||||
def self.update_time_stamp
|
def self.update_time_stamp
|
||||||
date = DateTime.now
|
date = DateTime.now
|
||||||
logger.info "Updating QBO timestamp to #{date}"
|
log "Updating QBO timestamp to #{date}"
|
||||||
qbo = Qbo.first
|
qbo = QboConnectionService.current!
|
||||||
qbo.last_sync = date
|
qbo.last_sync = date
|
||||||
qbo.save
|
qbo.save
|
||||||
end
|
end
|
||||||
|
|
||||||
def self.last_sync
|
private
|
||||||
format_time(Qbo.first.last_sync)
|
|
||||||
|
# Logs a message with a QBO-specific prefix for easier identification in the logs.
|
||||||
|
def self.log(msg)
|
||||||
|
logger.info "[QBO] #{msg}"
|
||||||
end
|
end
|
||||||
|
|
||||||
|
# Validates that only one QBO connection record exists in the database. Adds an error if a record already exists.
|
||||||
|
def single_record_only
|
||||||
|
errors.add(:base, "Only one QBO connection allowed") if Qbo.exists?
|
||||||
|
end
|
||||||
|
|
||||||
end
|
end
|
||||||
@@ -0,0 +1,123 @@
|
|||||||
|
#The MIT License (MIT)
|
||||||
|
#
|
||||||
|
#Copyright (c) 2026 rick barrette
|
||||||
|
#
|
||||||
|
#Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
|
||||||
|
#
|
||||||
|
#The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
|
||||||
|
#
|
||||||
|
#THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
||||||
|
|
||||||
|
class QboBaseModel < ActiveRecord::Base
|
||||||
|
|
||||||
|
include Redmine::I18n
|
||||||
|
|
||||||
|
self.abstract_class = true
|
||||||
|
validates_presence_of :id
|
||||||
|
class_attribute :qbo_push_enabled, default: true
|
||||||
|
attr_accessor :skip_qbo_push
|
||||||
|
before_validation :push_to_qbo, on: :create, if: :push_to_qbo?
|
||||||
|
after_commit :push_to_qbo, on: :update, if: :push_to_qbo?
|
||||||
|
|
||||||
|
# Returns the details of the entity.
|
||||||
|
# If the details have already been fetched, it returns the cached version.
|
||||||
|
# Otherwise, it fetches the details from QuickBooks Online and caches them for future use.
|
||||||
|
# This method is used to access the entity's information in a way that minimizes unnecessary API calls to QBO, improving performance and reducing latency.
|
||||||
|
def details
|
||||||
|
@details ||= begin
|
||||||
|
xml = Rails.cache.fetch(details_cache_key, expires_in: 10.minutes) do
|
||||||
|
fetch_details.to_xml_ns
|
||||||
|
end
|
||||||
|
qbo_model_class.from_xml(xml)
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
# Generates a unique cache key for storing this customer's QBO details.
|
||||||
|
def details_cache_key
|
||||||
|
"#{model_name.name}:#{id}:qbo_details:#{updated_at.to_i}"
|
||||||
|
end
|
||||||
|
|
||||||
|
# Returns the last sync time formatted for display.
|
||||||
|
# If no sync has occurred, returns a default message.
|
||||||
|
def self.last_sync
|
||||||
|
return I18n.t(:label_qbo_never_synced) unless maximum(:updated_at)
|
||||||
|
format_time(maximum(:updated_at))
|
||||||
|
end
|
||||||
|
|
||||||
|
# Magic Method
|
||||||
|
# Maps Get/Set methods to QBO entity object
|
||||||
|
def method_missing(method_name, *args, &block)
|
||||||
|
if qbo_model_class.method_defined?(method_name)
|
||||||
|
details
|
||||||
|
@details.public_send(method_name, *args, &block)
|
||||||
|
else
|
||||||
|
super
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
def push_to_qbo?
|
||||||
|
log "qbo_push_enabled #{self.class.qbo_push_enabled}"
|
||||||
|
log "skip_qbo_push #{skip_qbo_push}"
|
||||||
|
|
||||||
|
self.class.qbo_push_enabled && skip_qbo_push != true
|
||||||
|
end
|
||||||
|
|
||||||
|
# Repsonds to missing methods by delegating to the QBO entity calss if the method is defined there.
|
||||||
|
# This allows for dynamic access to any attributes or methods of the QBO customer without having to explicitly define them in the Subclass model, providing flexibility and reducing boilerplate code.
|
||||||
|
def respond_to_missing?(method_name, include_private = false)
|
||||||
|
qbo_model_class.method_defined?(method_name) || super
|
||||||
|
end
|
||||||
|
|
||||||
|
# Sync all entities, typically triggered by a scheduled task or manual sync request
|
||||||
|
def self.sync
|
||||||
|
QboSyncStatus.queued(model_name.name)
|
||||||
|
QboSyncJob.perform_later(entity: model_name.name, full_sync: true)
|
||||||
|
end
|
||||||
|
|
||||||
|
# Sync a single entity by ID, typically triggered by a webhook notification or manual sync request
|
||||||
|
def self.sync_by_id(id)
|
||||||
|
QboSyncJob.perform_later(entity: model_name.name, id: id)
|
||||||
|
end
|
||||||
|
|
||||||
|
# Flag used to update local without pushing to QBO.
|
||||||
|
# This is used to prevent loops with the webhook
|
||||||
|
def skip_qbo_push?
|
||||||
|
!!skip_qbo_push
|
||||||
|
end
|
||||||
|
|
||||||
|
def self.qbo_sync(push: true)
|
||||||
|
self.qbo_push_enabled = push
|
||||||
|
end
|
||||||
|
|
||||||
|
private
|
||||||
|
|
||||||
|
# Log messages with a standarized prefix
|
||||||
|
def log(msg)
|
||||||
|
Rails.logger.info "[#{model_name.name}] #{msg}"
|
||||||
|
end
|
||||||
|
|
||||||
|
# Fetches the entity's details from QuickBooks Online.
|
||||||
|
def fetch_details
|
||||||
|
log "Fetching details for #{model_name.name} ##{id} from QBO..."
|
||||||
|
service_class.new(local: self).pull()
|
||||||
|
end
|
||||||
|
|
||||||
|
# Pushs the entity's details from QuickBooks Online.
|
||||||
|
def push_to_qbo
|
||||||
|
log "Starting push for #{model_name.name} ##{id}..."
|
||||||
|
reslut = service_class.new(local: self).push
|
||||||
|
Rails.cache.delete(details_cache_key)
|
||||||
|
return reslut
|
||||||
|
end
|
||||||
|
|
||||||
|
# Dynamically get the Quickbooks Model Class
|
||||||
|
def qbo_model_class
|
||||||
|
@qbo_model_class ||= "Quickbooks::Model::#{model_name.name}".constantize
|
||||||
|
end
|
||||||
|
|
||||||
|
# Dynamically get the Service Class
|
||||||
|
def service_class
|
||||||
|
@service_class ||= "#{model_name.name}Service".constantize
|
||||||
|
end
|
||||||
|
|
||||||
|
end
|
||||||
@@ -0,0 +1,74 @@
|
|||||||
|
#The MIT License (MIT)
|
||||||
|
#
|
||||||
|
#Copyright (c) 2026 rick barrette
|
||||||
|
#
|
||||||
|
#Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
|
||||||
|
#
|
||||||
|
#The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
|
||||||
|
#
|
||||||
|
#THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
||||||
|
|
||||||
|
# A new estimate or invoice saved part way, in Redmine only. Nothing is in QuickBooks until it's saved from
|
||||||
|
# the editor, so QuickBooks can't apply a deposit to an invoice that's still being written. Drafts are shared:
|
||||||
|
# anyone with Write estimates (or Write invoices) can continue or delete any estimate (or invoice) draft.
|
||||||
|
class QboDraft < ApplicationRecord
|
||||||
|
DOCUMENTS = %w[estimate invoice].freeze
|
||||||
|
|
||||||
|
belongs_to :customer, optional: true
|
||||||
|
# Who saved it last
|
||||||
|
belongs_to :user, optional: true
|
||||||
|
|
||||||
|
validates :document, inclusion: { in: DOCUMENTS }
|
||||||
|
|
||||||
|
scope :newest_first, -> { order(updated_at: :desc, id: :desc) }
|
||||||
|
scope :for_document, ->(document) { where(document: document.to_s) }
|
||||||
|
|
||||||
|
# The drafts a user may open: estimate drafts need Write estimates, invoice drafts Write invoices
|
||||||
|
scope :visible, lambda { |user = User.current|
|
||||||
|
documents = []
|
||||||
|
documents << 'estimate' if RedmineQboBilling.writer?(user)
|
||||||
|
documents << 'invoice' if RedmineQboBilling.invoice_writer?(user)
|
||||||
|
where(document: documents)
|
||||||
|
}
|
||||||
|
|
||||||
|
def self.writable_document?(document, user = User.current)
|
||||||
|
case document.to_s
|
||||||
|
when 'estimate' then RedmineQboBilling.writer?(user)
|
||||||
|
when 'invoice' then RedmineQboBilling.invoice_writer?(user)
|
||||||
|
else false
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
# The editor's fields as posted (estimate[...])
|
||||||
|
def fields
|
||||||
|
parsed = JSON.parse(data.presence || '{}')
|
||||||
|
parsed.is_a?(Hash) ? parsed : {}
|
||||||
|
rescue JSON::ParserError
|
||||||
|
{}
|
||||||
|
end
|
||||||
|
|
||||||
|
def fields=(hash)
|
||||||
|
self.data = hash.to_h.to_json
|
||||||
|
end
|
||||||
|
|
||||||
|
# The editor form, filled in as it was saved
|
||||||
|
def form
|
||||||
|
RedmineQboBilling::EstimateForm.from_params(fields, document: document)
|
||||||
|
end
|
||||||
|
|
||||||
|
def invoice?
|
||||||
|
document == 'invoice'
|
||||||
|
end
|
||||||
|
|
||||||
|
def customer_name
|
||||||
|
customer&.name.presence || fields['customer_name'].presence
|
||||||
|
end
|
||||||
|
|
||||||
|
def subtotal
|
||||||
|
form.subtotal
|
||||||
|
end
|
||||||
|
|
||||||
|
def line_count
|
||||||
|
form.filled_lines.count { |line| !line.subtotal? }
|
||||||
|
end
|
||||||
|
end
|
||||||
@@ -0,0 +1,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,54 @@
|
|||||||
|
#The MIT License (MIT)
|
||||||
|
#
|
||||||
|
#Copyright (c) 2026 rick barrette
|
||||||
|
#
|
||||||
|
#Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
|
||||||
|
#
|
||||||
|
#The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
|
||||||
|
#
|
||||||
|
#THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
||||||
|
|
||||||
|
# A customer refund (SOP-OPS-014), as it was made: the restocking fee, the refund, and each step's outcome
|
||||||
|
class QboRefund < ApplicationRecord
|
||||||
|
METHODS = %w[check card].freeze
|
||||||
|
STATUSES = %w[done incomplete].freeze
|
||||||
|
|
||||||
|
belongs_to :customer
|
||||||
|
belongs_to :user, optional: true
|
||||||
|
|
||||||
|
validates :customer_id, presence: true
|
||||||
|
validates :method, inclusion: { in: METHODS }
|
||||||
|
validates :status, inclusion: { in: STATUSES }
|
||||||
|
|
||||||
|
scope :recent, -> { order(created_at: :desc, id: :desc) }
|
||||||
|
|
||||||
|
def done?
|
||||||
|
status == 'done'
|
||||||
|
end
|
||||||
|
|
||||||
|
def check?
|
||||||
|
method == 'check'
|
||||||
|
end
|
||||||
|
|
||||||
|
def method_name
|
||||||
|
I18n.t("label_refund_method_#{method}")
|
||||||
|
end
|
||||||
|
|
||||||
|
def canceled_issue_ids
|
||||||
|
Array(JSON.parse(self[:canceled_issue_ids].presence || '[]')).map(&:to_i)
|
||||||
|
rescue JSON::ParserError
|
||||||
|
[]
|
||||||
|
end
|
||||||
|
|
||||||
|
def canceled_issue_ids=(ids)
|
||||||
|
self[:canceled_issue_ids] = Array(ids).map(&:to_i).uniq.to_json
|
||||||
|
end
|
||||||
|
|
||||||
|
# The QuickBooks screen for the refund check or expense
|
||||||
|
def purchase_url
|
||||||
|
return nil if purchase_id.blank?
|
||||||
|
|
||||||
|
page = check? ? 'check' : 'expense'
|
||||||
|
"https://#{RedmineQbo.sandbox_mode? ? 'sandbox' : 'app'}.qbo.intuit.com/app/#{page}?txnId=#{purchase_id}"
|
||||||
|
end
|
||||||
|
end
|
||||||
@@ -0,0 +1,70 @@
|
|||||||
|
#The MIT License (MIT)
|
||||||
|
#
|
||||||
|
#Copyright (c) 2026 rick barrette
|
||||||
|
#
|
||||||
|
#Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
|
||||||
|
#
|
||||||
|
#The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
|
||||||
|
#
|
||||||
|
#THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
||||||
|
|
||||||
|
|
||||||
|
# A QuickBooks sync that's queued or running, one row per entity (Invoice, Estimate...), with how many records
|
||||||
|
# it has processed so far. The row is removed when the sync finishes. Rows not touched for STALE are ignored,
|
||||||
|
# so a sync that died (e.g. Redmine restarted mid-sync) doesn't leave a notice up forever.
|
||||||
|
class QboSyncStatus < ActiveRecord::Base
|
||||||
|
STALE = 6.hours
|
||||||
|
|
||||||
|
scope :active, -> { where('updated_at > ?', STALE.ago) }
|
||||||
|
|
||||||
|
# A sync was asked for and is waiting for the job to start
|
||||||
|
def self.queued(entity)
|
||||||
|
record(entity) { |s| s.state = 'queued' unless s.state == 'running' }
|
||||||
|
end
|
||||||
|
|
||||||
|
# The sync started
|
||||||
|
def self.running(entity)
|
||||||
|
record(entity) do |s|
|
||||||
|
s.state = 'running'
|
||||||
|
s.processed = 0
|
||||||
|
s.started_at = Time.now
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
# count more records were processed
|
||||||
|
def self.progress(entity, count)
|
||||||
|
where(entity: entity.to_s).update_all(['processed = processed + ?, updated_at = ?', count.to_i, Time.now])
|
||||||
|
rescue StandardError => e
|
||||||
|
Rails.logger.warn "[QboSyncStatus] #{e.message}"
|
||||||
|
end
|
||||||
|
|
||||||
|
def self.finished(entity)
|
||||||
|
where(entity: entity.to_s).delete_all
|
||||||
|
rescue StandardError => e
|
||||||
|
Rails.logger.warn "[QboSyncStatus] #{e.message}"
|
||||||
|
end
|
||||||
|
|
||||||
|
# Active syncs by entity name: { "Invoice" => QboSyncStatus, ... }, optionally only for some entities
|
||||||
|
def self.by_entity(entities = nil)
|
||||||
|
scope = active
|
||||||
|
scope = scope.where(entity: Array(entities).map(&:to_s)) if entities
|
||||||
|
scope.index_by(&:entity)
|
||||||
|
rescue StandardError
|
||||||
|
{}
|
||||||
|
end
|
||||||
|
|
||||||
|
def self.record(entity)
|
||||||
|
status = find_or_initialize_by(entity: entity.to_s)
|
||||||
|
status.state ||= 'queued'
|
||||||
|
yield status
|
||||||
|
status.updated_at = Time.now
|
||||||
|
status.save!
|
||||||
|
rescue StandardError => e
|
||||||
|
Rails.logger.warn "[QboSyncStatus] #{e.message}"
|
||||||
|
end
|
||||||
|
private_class_method :record
|
||||||
|
|
||||||
|
def running?
|
||||||
|
state == 'running'
|
||||||
|
end
|
||||||
|
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,20 @@
|
|||||||
|
#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.
|
||||||
|
|
||||||
|
class CustomerService < ServiceBase
|
||||||
|
|
||||||
|
private
|
||||||
|
|
||||||
|
def build_qbo_remote
|
||||||
|
log "Building new QBO Customer"
|
||||||
|
Quickbooks::Model::Customer.new
|
||||||
|
end
|
||||||
|
|
||||||
|
end
|
||||||
@@ -0,0 +1,29 @@
|
|||||||
|
#The MIT License (MIT)
|
||||||
|
#
|
||||||
|
#Copyright (c) 2016 - 2026 rick barrette
|
||||||
|
#
|
||||||
|
#Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
|
||||||
|
#
|
||||||
|
#The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
|
||||||
|
#
|
||||||
|
#THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
||||||
|
|
||||||
|
class CustomerSyncService < SyncServiceBase
|
||||||
|
|
||||||
|
private
|
||||||
|
|
||||||
|
# Specify the local model this service syncs
|
||||||
|
def self.model_class
|
||||||
|
Customer
|
||||||
|
end
|
||||||
|
|
||||||
|
# Determine if the local entity should be deleted (e.g. if it's marked inactive in QBO)
|
||||||
|
def destroy_local?(remote)
|
||||||
|
!remote.active?
|
||||||
|
end
|
||||||
|
|
||||||
|
map_attribute :name, :display_name
|
||||||
|
map_phone :phone_number, :primary_phone
|
||||||
|
map_phone :mobile_phone_number, :mobile_phone
|
||||||
|
|
||||||
|
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.
|
||||||
|
|
||||||
|
class EmployeeSyncService < SyncServiceBase
|
||||||
|
|
||||||
|
private
|
||||||
|
|
||||||
|
# Specify the local model this service syncs
|
||||||
|
def self.model_class
|
||||||
|
Employee
|
||||||
|
end
|
||||||
|
|
||||||
|
# Determine if the local entity should be deleted (e.g. if it's marked inactive in QBO)
|
||||||
|
def destroy_local?(remote)
|
||||||
|
!remote.active?
|
||||||
|
end
|
||||||
|
|
||||||
|
map_attribute :name, :display_name
|
||||||
|
|
||||||
|
end
|
||||||
@@ -0,0 +1,13 @@
|
|||||||
|
#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.
|
||||||
|
|
||||||
|
class EstimateService < ServiceBase
|
||||||
|
|
||||||
|
end
|
||||||
@@ -0,0 +1,37 @@
|
|||||||
|
#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.
|
||||||
|
|
||||||
|
class EstimateSyncService < SyncServiceBase
|
||||||
|
|
||||||
|
# sync only one estimate
|
||||||
|
def sync_by_doc_number(number)
|
||||||
|
log "Syncing estimate by doc number #{number}"
|
||||||
|
QboConnectionService.with_qbo_service(entity: @entity) do |service|
|
||||||
|
persist(service.find_by( :doc_number, number).first)
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
private
|
||||||
|
|
||||||
|
# Specify the local model this service syncs
|
||||||
|
def self.model_class
|
||||||
|
Estimate
|
||||||
|
end
|
||||||
|
|
||||||
|
map_attributes :doc_number, :txn_date
|
||||||
|
map_attribute :total_amount, :total
|
||||||
|
map_attribute :txn_status
|
||||||
|
# Man-hours: quantities of the labor products/services (plugin settings)
|
||||||
|
map_attribute(:hours) { |remote| RedmineQboBilling::ManHours.hours(remote) }
|
||||||
|
# Sales tax, so the business report can compare estimates and invoices without it
|
||||||
|
map_attribute(:tax_amount) { |remote| RedmineQboBilling::InvoicePaidOn.tax(remote) }
|
||||||
|
map_belongs_to :customer
|
||||||
|
|
||||||
|
end
|
||||||
@@ -0,0 +1,73 @@
|
|||||||
|
#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.
|
||||||
|
|
||||||
|
class InvoiceAttachmentService
|
||||||
|
|
||||||
|
def initialize(invoice, remote)
|
||||||
|
@invoice = invoice
|
||||||
|
@remote = remote
|
||||||
|
end
|
||||||
|
|
||||||
|
# Attach invoice to issues based on issue IDs found in the invoice's private note and line descriptions
|
||||||
|
def attach
|
||||||
|
extract_issue_ids.each do |issue_id|
|
||||||
|
log "Processing issue ##{issue_id} for invoice ##{@invoice.doc_number}"
|
||||||
|
|
||||||
|
issue = Issue.find_by(id: issue_id)
|
||||||
|
next unless issue
|
||||||
|
next unless issue.customer&.id == @invoice.customer&.id
|
||||||
|
|
||||||
|
unless issue.invoices.exists?(@invoice.id)
|
||||||
|
issue.invoices << @invoice
|
||||||
|
issue.save! if issue.changed?
|
||||||
|
journalize(issue)
|
||||||
|
log "Attached invoice ##{@invoice.id} to issue ##{issue.id}"
|
||||||
|
end
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
private
|
||||||
|
|
||||||
|
# Records the new invoice in the issue's history (shown by RedmineQbo::Patches::IssuesHelperPatch).
|
||||||
|
# The webhook has no Redmine user, so the entry is by Anonymous. Saving the journal also sends
|
||||||
|
# Redmine's usual issue-updated emails.
|
||||||
|
def journalize(issue)
|
||||||
|
journal = Journal.new(journalized: issue, user: User.anonymous, notes: '')
|
||||||
|
journal.details << JournalDetail.new(property: 'invoice', prop_key: @invoice.id.to_s, value: @invoice.to_s.presence || @invoice.id.to_s)
|
||||||
|
journal.save
|
||||||
|
rescue => e
|
||||||
|
# The invoice is attached either way; a missing history entry shouldn't fail the sync
|
||||||
|
log "Couldn't add invoice ##{@invoice.id} to the history of issue ##{issue.id}: #{e.message}"
|
||||||
|
end
|
||||||
|
|
||||||
|
# Extract issue IDs from the invoice's private note and line descriptions
|
||||||
|
def extract_issue_ids
|
||||||
|
ids = []
|
||||||
|
|
||||||
|
if @remote.private_note.present?
|
||||||
|
ids += scan(@remote.private_note)
|
||||||
|
end
|
||||||
|
|
||||||
|
Array(@remote.line_items).each do |line|
|
||||||
|
ids += scan(line.description.to_s)
|
||||||
|
end
|
||||||
|
|
||||||
|
ids.uniq
|
||||||
|
end
|
||||||
|
|
||||||
|
# Scan text for issue IDs in the format #123
|
||||||
|
def scan(text)
|
||||||
|
text.scan(/#(\d+)/).flatten.map(&:to_i)
|
||||||
|
end
|
||||||
|
|
||||||
|
def log(msg)
|
||||||
|
Rails.logger.info "[InvoiceAttachmentService] #{msg}"
|
||||||
|
end
|
||||||
|
end
|
||||||
@@ -0,0 +1,35 @@
|
|||||||
|
#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.
|
||||||
|
|
||||||
|
class InvoiceSyncService < SyncServiceBase
|
||||||
|
|
||||||
|
private
|
||||||
|
|
||||||
|
# Specify the local model this service syncs
|
||||||
|
def self.model_class
|
||||||
|
Invoice
|
||||||
|
end
|
||||||
|
|
||||||
|
# Attach QBO Invoices to the local Issues
|
||||||
|
def attach_documents(local, remote)
|
||||||
|
InvoiceAttachmentService.new(local, remote).attach
|
||||||
|
end
|
||||||
|
|
||||||
|
map_attributes :balance, :doc_number, :due_date, :txn_date
|
||||||
|
map_attribute :total_amount, :total
|
||||||
|
# Man-hours: quantities of the labor products/services (plugin settings)
|
||||||
|
map_attribute(:hours) { |remote| RedmineQboBilling::ManHours.hours(remote) }
|
||||||
|
map_attribute :qbo_updated_at, "meta_data.last_updated_time"
|
||||||
|
# Sales tax, and the day it was paid in full (nil while open), for reports such as monthly paid sales
|
||||||
|
map_attribute(:tax_amount) { |remote| RedmineQboBilling::InvoicePaidOn.tax(remote) }
|
||||||
|
map_attribute(:paid_on) { |remote| RedmineQboBilling::InvoicePaidOn.paid_on(remote) }
|
||||||
|
map_belongs_to :customer
|
||||||
|
|
||||||
|
end
|
||||||
@@ -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,39 @@
|
|||||||
|
#The MIT License (MIT)
|
||||||
|
#
|
||||||
|
#Copyright (c) 2026 rick barrette
|
||||||
|
#
|
||||||
|
#Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
|
||||||
|
#
|
||||||
|
#The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
|
||||||
|
#
|
||||||
|
#THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
||||||
|
|
||||||
|
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 :id, :name, :sku, :type
|
||||||
|
# Services such as Labor often have no description or rate in QuickBooks; they sync as blank and 0
|
||||||
|
# instead of failing validation and being skipped
|
||||||
|
map_attribute(:description) { |remote| remote.description.to_s }
|
||||||
|
map_attribute(:unit_price) { |remote| remote.unit_price || 0 }
|
||||||
|
|
||||||
|
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.
|
||||||
|
|
||||||
|
|
||||||
|
# Reads a payment's details from QuickBooks for the Payment model (payments are only cached here, never pushed)
|
||||||
|
class PaymentService < ServiceBase
|
||||||
|
|
||||||
|
private
|
||||||
|
|
||||||
|
def build_qbo_remote
|
||||||
|
Quickbooks::Model::Payment.new
|
||||||
|
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.
|
||||||
|
|
||||||
|
|
||||||
|
# Caches QuickBooks payments: customer, date, amount and what's still unapplied
|
||||||
|
class PaymentSyncService < SyncServiceBase
|
||||||
|
|
||||||
|
private
|
||||||
|
|
||||||
|
# Specify the local model this service syncs
|
||||||
|
def self.model_class
|
||||||
|
Payment
|
||||||
|
end
|
||||||
|
|
||||||
|
map_attributes :txn_date
|
||||||
|
map_attribute :total_amount, :total
|
||||||
|
map_attribute :unapplied_amount
|
||||||
|
map_attribute :qbo_updated_at, "meta_data.last_updated_time"
|
||||||
|
# A payment whose customer hasn't synced yet keeps none until the next sync
|
||||||
|
map_attribute :customer do |remote|
|
||||||
|
id = remote.customer_ref&.value
|
||||||
|
id.present? ? Customer.find_by(id: id) : nil
|
||||||
|
end
|
||||||
|
|
||||||
|
end
|
||||||
@@ -0,0 +1,57 @@
|
|||||||
|
#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.
|
||||||
|
class PdfService
|
||||||
|
|
||||||
|
require 'combine_pdf'
|
||||||
|
|
||||||
|
# Subclasses should initialize with a QBO client instance
|
||||||
|
def initialize(entity:)
|
||||||
|
raise "An entity to sync is required" unless entity
|
||||||
|
@entity = entity
|
||||||
|
end
|
||||||
|
|
||||||
|
# Fetches the PDF for the given entity IDs. If multiple IDs are provided, their PDFs are combined into a single document.
|
||||||
|
def fetch_pdf(doc_ids:)
|
||||||
|
log "Fetching PDFs for #{@entity} IDs: #{doc_ids.join(', ')}"
|
||||||
|
QboConnectionService.with_qbo_service(entity: @entity) do |service|
|
||||||
|
return single_pdf(service, doc_ids.first) if doc_ids.size == 1
|
||||||
|
combined_pdf(service, doc_ids)
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
private
|
||||||
|
|
||||||
|
# Fetches a single PDF for the given invoice ID.
|
||||||
|
def single_pdf(service, id)
|
||||||
|
log "Fetching PDF for #{@entity} ID: #{id}"
|
||||||
|
entity = service.fetch_by_id(id)
|
||||||
|
[service.pdf(entity), entity.doc_number]
|
||||||
|
end
|
||||||
|
|
||||||
|
# Combines PDFs for multiple entity IDs into a single PDF document and returns it along with a reference string.
|
||||||
|
def combined_pdf(service, ids)
|
||||||
|
log "Combining PDFs for #{@entity} IDs: #{ids.join(', ')}"
|
||||||
|
pdf = CombinePDF.new
|
||||||
|
ref = []
|
||||||
|
|
||||||
|
ids.each do |id|
|
||||||
|
entity = service.fetch_by_id(id)
|
||||||
|
ref << entity.doc_number
|
||||||
|
pdf << CombinePDF.parse(service.pdf(entity))
|
||||||
|
end
|
||||||
|
|
||||||
|
[pdf.to_pdf, ref.join(" ")]
|
||||||
|
end
|
||||||
|
|
||||||
|
# Logs messages with a consistent prefix for easier debugging.
|
||||||
|
def log(msg)
|
||||||
|
Rails.logger.info "[#{@entity}PdfService] #{msg}"
|
||||||
|
end
|
||||||
|
end
|
||||||
@@ -0,0 +1,42 @@
|
|||||||
|
#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.
|
||||||
|
|
||||||
|
class QboConnectionService
|
||||||
|
|
||||||
|
# Returns the current QBO connection record. Raises an error if no connection exists.
|
||||||
|
def self.current!
|
||||||
|
Qbo.first || raise("QBO not connected")
|
||||||
|
end
|
||||||
|
|
||||||
|
# Replaces the existing QBO connection with new credentials. Deletes all existing records and creates a new one with the provided token, refresh token, and realm ID. Refreshes the token immediately after creation.
|
||||||
|
def self.replace!(token:, refresh_token:, realm_id:)
|
||||||
|
Qbo.transaction do
|
||||||
|
Qbo.destroy_all
|
||||||
|
qbo = Qbo.create!(
|
||||||
|
oauth2_access_token: token,
|
||||||
|
oauth2_refresh_token: refresh_token,
|
||||||
|
realm_id: realm_id
|
||||||
|
)
|
||||||
|
qbo.refresh_token!
|
||||||
|
qbo
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
# Performs authenticaed requests with QBO service
|
||||||
|
def self.with_qbo_service(entity: nil)
|
||||||
|
qbo = current!
|
||||||
|
raise "An entity to sync is required" unless entity
|
||||||
|
service_class ||= "Quickbooks::Service::#{entity}".constantize
|
||||||
|
qbo.perform_authenticated_request do |access_token|
|
||||||
|
service = service_class.new( company_id: qbo.realm_id, access_token: access_token )
|
||||||
|
yield service
|
||||||
|
end
|
||||||
|
end
|
||||||
|
end
|
||||||
@@ -0,0 +1,36 @@
|
|||||||
|
#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.
|
||||||
|
|
||||||
|
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.
|
||||||
|
# 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: state,
|
||||||
|
scope: "com.intuit.quickbooks.accounting"
|
||||||
|
)
|
||||||
|
end
|
||||||
|
|
||||||
|
# Exchanges the authorization code for access and refresh tokens.
|
||||||
|
# Creates or replaces the QBO connection record with the new credentials and refreshes the token immediately after creation.
|
||||||
|
def self.exchange!(code:, callback_url:, realm_id:)
|
||||||
|
resp = client.auth_code.get_token(code, redirect_uri: callback_url)
|
||||||
|
QboConnectionService.replace!( token: resp.token, refresh_token: resp.refresh_token, realm_id: realm_id )
|
||||||
|
end
|
||||||
|
|
||||||
|
# Constructs and returns an OAuth2 client instance configured with the application's credentials and settings.
|
||||||
|
def self.client
|
||||||
|
Qbo.construct_oauth2_client
|
||||||
|
end
|
||||||
|
end
|
||||||
@@ -0,0 +1,67 @@
|
|||||||
|
#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 ServiceBase
|
||||||
|
|
||||||
|
# Subclasses should Initializes the service with a QBO client and a local record.
|
||||||
|
# The QBO client is used to communicate with QuickBooks Online, while the local record contains the data that needs to be pushed to QBO.
|
||||||
|
# If no local is provided, the service will not perform any operations.
|
||||||
|
def initialize(local: nil)
|
||||||
|
@entity = local.class.name
|
||||||
|
raise "#{@entity} record is required for push operation" unless local
|
||||||
|
@local = local
|
||||||
|
end
|
||||||
|
|
||||||
|
# Subclasses must implement this to build a new QBO entity if a remote is not found
|
||||||
|
def build_qbo_remote
|
||||||
|
raise NotImplementedError
|
||||||
|
end
|
||||||
|
|
||||||
|
# Pulls the Item data from QuickBooks Online.
|
||||||
|
def pull
|
||||||
|
return build_qbo_remote unless @local.present?
|
||||||
|
return build_qbo_remote unless @local.id
|
||||||
|
log "Fetching details for #{@entity} ##{@local.id} from QBO..."
|
||||||
|
QboConnectionService.with_qbo_service(entity: @entity) do |service|
|
||||||
|
service.fetch_by_id(@local.id)
|
||||||
|
end
|
||||||
|
rescue => e
|
||||||
|
log "Fetch failed for #{@local.id}: #{e.message}"
|
||||||
|
build_qbo_remote
|
||||||
|
end
|
||||||
|
|
||||||
|
# Pushes the Item data to QuickBooks Online.
|
||||||
|
# This method handles the communication with QBO, including authentication and error handling.
|
||||||
|
# It uses the QBO client to send the remote data and logs the process for monitoring and debugging purposes.
|
||||||
|
# If the push is successful, it returns the remote record; otherwise, it logs the error and returns false.
|
||||||
|
def push
|
||||||
|
log "Pushing #{@entity} ##{@local.id} to QBO..."
|
||||||
|
remote = QboConnectionService.with_qbo_service(entity: @entity) do |service|
|
||||||
|
if @local.id.present?
|
||||||
|
log "Updating #{@entity}"
|
||||||
|
service.update(@local.details)
|
||||||
|
else
|
||||||
|
log "Creating #{@entity}"
|
||||||
|
service.create(@local.details)
|
||||||
|
end
|
||||||
|
end
|
||||||
|
@local.id = remote.id unless @local.persisted?
|
||||||
|
log "Push for remote ##{@local.id} completed."
|
||||||
|
@local
|
||||||
|
end
|
||||||
|
|
||||||
|
private
|
||||||
|
|
||||||
|
# Log messages with the entity type for better traceability
|
||||||
|
def log(msg)
|
||||||
|
Rails.logger.info "[#{@entity}Service] #{msg}"
|
||||||
|
end
|
||||||
|
|
||||||
|
end
|
||||||
@@ -0,0 +1,250 @@
|
|||||||
|
#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.
|
||||||
|
|
||||||
|
class SyncServiceBase
|
||||||
|
PAGE_SIZE = 1000
|
||||||
|
|
||||||
|
# Subclasses should initialize with a QBO client instance
|
||||||
|
def initialize()
|
||||||
|
@entity = self.class.model_class
|
||||||
|
@page_size = self.class.page_size
|
||||||
|
end
|
||||||
|
|
||||||
|
# Subclasses can implement this to overide the default page size
|
||||||
|
def self.page_size
|
||||||
|
@page_size = PAGE_SIZE
|
||||||
|
end
|
||||||
|
|
||||||
|
# Subclasses must implement this to specify which local model they sync (e.g. Customer, Invoice)
|
||||||
|
def self.model_class
|
||||||
|
raise NotImplementedError
|
||||||
|
end
|
||||||
|
|
||||||
|
# Sync all entities, or only those updated since the last sync
|
||||||
|
def sync(full_sync: false)
|
||||||
|
log "Starting #{full_sync ? 'full' : 'incremental'} #{@entity.name} sync with page size of: #{@page_size}"
|
||||||
|
QboConnectionService.with_qbo_service(entity: @entity) do |service|
|
||||||
|
query = build_query(full_sync)
|
||||||
|
service.query_in_batches(query, per_page: @page_size) do |batch|
|
||||||
|
entries = Array(batch)
|
||||||
|
log "Processing batch of #{entries.size} #{@entity.name}"
|
||||||
|
entries.each do |remote|
|
||||||
|
persist(remote)
|
||||||
|
end
|
||||||
|
QboSyncStatus.progress(@entity.name, entries.size)
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
log "#{@entity.name} sync complete"
|
||||||
|
end
|
||||||
|
|
||||||
|
# Sync a single entity by its QBO ID (webhook usage)
|
||||||
|
def sync_by_id(id)
|
||||||
|
log "Syncing #{@entity.name} with ID #{id}"
|
||||||
|
QboConnectionService.with_qbo_service(entity: @entity) do |service|
|
||||||
|
remote = service.fetch_by_id(id)
|
||||||
|
persist(remote)
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
private
|
||||||
|
|
||||||
|
def attach_documents(local, remote)
|
||||||
|
# Override in subclasses if the entity has attachments (e.g. Invoice)
|
||||||
|
end
|
||||||
|
|
||||||
|
# Builds a QBO query for retrieving entities
|
||||||
|
def build_query(full_sync)
|
||||||
|
if full_sync
|
||||||
|
"SELECT * FROM #{@entity.name} ORDER BY Id"
|
||||||
|
else
|
||||||
|
last_update = @entity.maximum(:updated_at) || 1.year.ago
|
||||||
|
|
||||||
|
<<~SQL.squish
|
||||||
|
SELECT * FROM #{@entity.name}
|
||||||
|
WHERE MetaData.LastUpdatedTime > '#{last_update.utc.iso8601}'
|
||||||
|
ORDER BY MetaData.LastUpdatedTime
|
||||||
|
SQL
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
# Determine if a remote entity should be deleted locally (e.g. if it's marked inactive in QBO)
|
||||||
|
def destroy_local?(remote)
|
||||||
|
false
|
||||||
|
end
|
||||||
|
|
||||||
|
def extract_value(remote, remote_attr)
|
||||||
|
case remote_attr
|
||||||
|
when Proc
|
||||||
|
remote_attr.call(remote)
|
||||||
|
else
|
||||||
|
remote.public_send(remote_attr)
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
# Attribute Mapping DSL
|
||||||
|
#
|
||||||
|
# This DSL defines how attributes from a QuickBooks Online (QBO) entity
|
||||||
|
# are mapped onto a local ActiveRecord model during synchronization.
|
||||||
|
#
|
||||||
|
# Each mapping registers a lambda in `attribute_map`. When a remote QBO
|
||||||
|
# object is processed, the lambda is executed to extract and transform
|
||||||
|
# the value that will be assigned to the local model attribute.
|
||||||
|
#
|
||||||
|
# The DSL supports several mapping patterns:
|
||||||
|
#
|
||||||
|
# 1. Direct attribute mapping (same name)
|
||||||
|
#
|
||||||
|
# map_attribute :doc_number
|
||||||
|
#
|
||||||
|
# Equivalent to:
|
||||||
|
#
|
||||||
|
# local.doc_number = remote.doc_number
|
||||||
|
#
|
||||||
|
# 2. Renamed attribute mapping
|
||||||
|
#
|
||||||
|
# map_attribute :total_amount, :total
|
||||||
|
#
|
||||||
|
# Equivalent to:
|
||||||
|
#
|
||||||
|
# local.total_amount = remote.total
|
||||||
|
#
|
||||||
|
# 3. Custom transformation logic
|
||||||
|
#
|
||||||
|
# map_attribute :qbo_updated_at do |remote|
|
||||||
|
# remote.meta_data&.last_updated_time
|
||||||
|
# end
|
||||||
|
#
|
||||||
|
# Useful for nested fields or computed values.
|
||||||
|
#
|
||||||
|
# 4. Bulk attribute mapping
|
||||||
|
#
|
||||||
|
# map_attributes :doc_number, :txn_date, :due_date
|
||||||
|
#
|
||||||
|
# Convenience helper that maps multiple attributes with identical names.
|
||||||
|
#
|
||||||
|
# 5. Foreign key / reference mapping
|
||||||
|
#
|
||||||
|
# map_belongs_to :customer
|
||||||
|
#
|
||||||
|
# Resolves a QBO reference object (e.g. `customer_ref.value`) and finds
|
||||||
|
# the associated local ActiveRecord model.
|
||||||
|
#
|
||||||
|
# 6. Specialized helpers
|
||||||
|
#
|
||||||
|
# map_phone :phone_number, :primary_phone
|
||||||
|
#
|
||||||
|
# Extracts and normalizes phone numbers by stripping non-digit characters.
|
||||||
|
#
|
||||||
|
# Internally, the mappings are stored in `attribute_map` and executed by the
|
||||||
|
# SyncService during `process_attributes`, which iterates through each mapping
|
||||||
|
# and assigns the computed value to the local record.
|
||||||
|
#
|
||||||
|
# This design keeps synchronization services declarative, readable, and easy
|
||||||
|
# to extend while centralizing transformation logic in a single DSL.
|
||||||
|
class << self
|
||||||
|
|
||||||
|
def map_attributes(*attrs)
|
||||||
|
attrs.each do |attr|
|
||||||
|
map_attribute(attr)
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
|
||||||
|
def map_attribute(local_attr, remote_attr = nil, &block)
|
||||||
|
attribute_map[local_attr] =
|
||||||
|
if block_given?
|
||||||
|
block
|
||||||
|
elsif remote_attr
|
||||||
|
->(remote) do
|
||||||
|
remote_attr.to_s.split('.').reduce(remote) do |obj, method|
|
||||||
|
obj&.public_send(method)
|
||||||
|
end
|
||||||
|
end
|
||||||
|
else
|
||||||
|
->(remote) { remote.public_send(local_attr) }
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
def attribute_map
|
||||||
|
@attribute_map ||= {}
|
||||||
|
end
|
||||||
|
|
||||||
|
def map_belongs_to(local_attr, ref: nil, model: nil)
|
||||||
|
ref ||= "#{local_attr}_ref"
|
||||||
|
model ||= local_attr.to_s.classify.constantize
|
||||||
|
|
||||||
|
attribute_map[local_attr] = lambda do |remote|
|
||||||
|
ref_obj = remote.public_send(ref)
|
||||||
|
id = ref_obj&.value
|
||||||
|
id ? model.find_by(id: id) : nil
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
def map_phone(local_attr, remote_attr)
|
||||||
|
attribute_map[local_attr] = lambda do |remote|
|
||||||
|
phone = remote.public_send(remote_attr)
|
||||||
|
phone&.free_form_number&.gsub(/\D/, '')
|
||||||
|
end
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
# Log messages with the entity type for better traceability
|
||||||
|
def log(msg)
|
||||||
|
Rails.logger.info "[#{@entity.name}SyncService] #{msg}"
|
||||||
|
end
|
||||||
|
|
||||||
|
# Create or update a local entity record based on the QBO remote data. If another sync inserts the same
|
||||||
|
# record at the same moment (e.g. a save in Redmine and QuickBooks' webhook), the database's unique id
|
||||||
|
# refuses the second insert; it's then retried once as an update of the row the other sync created.
|
||||||
|
def persist(remote, retried: false)
|
||||||
|
local = @entity.find_or_initialize_by(id: remote.id)
|
||||||
|
|
||||||
|
if destroy_local?(remote)
|
||||||
|
if local.persisted?
|
||||||
|
local.destroy
|
||||||
|
log "Deleted #{@entity.name} #{remote.id}"
|
||||||
|
end
|
||||||
|
return
|
||||||
|
end
|
||||||
|
|
||||||
|
process_attributes(local, remote)
|
||||||
|
|
||||||
|
if local.new_record? || local.changed?
|
||||||
|
was_new = local.new_record?
|
||||||
|
local.skip_qbo_push = true
|
||||||
|
local.save!
|
||||||
|
log "#{was_new ? 'Created' : 'Updated'} #{@entity.name} #{remote.id}"
|
||||||
|
attach_documents(local, remote)
|
||||||
|
end
|
||||||
|
|
||||||
|
rescue ActiveRecord::RecordNotUnique, ActiveRecord::RecordInvalid => e
|
||||||
|
if !retried && (e.is_a?(ActiveRecord::RecordNotUnique) || @entity.exists?(id: remote.id))
|
||||||
|
log "#{@entity.name} #{remote.id} was saved by another sync meanwhile; updating it instead"
|
||||||
|
return persist(remote, retried: true)
|
||||||
|
end
|
||||||
|
log "Failed to sync #{@entity.name} #{remote.id}: #{e.message}"
|
||||||
|
rescue => e
|
||||||
|
log "Failed to sync #{@entity.name} #{remote.id}: #{e.message}"
|
||||||
|
end
|
||||||
|
|
||||||
|
# Maps remote attributes to local model
|
||||||
|
def process_attributes(local, remote)
|
||||||
|
log "Processing #{@entity} ##{remote.id}"
|
||||||
|
|
||||||
|
self.class.attribute_map.each do |local_attr, mapper|
|
||||||
|
value = mapper.call(remote)
|
||||||
|
|
||||||
|
if local.public_send(local_attr) != value
|
||||||
|
local.public_send("#{local_attr}=", value)
|
||||||
|
end
|
||||||
|
end
|
||||||
|
end
|
||||||
|
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,11 +0,0 @@
|
|||||||
<%= link_to t(:label_appointment), "https://calendar.google.com/calendar/render?action=TEMPLATE&text=#{@customer.name}+-&details=#{ link_to t(:customer_details), "https://#{Setting.host_name}#{customer_path @customer.id}"}%0A#{@customer.primary_phone}%3Cbr/%3E+&dates=#{Time.now.strftime("%Y%m%d")}T090000/#{Time.now.strftime("%Y%m%d")}T170000", target: :_blank, id: :appointment_link %>
|
|
||||||
|
|
||||||
<br/>
|
|
||||||
<br/>
|
|
||||||
|
|
||||||
<%= link_to t(:label_create_estimate), "https://qbo.intuit.com/app/estimate?nameId=#{@customer.id}", target: :_blank %>
|
|
||||||
|
|
||||||
<br/>
|
|
||||||
<br/>
|
|
||||||
|
|
||||||
<%= button_to t(:label_edit_customer), edit_customer_path(@customer), method: :get%>
|
|
||||||
@@ -2,57 +2,53 @@
|
|||||||
<tbody>
|
<tbody>
|
||||||
|
|
||||||
<tr>
|
<tr>
|
||||||
<th><%=t(:label_name)%></th>
|
<th><%= t(:label_name) %></th>
|
||||||
<td><%= customer.name %></td>
|
<td><%= customer.name %></td>
|
||||||
</tr>
|
</tr>
|
||||||
|
|
||||||
<tr>
|
<tr>
|
||||||
<th><%=t(:label_email)%></th>
|
<th><%= t(:label_email) %></th>
|
||||||
<td><%= customer.email %></td>
|
<td><%= customer.email %></td>
|
||||||
</tr>
|
</tr>
|
||||||
|
|
||||||
<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) if customer.primary_phone %></td>
|
<td><%= number_to_phone(customer&.primary_phone&.gsub(/[^\d]/, '').to_i, area_code: true) %></td>
|
||||||
</tr>
|
</tr>
|
||||||
|
|
||||||
<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) if customer.mobile_phone %></td>
|
<td><%= number_to_phone(customer&.mobile_phone&.gsub(/[^\d]/, '').to_i, area_code: true) %></td>
|
||||||
</tr>
|
|
||||||
|
|
||||||
<tr>
|
|
||||||
<th><%=t(:label_billing_address)%></th>
|
|
||||||
<td><%= @billing_address %></td>
|
|
||||||
</tr>
|
|
||||||
|
|
||||||
<tr>
|
|
||||||
<th><%=t(:label_shipping_address)%></th>
|
|
||||||
<td><%= @shipping_address %></td>
|
|
||||||
</tr>
|
</tr>
|
||||||
|
|
||||||
<tr>
|
<tr>
|
||||||
<th><%=t(:label_account_balance)%></th>
|
<th><%= t(:label_billing_address) %></th>
|
||||||
<td>$<%= customer.balance %></td>
|
<td><pre><%= @billing_address %></pre></td>
|
||||||
</tr>
|
</tr>
|
||||||
|
|
||||||
<tr>
|
<tr>
|
||||||
<th colspan="2"><h4><%=t(:field_notes)%></hr></th>
|
<th><%= t(:label_shipping_address) %></th>
|
||||||
|
<td><pre><%= @shipping_address %></pre></td>
|
||||||
</tr>
|
</tr>
|
||||||
|
|
||||||
<tr>
|
<tr>
|
||||||
<td colspan="2">
|
<th><%= t(:label_account_balance) %></th>
|
||||||
<pre id="note-display" style="text-align: left; white-space: pre-wrap; font-family: inherit;">
|
<td>$<%= customer.balance %></td>
|
||||||
<%= customer.notes %>
|
|
||||||
</pre>
|
|
||||||
</td>
|
|
||||||
</tr>
|
</tr>
|
||||||
|
|
||||||
<script>
|
<% if customer.notes.present? %>
|
||||||
const preElement = document.getElementById('note-display');
|
<tr>
|
||||||
// This takes the text, trims the edges, and puts it back
|
<th colspan="2"><h4><%= t(:field_notes) %></h4></th>
|
||||||
preElement.textContent = preElement.textContent.trim();
|
</tr>
|
||||||
</script>
|
|
||||||
|
<tr>
|
||||||
|
<td colspan="2">
|
||||||
|
<div class="wiki">
|
||||||
|
<%= textilizable(customer, :notes) %>
|
||||||
|
</div>
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
<% end %>
|
||||||
|
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
|
|||||||
@@ -1,59 +1,30 @@
|
|||||||
<div class="row">
|
<%#
|
||||||
<div class="span6 columns">
|
Customer form, in Redmine's form style. Also loaded by redmine_qbo_calendar's quick-create popup
|
||||||
<fieldset>
|
(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="box tabular">
|
||||||
|
<p>
|
||||||
<div class="clearfix">
|
<%= f.text_field :name, label: :label_display_name, required: true, size: 60,
|
||||||
<%=t(:label_display_name)%>
|
class: 'customer-name', autocomplete: 'off',
|
||||||
<div class="input">
|
data: { autocomplete_url: '/customers/autocomplete' } %>
|
||||||
<%= f.text_field :name, required: true, autocomplete: "off" %>
|
</p>
|
||||||
</div>
|
<p><%= f.telephone_field :primary_phone, label: :label_primary_phone, size: 20, autocomplete: 'off' %></p>
|
||||||
</div>
|
<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>
|
||||||
<div class="clearfix">
|
<p>
|
||||||
<%=t(:label_primary_phone)%>
|
<%= f.text_area :notes, label: :field_notes, rows: 8, class: 'wiki-edit', id: 'customer_notes' %>
|
||||||
<div class="input">
|
<% unless local_assigns[:hide_toolbar] %>
|
||||||
<%= f.telephone_field :primary_phone, autocomplete: "off" %>
|
<%= wikitoolbar_for 'customer_notes' %>
|
||||||
</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>
|
|
||||||
<% end %>
|
<% end %>
|
||||||
|
</p>
|
||||||
</fieldset>
|
|
||||||
</div>
|
</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,45 @@
|
|||||||
|
<%#
|
||||||
|
Adds what's ticked on the customer page to the "New issue" link (#dynamic-new-issue-link in the contextual
|
||||||
|
area). Any checkbox with data-new-issue-param="issue[field]" takes part, one ticked per field: this plugin's
|
||||||
|
estimates (issue[estimate_id]), and other plugins' lists (e.g. redmine_qbo_vehicles' issue[vehicle_id]).
|
||||||
|
%>
|
||||||
|
<script>
|
||||||
|
function newIssueParamBoxes(param) {
|
||||||
|
return Array.prototype.filter.call(document.querySelectorAll('input[data-new-issue-param]'), function (cb) {
|
||||||
|
return !param || cb.getAttribute('data-new-issue-param') === param;
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
// One box per field: ticking one unticks the others for the same field
|
||||||
|
document.addEventListener('change', function (event) {
|
||||||
|
var box = event.target;
|
||||||
|
if (!box.matches || !box.matches('input[data-new-issue-param]')) return;
|
||||||
|
if (box.checked) {
|
||||||
|
newIssueParamBoxes(box.getAttribute('data-new-issue-param')).forEach(function (cb) {
|
||||||
|
if (cb !== box) cb.checked = false;
|
||||||
|
});
|
||||||
|
}
|
||||||
|
updateLink();
|
||||||
|
});
|
||||||
|
|
||||||
|
function updateLink() {
|
||||||
|
var link = document.getElementById('dynamic-new-issue-link');
|
||||||
|
if (!link) return;
|
||||||
|
|
||||||
|
// Cache the pristine base URL on first run
|
||||||
|
if (!link.dataset.baseUrl) link.dataset.baseUrl = link.getAttribute('href');
|
||||||
|
var url = new URL(link.dataset.baseUrl, window.location.origin);
|
||||||
|
|
||||||
|
newIssueParamBoxes().forEach(function (cb) {
|
||||||
|
var param = cb.getAttribute('data-new-issue-param');
|
||||||
|
var ticked = newIssueParamBoxes(param).filter(function (b) { return b.checked; })[0];
|
||||||
|
if (ticked) {
|
||||||
|
url.searchParams.set(param, ticked.value);
|
||||||
|
} else {
|
||||||
|
url.searchParams.delete(param);
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
link.setAttribute('href', url.toString());
|
||||||
|
}
|
||||||
|
</script>
|
||||||
@@ -1,5 +1,8 @@
|
|||||||
<%= form_tag(customers_path, method: "get", id: "search-form") do %>
|
<%= form_tag(customers_path, method: "get", id: "customer-search-form") do %>
|
||||||
<%= text_field_tag :search, params[:search], placeholder: t(:label_search_customers), autocomplete: "off" %>
|
<%= 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) %>
|
<%= submit_tag t(:label_search) %>
|
||||||
<% end %>
|
<% 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>
|
<h2><%= link_to l(:label_customers), customers_path %> » <%= link_to @customer.to_s, customer_path(@customer) %></h2>
|
||||||
<br/>
|
|
||||||
<%= render partial: 'customers/form' %>
|
<%= render partial: 'customers/form' %>
|
||||||
|
|
||||||
|
<% html_title(l(:label_edit_customer)) -%>
|
||||||
@@ -1,24 +1,71 @@
|
|||||||
<h2><%=t(:field_customers)%> <span style="float:right"> <%= render partial: 'customers/search' %> </span> </h2>
|
<% html_title l(:label_customers) %>
|
||||||
<% if @customers.present? %>
|
<% phone = ->(digits) { digits.present? ? number_to_phone(digits.gsub(/\D/, '').to_i, area_code: true) : '' } %>
|
||||||
<br/>
|
|
||||||
<% @customers.each do |c| %>
|
<div class="contextual">
|
||||||
<div class="row">
|
<% if User.current.allowed_to?(:add_customers, nil, global: true) %>
|
||||||
<div class="span6 columns">
|
<%= link_to sprite_icon('add', l(:label_new_customer)), new_customer_path, class: 'icon icon-add' %>
|
||||||
<%= link_to c, customer_path(c.id) %>
|
<% end %>
|
||||||
</div>
|
<%# Estimate and invoice drafts, for users who may write either %>
|
||||||
</div>
|
<% if RedmineQboBilling.writer? || RedmineQboBilling.invoice_writer? %>
|
||||||
|
<% draft_count = QboDraft.visible.count %>
|
||||||
|
<%= link_to sprite_icon('document', "#{l(:label_qbo_drafts)} (#{draft_count})"), qbo_drafts_path, class: 'icon icon-document' %>
|
||||||
|
<% end %>
|
||||||
|
<% if User.current.admin? %>
|
||||||
|
<%= link_to sprite_icon('reload', l(:label_sync)), qbo_sync_path, class: 'icon icon-reload' %>
|
||||||
<% end %>
|
<% end %>
|
||||||
|
|
||||||
<p><%=t(:label_matching)%> <%= @customers.count %> <%=t(:field_customers)%> </p>
|
|
||||||
|
|
||||||
<div class="actions">
|
|
||||||
<%= will_paginate @customers %>
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<% else %>
|
<h2><%= l(:label_customers) %></h2>
|
||||||
<p><%=t(:label_no_customers)%> <%= params[:search] %>.</p>
|
|
||||||
|
<%= form_tag(customers_path, method: :get, id: 'customer-search-form') do %>
|
||||||
|
<p class="qbo-customer-search">
|
||||||
|
<%= text_field_tag :search, @search, class: 'customer-name', size: 40, placeholder: t(:label_search_customers),
|
||||||
|
autocomplete: 'off', data: { autocomplete_url: '/customers/autocomplete' } %>
|
||||||
|
<%= submit_tag l(:label_search), name: nil %>
|
||||||
|
<% if @search.present? %>
|
||||||
|
<%= link_to sprite_icon('reload', l(:button_clear)), customers_path, class: 'icon icon-reload' %>
|
||||||
|
<% end %>
|
||||||
|
</p>
|
||||||
<% end %>
|
<% end %>
|
||||||
|
|
||||||
<div>
|
<% if @customers.empty? %>
|
||||||
<%= render partial: 'qbo/stats' %>
|
<p class="nodata"><%= @search.present? ? l(:label_no_customers, search: @search) : l(:label_no_data) %></p>
|
||||||
</div>
|
<% else %>
|
||||||
|
<% if @best_first %>
|
||||||
|
<p class="info"><%= l(:text_customers_best_match, count: @customer_count) %></p>
|
||||||
|
<% end %>
|
||||||
|
<div class="autoscroll">
|
||||||
|
<table class="list customers odd-even">
|
||||||
|
<thead>
|
||||||
|
<tr>
|
||||||
|
<%= sort_header_tag('name', caption: l(:field_name)) %>
|
||||||
|
<%= sort_header_tag('phone', caption: l(:label_primary_phone)) %>
|
||||||
|
<%= sort_header_tag('mobile', caption: l(:label_mobile_phone)) %>
|
||||||
|
<th><%= l(:label_issue_plural) %></th>
|
||||||
|
<%= sort_header_tag('updated', caption: l(:field_updated_on), default_order: 'desc') %>
|
||||||
|
</tr>
|
||||||
|
</thead>
|
||||||
|
<tbody>
|
||||||
|
<% @customers.each do |customer| %>
|
||||||
|
<tr class="<%= cycle('odd', 'even') %>">
|
||||||
|
<td class="name"><%= link_to customer.name, customer_path(customer.id) %></td>
|
||||||
|
<td class="phone"><%= phone.call(customer.phone_number) %></td>
|
||||||
|
<td class="phone"><%= phone.call(customer.mobile_phone_number) %></td>
|
||||||
|
<td class="issues"><%= @issue_counts[customer.id] || 0 %></td>
|
||||||
|
<td class="updated_on"><%= format_time(customer.updated_at) if customer.updated_at %></td>
|
||||||
|
</tr>
|
||||||
|
<% end %>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
</div>
|
||||||
|
<span class="pagination"><%= pagination_links_full @customer_pages, @customer_count %></span>
|
||||||
|
<% end %>
|
||||||
|
|
||||||
|
<p class="qbo-customer-stats"><%= render partial: 'qbo/stats' %></p>
|
||||||
|
|
||||||
|
<style>
|
||||||
|
table.customers td.name { text-align: left; }
|
||||||
|
table.customers td.phone, table.customers td.updated_on { white-space: nowrap; }
|
||||||
|
table.customers td.issues { width: 1%; text-align: center; }
|
||||||
|
.qbo-customer-search input { vertical-align: middle; }
|
||||||
|
</style>
|
||||||
@@ -1,3 +1,5 @@
|
|||||||
<h2><%=t(:label_new_customer)%></h2>
|
<h2><%= link_to l(:label_customers), customers_path %> » <%= l(:label_new_customer) %></h2>
|
||||||
<br/>
|
|
||||||
<%= render partial: 'customers/form' %>
|
<%= render partial: 'customers/form' %>
|
||||||
|
|
||||||
|
<% html_title(l(:label_new_customer)) -%>
|
||||||
@@ -1,4 +1,39 @@
|
|||||||
<h2><%=t(:field_customer)%> #<%= @customer.id %> - <%= link_to @customer.to_s, "https://#{Setting.plugin_redmine_qbo[:sandbox] ? "sandbox" : "app"}.qbo.intuit.com/app/customerdetail?nameId=#{@customer.id}", target: :_blank %> </h2>
|
<% html_title @customer.to_s %>
|
||||||
|
|
||||||
|
<h2><%= link_to l(:label_customers), customers_path %> » <%= @customer.to_s %></h2>
|
||||||
|
|
||||||
|
<%# Under the title rather than beside it, so a long name and the many actions don't crowd each other %>
|
||||||
|
<div class="contextual qbo-under-title">
|
||||||
|
<%# New issue for this customer; picks up what's ticked on this page (an estimate, other plugins' items) %>
|
||||||
|
<%= link_to sprite_icon('add', l(:label_new_issue)), new_issue_path(issue: { customer_id: @customer.id }),
|
||||||
|
id: 'dynamic-new-issue-link', class: 'icon icon-add', target: :_blank %>
|
||||||
|
<%# Plugins add their customer actions here (e.g. redmine_qbo_calendar's Add appointment) %>
|
||||||
|
<%= call_hook :view_customers_show_contextual, { customer: @customer } %>
|
||||||
|
<%# Estimates, invoices and payments are handled here, each shown to users with its permission; Open in
|
||||||
|
QuickBooks goes to their QuickBooks account page for anything else. %>
|
||||||
|
<% if RedmineQboBilling.writer? %>
|
||||||
|
<%= render partial: 'qbo_estimates/customer_link', locals: { customer: @customer } %>
|
||||||
|
<% end %>
|
||||||
|
<% 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 RedmineQboBilling.refunder? %>
|
||||||
|
<%= link_to sprite_icon('arrow-narrow-left', l(:label_refund)), new_qbo_refund_path(customer_id: @customer.id), class: 'icon icon-arrow-narrow-left' %>
|
||||||
|
<% end %>
|
||||||
|
<% if User.current.allowed_to?(:edit_customers, nil, global: true) %>
|
||||||
|
<%= link_to sprite_icon('edit', l(:button_edit)), edit_customer_path(@customer),
|
||||||
|
class: 'icon icon-edit', accesskey: accesskey(:edit) %>
|
||||||
|
<% end %>
|
||||||
|
<%= link_to sprite_icon('link', l(:button_open_in_quickbooks)),
|
||||||
|
"https://#{RedmineQbo.sandbox_mode? ? 'sandbox' : 'app'}.qbo.intuit.com/app/customerdetail?nameId=#{@customer.id}",
|
||||||
|
class: 'icon icon-link', target: :_blank, rel: 'noopener' %>
|
||||||
|
</div>
|
||||||
<div class="issue">
|
<div class="issue">
|
||||||
|
|
||||||
<div class="splitcontent">
|
<div class="splitcontent">
|
||||||
@@ -9,17 +44,7 @@
|
|||||||
|
|
||||||
<!-- Customer Info -->
|
<!-- Customer Info -->
|
||||||
|
|
||||||
<div class="splitcontent">
|
<%= render partial: 'customers/details', locals: {customer: @customer} %>
|
||||||
<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>
|
|
||||||
|
|
||||||
|
|
||||||
<!-- QBO Info -->
|
<!-- QBO Info -->
|
||||||
@@ -36,6 +61,34 @@
|
|||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
|
<%# Estimate and invoice drafts, kept in Redmine until they're saved to QuickBooks %>
|
||||||
|
<% customer_drafts = QboDraft.visible.where(customer_id: @customer.id).includes(:user).newest_first.to_a %>
|
||||||
|
<% if customer_drafts.any? %>
|
||||||
|
<h4><%= l(:label_qbo_drafts) %>:</h4>
|
||||||
|
<%= render partial: 'qbo_drafts/list', locals: { drafts: customer_drafts, show_customer: false } %>
|
||||||
|
<% end %>
|
||||||
|
|
||||||
|
<%# Refunds made from Redmine (SOP-OPS-014) %>
|
||||||
|
<% if RedmineQboBilling.refunder? %>
|
||||||
|
<% customer_refunds = QboRefund.where(customer_id: @customer.id).recent.limit(10).to_a %>
|
||||||
|
<% if customer_refunds.any? %>
|
||||||
|
<h4><%= l(:label_refunds) %>:</h4>
|
||||||
|
<table class="list">
|
||||||
|
<tbody>
|
||||||
|
<% customer_refunds.each do |refund| %>
|
||||||
|
<tr>
|
||||||
|
<td><%= link_to format_date(refund.txn_date), qbo_refund_path(refund) %></td>
|
||||||
|
<td><%= refund.estimate_id.present? ? link_to("E#{refund.estimate_number}", RedmineQboBilling.writer? ? edit_qbo_estimate_path(refund.estimate_id) : estimate_path(refund.estimate_id)) : '' %></td>
|
||||||
|
<td><%= refund.method_name %></td>
|
||||||
|
<td style="text-align: right"><%= RedmineQboBilling::RefundWriter.money(refund.refund_amount) %></td>
|
||||||
|
<td><%= refund.done? ? '' : l(:label_refund_incomplete) %></td>
|
||||||
|
</tr>
|
||||||
|
<% end %>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
<% end %>
|
||||||
|
<% end %>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div class="splitcontentleft">
|
<div class="splitcontentleft">
|
||||||
@@ -46,8 +99,10 @@
|
|||||||
</div>
|
</div>
|
||||||
|
|
||||||
<br/>
|
<br/>
|
||||||
<h3><%=@issues.open.count%> <%=t(:label_open_issues)%> - <%=@hours.round(1)%> <%=t(:label_hours)%></h3>
|
<h3><%=@open_issues.count%> <%=t(:label_open_issues)%> - <%=@hours.round(1)%> <%=t(:label_hours)%></h3>
|
||||||
<%= render partial: 'issues/list_simple', locals: {issues: @issues.open} %>
|
<%= render partial: 'issues/list_simple', locals: {issues: @open_issues.open} %>
|
||||||
|
|
||||||
<h3><%=@closed_issues.count%> <%=t(:label_closed_issues)%> - <%= @closed_hours.round(1)%> <%=t(:label_hours)%></h3>
|
<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: 'issues/list_simple', locals: {issues: @closed_issues} %>
|
||||||
|
|
||||||
|
<%= render partial: 'customers/new_issue_link_script' %>
|
||||||
@@ -1,11 +1,19 @@
|
|||||||
<% unless estimates.empty? %>
|
<% unless estimates.empty? %>
|
||||||
|
|
||||||
|
<%= render partial: 'qbo_estimates/status_styles' %>
|
||||||
|
<div class="qbo-estimate-list">
|
||||||
<% estimates.sort.reverse.each do |estimate| %>
|
<% estimates.sort.reverse.each do |estimate| %>
|
||||||
<div class="row">
|
<div class="row">
|
||||||
<%= check_box_tag "estimate_ids[]", estimate.id, false, onchange: "updateLink()", class: "estimate-checkbox" %>
|
<%= check_box_tag "estimate_ids[]", estimate.id, false, onchange: "updateLink()", data: { text: "Estimate ##{estimate.doc_number}", new_issue_param: 'issue[estimate_id]' }, class: "estimate-checkbox appointment" %>
|
||||||
<b><%= link_to "##{estimate.doc_number}", estimate_path(estimate), target: :_blank %></b> <%= estimate.txn_date %>
|
<b><%= link_to "##{estimate.doc_number}", estimate_path(estimate), target: :_blank %></b> <%= estimate.txn_date %>
|
||||||
|
<%# QuickBooks status, cached by the estimate sync (kept current by the webhook) %>
|
||||||
|
<% if estimate.txn_status.present? %>
|
||||||
|
<span class="qbo-estimate-status qbo-estimate-status-<%= estimate.txn_status.downcase %>"><%= estimate.txn_status %></span>
|
||||||
|
<% end %>
|
||||||
|
<%= render partial: 'qbo_estimates/estimate_actions', locals: { estimate: estimate } if RedmineQboBilling.writer? %>
|
||||||
</div>
|
</div>
|
||||||
<% end %>
|
<% end %>
|
||||||
|
</div>
|
||||||
|
|
||||||
<% else %>
|
<% else %>
|
||||||
<p><%=t(:label_no_estimates)%>.</p>
|
<p><%=t(:label_no_estimates)%>.</p>
|
||||||
|
|||||||
@@ -1,4 +1,4 @@
|
|||||||
<%= form_tag(estimate_doc_path, method: "get") do %>
|
<%= form_tag(estimate_doc_path, method: "get", id: "estimate-search-form") do %>
|
||||||
<%= text_field_tag :search, params[:search], placeholder: t(:label_search_estimates), autocomplete: "off" %>
|
<%= text_field_tag :search, params[:search], placeholder: t(:label_search_estimates), autocomplete: "off" %>
|
||||||
<%= submit_tag t(:label_search), formtarget: "_blank" %>
|
<%= submit_tag t(:label_search), formtarget: "_blank" %>
|
||||||
<% end %>
|
<% end %>
|
||||||
@@ -1,4 +1,5 @@
|
|||||||
<% unless invoices.empty? %>
|
<% unless invoices.empty? %>
|
||||||
|
<%= render partial: 'qbo_estimates/status_styles' %>
|
||||||
|
|
||||||
<%= form_with(url: invoice_path, method: :get) do |form| %>
|
<%= form_with(url: invoice_path, method: :get) do |form| %>
|
||||||
|
|
||||||
@@ -10,12 +11,19 @@
|
|||||||
<hr>
|
<hr>
|
||||||
<% end %>
|
<% end %>
|
||||||
|
|
||||||
|
<div class="qbo-invoice-list">
|
||||||
<% invoices.sort.reverse.each do |invoice| %>
|
<% invoices.sort.reverse.each do |invoice| %>
|
||||||
<div class="row">
|
<div class="row">
|
||||||
<%= check_box_tag "invoice_ids[]", invoice.id, false, onchange: "updateLink()", class: "invoice-checkbox" if invoices.count > 1 %>
|
<%= 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 %>
|
<b><%= link_to "##{invoice.doc_number}", invoice_path(invoice), target: :_blank %></b> <%= invoice.txn_date %>
|
||||||
|
<%# Paid / partially paid / overdue / open / voided, from the cached balance and due date %>
|
||||||
|
<% if (status = invoice.status) %>
|
||||||
|
<span class="qbo-estimate-status qbo-invoice-status-<%= status %>"><%= RedmineQboBilling::InvoiceStatus.label(status, paid_on: invoice.paid_on) %></span>
|
||||||
|
<% end %>
|
||||||
|
<%= render partial: 'qbo_invoices/invoice_actions', locals: { invoice: invoice } if RedmineQboBilling.invoice_writer? %>
|
||||||
</div>
|
</div>
|
||||||
<% end %>
|
<% end %>
|
||||||
|
</div>
|
||||||
|
|
||||||
<% if invoices.count > 1 %>
|
<% if invoices.count > 1 %>
|
||||||
<%= form.submit t(:button_bulk_pdf) %>
|
<%= form.submit t(:button_bulk_pdf) %>
|
||||||
|
|||||||
@@ -7,7 +7,16 @@
|
|||||||
|
|
||||||
<div class="estimate_id attribute">
|
<div class="estimate_id attribute">
|
||||||
<div class="label"><span><%=t(:field_estimate)%></span>:</div>
|
<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? %>
|
||||||
|
<%# Create the estimate's remaining labor lines as subtasks of this issue %>
|
||||||
|
<% if issue.estimate && User.current.allowed_to?(:create_estimate_issues, nil, global: true) && User.current.allowed_to?(:manage_subtasks, issue.project) %>
|
||||||
|
<%= link_to sprite_icon('add', l(:button_create_estimate_subtasks)),
|
||||||
|
issues_preview_qbo_estimate_path(issue.estimate.id, parent_issue_id: issue.id),
|
||||||
|
class: 'icon-only icon-add', title: l(:button_create_estimate_subtasks) %>
|
||||||
|
<% end %>
|
||||||
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div class="invoice_id attribute">
|
<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,105 @@
|
|||||||
|
<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>
|
||||||
|
<%# Labor: issues from estimates, lines imported time replaces on invoices, and hours for the business report.
|
||||||
|
While none are chosen, items named "Labor" are used and shown selected. %>
|
||||||
|
<p>
|
||||||
|
<label for="settings_labor_item_ids"><%= l(:label_labor_items) %></label>
|
||||||
|
<%= hidden_field_tag 'settings[labor_item_ids][]', '', id: nil %>
|
||||||
|
<%= select_tag 'settings[labor_item_ids][]',
|
||||||
|
options_from_collection_for_select(Item.sellable.order(:name), :id, :name,
|
||||||
|
RedmineQboBilling::LaborItems.item_ids),
|
||||||
|
multiple: true, size: 8, id: 'settings_labor_item_ids' %>
|
||||||
|
<em class="info"><%= l(:text_labor_items) %></em>
|
||||||
|
</p>
|
||||||
|
<%# QuickBooks custom fields to leave out of estimates and invoices (see RedmineQboBilling::Company). Hidden
|
||||||
|
fields that aren't found right now (e.g. no recent estimate has them) are kept as hidden. %>
|
||||||
|
<% company = RedmineQboBilling::Company %>
|
||||||
|
<% qbo_fields = company.all_custom_fields %>
|
||||||
|
<% hidden_ids = company.hidden_field_ids %>
|
||||||
|
<% sales_field = company.sales_person_field %>
|
||||||
|
<p class="qbo-custom-fields-setting">
|
||||||
|
<label><%= l(:label_qbo_hidden_custom_fields) %></label>
|
||||||
|
<%= hidden_field_tag 'settings[hidden_custom_field_ids][]', '', id: nil %>
|
||||||
|
<% (hidden_ids - qbo_fields.map { |f| f.id.to_i }).each do |id| %>
|
||||||
|
<%= hidden_field_tag 'settings[hidden_custom_field_ids][]', id, id: nil %>
|
||||||
|
<% end %>
|
||||||
|
<% if qbo_fields.empty? %>
|
||||||
|
<%= l(:label_none) %>
|
||||||
|
<% else %>
|
||||||
|
<% qbo_fields.each do |field| %>
|
||||||
|
<label class="block">
|
||||||
|
<%= check_box_tag 'settings[hidden_custom_field_ids][]', field.id, hidden_ids.include?(field.id.to_i),
|
||||||
|
id: "settings_hidden_custom_field_#{field.id}" %>
|
||||||
|
<%= field.name %>
|
||||||
|
<% if sales_field && sales_field.id.to_i == field.id.to_i %>
|
||||||
|
<em>(<%= l(:text_qbo_sales_person_field) %>)</em>
|
||||||
|
<% end %>
|
||||||
|
</label>
|
||||||
|
<% end %>
|
||||||
|
<% end %>
|
||||||
|
<%= link_to sprite_icon('reload', l(:button_refresh_quickbooks_fields)), refresh_company_qbo_estimates_path,
|
||||||
|
method: :post, class: 'icon icon-reload' %>
|
||||||
|
<em class="info"><%= l(:text_qbo_hidden_custom_fields) %></em>
|
||||||
|
</p>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<% issue_builder = RedmineQboBilling::EstimateIssueBuilder %>
|
||||||
|
<fieldset class="box tabular">
|
||||||
|
<legend><%= l(:label_estimate_issue_settings) %></legend>
|
||||||
|
<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>
|
||||||
|
|
||||||
|
<%# Refunds (SOP-OPS-014): the restocking fee, and where the refund check or card refund is recorded %>
|
||||||
|
<% refunds = RedmineQboBilling::RefundWriter %>
|
||||||
|
<% accounts = Account.where(active: true).order(:name).pluck(:name, :id) %>
|
||||||
|
<fieldset class="box tabular">
|
||||||
|
<legend><%= l(:label_refund_settings) %></legend>
|
||||||
|
<p>
|
||||||
|
<label for="settings_restocking_fee_rate"><%= l(:label_restocking_fee_rate) %></label>
|
||||||
|
<%= number_field_tag 'settings[restocking_fee_rate]', refunds.plain(refunds.fee_rate), id: 'settings_restocking_fee_rate',
|
||||||
|
min: 0, max: 100, step: 0.01, style: 'width: 6em' %>%
|
||||||
|
<em class="info"><%= l(:text_restocking_fee_rate) %></em>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<label for="settings_restocking_item_id"><%= l(:label_restocking_item) %></label>
|
||||||
|
<%= select_tag 'settings[restocking_item_id]', options_from_collection_for_select(Item.sellable.order(:name), :id, :name, @settings['restocking_item_id']),
|
||||||
|
include_blank: true, id: 'settings_restocking_item_id' %>
|
||||||
|
<em class="info"><%= l(:text_restocking_item) %></em>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<label for="settings_refund_check_account_id"><%= l(:label_refund_check_account) %></label>
|
||||||
|
<%= select_tag 'settings[refund_check_account_id]', options_for_select(accounts, @settings['refund_check_account_id'].to_s),
|
||||||
|
include_blank: l(:label_refund_first_bank_account), id: 'settings_refund_check_account_id' %>
|
||||||
|
<em class="info"><%= l(:text_refund_check_account) %></em>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<label for="settings_refund_card_account_id"><%= l(:label_refund_card_account) %></label>
|
||||||
|
<%= select_tag 'settings[refund_card_account_id]', options_for_select(accounts, @settings['refund_card_account_id'].to_s),
|
||||||
|
include_blank: l(:label_refund_first_bank_account), id: 'settings_refund_card_account_id' %>
|
||||||
|
<em class="info"><%= l(:text_refund_card_account) %></em>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<label for="settings_refund_canceled_status_id"><%= l(:label_refund_canceled_status) %></label>
|
||||||
|
<%= select_tag 'settings[refund_canceled_status_id]', options_from_collection_for_select(IssueStatus.sorted, :id, :name, @settings['refund_canceled_status_id'].to_s),
|
||||||
|
include_blank: refunds.canceled_status ? "#{refunds.canceled_status.name} (#{l(:label_default)})" : true, id: 'settings_refund_canceled_status_id' %>
|
||||||
|
<em class="info"><%= l(:text_refund_canceled_status) %></em>
|
||||||
|
</p>
|
||||||
|
</fieldset>
|
||||||
@@ -1,3 +1,3 @@
|
|||||||
"<div id='footer' align='center'>
|
<div id='footer' align='center'>
|
||||||
<b><%=I18n.translate(:label_last_sync)%>: </b> <%=Qbo.last_sync if Qbo.exists?%>
|
<%= render partial: 'qbo/last_sync' %>
|
||||||
</div>"
|
</div>
|
||||||
@@ -1 +1 @@
|
|||||||
<b><%=t(:label_last_sync)%>: </b> <%= Qbo.last_sync if Qbo.exists? %>
|
<b><%=t(:label_last_sync)%>: </b> <%= Qbo.last_sync %>
|
||||||
@@ -1,111 +1,106 @@
|
|||||||
<!--
|
|
||||||
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.
|
|
||||||
-->
|
|
||||||
|
|
||||||
<!-- somewhere in your document include the Javascript -->
|
|
||||||
<script type="text/javascript" src="https://appcenter.intuit.com/Content/IA/intuit.ipp.anywhere.js"></script>
|
<script type="text/javascript" src="https://appcenter.intuit.com/Content/IA/intuit.ipp.anywhere.js"></script>
|
||||||
|
|
||||||
<!-- configure the Intuit object: 'grantUrl' is a URL in your application which kicks off the flow, see below -->
|
|
||||||
<script>
|
<script>
|
||||||
intuit.ipp.anywhere.setup({menuProxy: '/path/to/blue-dot', grantUrl: '<%= qbo_authenticate_path %>'});
|
intuit.ipp.anywhere.setup({menuProxy: '/path/to/blue-dot', grantUrl: '<%= qbo_authenticate_path %>'});
|
||||||
</script>
|
</script>
|
||||||
|
|
||||||
<table >
|
<%# QuickBooks connection: app keys, webhook token, sandbox, and the OAuth connection %>
|
||||||
<tbody>
|
<h3><%= l(:label_qbo_connection) %></h3>
|
||||||
|
<div class="box tabular">
|
||||||
<tr>
|
<p>
|
||||||
<th><%=t(:label_client_id)%></th>
|
<label><%= t(:label_client_id) %></label>
|
||||||
<td>
|
<%= text_field_tag 'settings[oauth_consumer_key]', settings[:oauth_consumer_key], size: 50 %>
|
||||||
<input
|
</p>
|
||||||
type="text"
|
<p>
|
||||||
style="width:350px"
|
<label><%= t(:label_client_secret) %></label>
|
||||||
id="settingsOAuthConsumerKey"
|
<%= password_field_tag 'settings[oauth_consumer_secret]', settings[:oauth_consumer_secret], size: 50 %>
|
||||||
value="<%= settings['settingsOAuthConsumerKey'] %>"
|
</p>
|
||||||
name="settings[settingsOAuthConsumerKey]" >
|
<p>
|
||||||
</td>
|
<label><%= t(:label_webhook_token) %></label>
|
||||||
</tr>
|
<%= text_field_tag 'settings[webhook_token]', settings[:webhook_token], size: 50 %>
|
||||||
|
</p>
|
||||||
<tr>
|
<p>
|
||||||
<th><%=t(:label_client_secret)%></th>
|
<label><%= t(:label_sandbox) %></label>
|
||||||
<td>
|
<%= check_box_tag 'settings[sandbox]', 1, settings[:sandbox] %>
|
||||||
<input
|
</p>
|
||||||
type="text"
|
<p>
|
||||||
style="width:350px"
|
<label><%= t(:label_oauth_expires) %></label>
|
||||||
id="settingsOAuthConsumerSecret"
|
<span class="icon <%= Qbo.oauth2_access_token_expires_at&.future? ? 'icon-ok' : 'icon-warning' %>">
|
||||||
value="<%= settings['settingsOAuthConsumerSecret'] %>"
|
<%= Qbo.oauth2_access_token_expires_at ? format_time(Qbo.oauth2_access_token_expires_at) : 'N/A' %>
|
||||||
name="settings[settingsOAuthConsumerSecret]" >
|
</span>
|
||||||
</td>
|
</p>
|
||||||
</tr>
|
<p>
|
||||||
|
<label></label>
|
||||||
<tr>
|
<ipp:connectToIntuit></ipp:connectToIntuit>
|
||||||
<th><%=t(:label_webhook_token)%></th>
|
</p>
|
||||||
<td>
|
|
||||||
<input
|
|
||||||
type="text"
|
|
||||||
style="width:350px"
|
|
||||||
id="settingsWebhookToken"
|
|
||||||
value="<%= settings['settingsWebhookToken'] %>"
|
|
||||||
name="settings[settingsWebhookToken]" >
|
|
||||||
</td>
|
|
||||||
</tr>
|
|
||||||
|
|
||||||
<tr>
|
|
||||||
<th><%=t(:label_sandbox)%></th>
|
|
||||||
<td>
|
|
||||||
<%= check_box_tag 'settings[sandbox]', @settings[:sandbox], @settings[:sandbox] %>
|
|
||||||
</td>
|
|
||||||
</tr>
|
|
||||||
|
|
||||||
<tr>
|
|
||||||
<th><%=t(:label_oauth_expires)%></th>
|
|
||||||
<td><%= if Qbo.exists? then Qbo.first.oauth2_access_token_expires_at end %>
|
|
||||||
</tr>
|
|
||||||
|
|
||||||
<tr>
|
|
||||||
<th><%=t(:label_oauth2_refresh_token_expires_at)%></th>
|
|
||||||
<td><%= if Qbo.exists? then Qbo.first.oauth2_refresh_token_expires_at end %>
|
|
||||||
</tr>
|
|
||||||
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
|
|
||||||
<br/>
|
|
||||||
<%=t(:label_oauth_note)%>
|
|
||||||
<br/>
|
|
||||||
<br/>
|
|
||||||
|
|
||||||
<!-- this will display a button that the user clicks to start the flow -->
|
|
||||||
<ipp:connectToIntuit></ipp:connectToIntuit>
|
|
||||||
|
|
||||||
<br/>
|
|
||||||
<br/>
|
|
||||||
|
|
||||||
<div>
|
|
||||||
<b><%=t(:label_customer_count)%>:</b> <%= Customer.count%>
|
|
||||||
</div>
|
|
||||||
|
|
||||||
<div>
|
|
||||||
<b><%=t(:label_employee_count)%>:</b> <%= Employee.count %>
|
|
||||||
</div>
|
|
||||||
|
|
||||||
<div>
|
|
||||||
<b><%=t(:label_invoice_count)%>:</b> <%= Invoice.count %>
|
|
||||||
</div>
|
|
||||||
|
|
||||||
<div>
|
|
||||||
<b><%=t(:label_estimate_count)%>:</b> <%= Estimate.count %>
|
|
||||||
</div>
|
|
||||||
|
|
||||||
<br/>
|
|
||||||
|
|
||||||
<div>
|
|
||||||
<b><%=t(:label_last_sync)%> </b> <%= Qbo.last_sync if Qbo.exists? %> <%= link_to t(:label_sync_now), qbo_sync_path %>
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
|
<%# Everything kept in step with QuickBooks: how many records there are, when each last changed, and a sync
|
||||||
|
button for each. A type's sync re-reads all of its records from QuickBooks. %>
|
||||||
|
<% sync_rows = [
|
||||||
|
[l(:label_customers), Customer, sync_customers_path, customers_path],
|
||||||
|
[l(:label_employee_plural), Employee, employees_sync_path, nil],
|
||||||
|
[l(:label_estimates), Estimate, estimates_sync_path, nil],
|
||||||
|
[l(:label_invoices), Invoice, invoices_sync_path, nil],
|
||||||
|
[l(:label_payments), Payment, sync_qbo_payments_path, nil],
|
||||||
|
[l(:label_items), Item, sync_items_path, items_path],
|
||||||
|
[l(:label_accounts), Account, sync_accounts_path, accounts_path]
|
||||||
|
] %>
|
||||||
|
<% sync_statuses = QboSyncStatus.by_entity %>
|
||||||
|
<h3><%= l(:label_management_and_sync) %></h3>
|
||||||
|
<div class="box">
|
||||||
|
<table class="list qbo-sync-table">
|
||||||
|
<thead>
|
||||||
|
<tr>
|
||||||
|
<th class="name"></th>
|
||||||
|
<th class="count"><%= l(:label_qbo_records) %></th>
|
||||||
|
<th class="updated"><%= l(:label_last_sync) %></th>
|
||||||
|
<th class="buttons"></th>
|
||||||
|
</tr>
|
||||||
|
</thead>
|
||||||
|
<tbody>
|
||||||
|
<% sync_rows.each do |label, model, sync_path, list_path| %>
|
||||||
|
<tr>
|
||||||
|
<td class="name"><%= list_path ? link_to(label, list_path) : label %></td>
|
||||||
|
<td class="count"><%= model.count %></td>
|
||||||
|
<td class="updated">
|
||||||
|
<% status = sync_statuses[model.name] %>
|
||||||
|
<% if status&.running? %>
|
||||||
|
<span class="icon icon-reload qbo-sync-busy"><%= l(:text_qbo_sync_running_short, count: number_with_delimiter(status.processed)) %></span>
|
||||||
|
<% elsif status %>
|
||||||
|
<span class="qbo-sync-busy"><%= l(:text_qbo_sync_queued) %></span>
|
||||||
|
<% else %>
|
||||||
|
<%= model.last_sync %>
|
||||||
|
<% end %>
|
||||||
|
</td>
|
||||||
|
<td class="buttons"><%= link_to sprite_icon('reload', l(:label_sync)), sync_path, class: 'icon icon-reload' %></td>
|
||||||
|
</tr>
|
||||||
|
<% end %>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
|
||||||
|
<p class="qbo-sync-default-account">
|
||||||
|
<strong><%= t(:label_default_account) %>:</strong> <%= Account.get_default || '–' %>
|
||||||
|
<em class="info"><%= l(:text_default_account_info) %></em>
|
||||||
|
</p>
|
||||||
|
|
||||||
|
<p class="qbo-sync-all">
|
||||||
|
<strong><%= t(:label_last_sync) %> (QBO):</strong> <%= Qbo.exists? ? Qbo.last_sync : l(:label_never_synced) %>
|
||||||
|
<%= link_to sprite_icon('reload', l(:label_sync_changes)), qbo_sync_path, class: 'button icon icon-reload' %>
|
||||||
|
<%= link_to sprite_icon('reload', l(:label_full_sync)), qbo_sync_path(full_sync: true), class: 'button icon icon-reload' %>
|
||||||
|
</p>
|
||||||
|
<em class="info"><%= l(:text_qbo_sync_info) %></em>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<style>
|
||||||
|
table.qbo-sync-table { margin-bottom: 10px; }
|
||||||
|
table.qbo-sync-table td.name, table.qbo-sync-table th.name { text-align: left; }
|
||||||
|
table.qbo-sync-table td.count { text-align: right; width: 8em; }
|
||||||
|
table.qbo-sync-table td.updated { width: 14em; }
|
||||||
|
table.qbo-sync-table td.buttons { width: 6em; }
|
||||||
|
.qbo-sync-all .button { margin-left: 8px; }
|
||||||
|
.qbo-sync-busy { font-style: italic; color: #b06d00; }
|
||||||
|
</style>
|
||||||
|
|
||||||
|
<%# Billing: estimates, issues from estimates and invoices %>
|
||||||
|
<h3><%= l(:label_billing_settings) %></h3>
|
||||||
|
<%= render partial: 'qbo/billing_settings', locals: { settings: settings } %>
|
||||||
@@ -1,6 +1,9 @@
|
|||||||
<% if User.current.logged? %>
|
<% 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' %>
|
<%= render partial: 'estimates/sidebar' %>
|
||||||
|
|
||||||
<% end %>
|
<% end %>
|
||||||
@@ -0,0 +1,18 @@
|
|||||||
|
<%# On the new estimate/invoice editor: the draft being continued, or the customer's other drafts of this
|
||||||
|
document so a second one isn't started by accident %>
|
||||||
|
<% draft = local_assigns[:draft] %>
|
||||||
|
<% drafts = local_assigns[:drafts] || [] %>
|
||||||
|
<% if draft %>
|
||||||
|
<div class="flash notice qbo-draft-notice">
|
||||||
|
<%= l(:text_qbo_editing_draft, user: h(draft.user&.name || l(:label_user_anonymous)), age: time_tag(draft.updated_at)).html_safe %>
|
||||||
|
</div>
|
||||||
|
<% elsif drafts.any? %>
|
||||||
|
<div class="warning qbo-estimate-notice qbo-draft-notice">
|
||||||
|
<%= l(drafts.first.invoice? ? :text_qbo_customer_has_invoice_drafts : :text_qbo_customer_has_estimate_drafts, count: drafts.size) %>
|
||||||
|
<% drafts.each do |other| %>
|
||||||
|
<%= link_to l(:text_qbo_draft_link, user: other.user&.name || l(:label_user_anonymous),
|
||||||
|
subtotal: number_to_currency(other.subtotal), date: format_time(other.updated_at)),
|
||||||
|
other.invoice? ? new_qbo_invoice_path(draft_id: other.id) : new_qbo_estimate_path(draft_id: other.id) %>
|
||||||
|
<% end %>
|
||||||
|
</div>
|
||||||
|
<% end %>
|
||||||
@@ -0,0 +1,40 @@
|
|||||||
|
<%# Estimate and invoice drafts (QboDraft) with Continue and Delete. show_customer: false on a customer's page. %>
|
||||||
|
<% show_customer = local_assigns.fetch(:show_customer, true) %>
|
||||||
|
<table class="list qbo-drafts">
|
||||||
|
<thead>
|
||||||
|
<tr>
|
||||||
|
<th><%= l(:label_qbo_draft_document) %></th>
|
||||||
|
<% if show_customer %><th><%= l(:field_customer) %></th><% end %>
|
||||||
|
<th class="qbo-draft-number"><%= l(:label_qbo_draft_lines) %></th>
|
||||||
|
<th class="qbo-draft-number"><%= l(:label_subtotal) %></th>
|
||||||
|
<th><%= l(:label_qbo_draft_saved_by) %></th>
|
||||||
|
<th></th>
|
||||||
|
</tr>
|
||||||
|
</thead>
|
||||||
|
<tbody>
|
||||||
|
<% drafts.each do |draft| %>
|
||||||
|
<tr>
|
||||||
|
<td><%= link_to l(draft.invoice? ? :label_qbo_invoice_draft : :label_qbo_estimate_draft),
|
||||||
|
draft.invoice? ? new_qbo_invoice_path(draft_id: draft.id) : new_qbo_estimate_path(draft_id: draft.id) %></td>
|
||||||
|
<% if show_customer %>
|
||||||
|
<td><%= draft.customer ? link_to(draft.customer.name, customer_path(draft.customer)) : (draft.customer_name || '–') %></td>
|
||||||
|
<% end %>
|
||||||
|
<td class="qbo-draft-number"><%= draft.line_count %></td>
|
||||||
|
<td class="qbo-draft-number"><%= number_to_currency(draft.subtotal) %></td>
|
||||||
|
<td><%= l(:text_qbo_draft_saved_by, user: h(draft.user&.name || l(:label_user_anonymous)), age: time_tag(draft.updated_at)).html_safe %></td>
|
||||||
|
<td class="buttons">
|
||||||
|
<%= link_to sprite_icon('edit', l(:button_qbo_continue_draft)),
|
||||||
|
draft.invoice? ? new_qbo_invoice_path(draft_id: draft.id) : new_qbo_estimate_path(draft_id: draft.id),
|
||||||
|
class: 'icon icon-edit' %>
|
||||||
|
<%= link_to sprite_icon('del', l(:button_delete)), qbo_draft_path(draft), method: :delete,
|
||||||
|
data: { confirm: l(:text_are_you_sure) }, class: 'icon icon-del' %>
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
<% end %>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
<style>
|
||||||
|
table.qbo-drafts td, table.qbo-drafts th { text-align: left; }
|
||||||
|
table.qbo-drafts .qbo-draft-number { text-align: right; white-space: nowrap; }
|
||||||
|
table.qbo-drafts td.buttons { white-space: nowrap; }
|
||||||
|
</style>
|
||||||
@@ -0,0 +1,11 @@
|
|||||||
|
<% html_title l(:label_qbo_drafts) %>
|
||||||
|
|
||||||
|
<h2><%= link_to l(:label_customers), customers_path %> » <%= l(:label_qbo_drafts) %></h2>
|
||||||
|
|
||||||
|
<p class="info"><%= l(:text_qbo_drafts_info) %></p>
|
||||||
|
|
||||||
|
<% if @drafts.any? %>
|
||||||
|
<%= render partial: 'qbo_drafts/list', locals: { drafts: @drafts } %>
|
||||||
|
<% else %>
|
||||||
|
<p class="nodata"><%= l(:label_no_data) %></p>
|
||||||
|
<% end %>
|
||||||
@@ -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 @@
|
|||||||
|
<%# Billed estimates and estimates linked to an issue are read-only here, so they get a View link instead of Edit %>
|
||||||
|
<% if estimate.billed? || 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,330 @@
|
|||||||
|
<%
|
||||||
|
company = RedmineQboBilling::Company
|
||||||
|
sales_field = company.sales_person_field
|
||||||
|
# A box for every other text custom field QuickBooks has enabled (e.g. VIN, Mileage, Crew #)
|
||||||
|
custom_fields = company.editable_custom_fields
|
||||||
|
customer = Customer.find_by(id: form.customer_id) if form.customer_id.present?
|
||||||
|
# Suggestions other plugins give for those boxes (e.g. redmine_qbo_vehicles: the customer's vehicles' VINs)
|
||||||
|
field_options = RedmineQboBilling.field_options(customer)
|
||||||
|
# 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?
|
||||||
|
# The discount box, unless QuickBooks has discounts turned off or the document is read-only (shown anyway
|
||||||
|
# for a document that has one)
|
||||||
|
show_discount = form.discount? || (company.discounts_allowed? && !form.locked)
|
||||||
|
# The draft being continued (QboDraft), if any; new documents can be saved as drafts
|
||||||
|
draft = local_assigns[:draft]
|
||||||
|
sender = invoice ? RedmineQboBilling.invoice_sender? : RedmineQboBilling.sender?
|
||||||
|
cancel_path = customer ? customer_path(customer) : home_path
|
||||||
|
form_url =
|
||||||
|
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),
|
||||||
|
labor_item_ids: (RedmineQboBilling::LaborItems.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 'draft_id', draft.id, id: nil if draft %>
|
||||||
|
<%= hidden_field_tag 'estimate[total_tax]', form.total_tax, id: nil %>
|
||||||
|
<%= hidden_field_tag 'estimate[discount]', form.discount, id: nil %>
|
||||||
|
<%= hidden_field_tag 'estimate[email_status]', form.email_status, id: nil %>
|
||||||
|
<%= 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 %>
|
||||||
|
<%# A paid invoice opened for editing (Unlock) stays unlocked if the page is shown again %>
|
||||||
|
<% if form.unlocked %>
|
||||||
|
<%= hidden_field_tag 'unlock', '1', id: nil %>
|
||||||
|
<%= hidden_field_tag 'estimate[amount_paid]', form.amount_paid, id: nil %>
|
||||||
|
<% end %>
|
||||||
|
<%# Estimates whose lines are on this invoice; the Import panel adds more %>
|
||||||
|
<span id="qbo-linked-estimates">
|
||||||
|
<% form.linked_estimate_ids.each do |estimate_id| %>
|
||||||
|
<%= 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>
|
||||||
|
<%# Plugins' editor scripts find a box by its field id or name (qboEditor.field / fieldNamed) %>
|
||||||
|
<% custom_fields.each do |field| %>
|
||||||
|
<div class="qbo-field qbo-field-custom" data-qbo-field-id="<%= field.id %>" data-qbo-field-name="<%= field.name %>">
|
||||||
|
<label for="qbo_custom_field_<%= field.id %>"><%= field.name %></label>
|
||||||
|
<%= text_field_tag "estimate[custom_fields][#{field.id}]", form.custom_field(field), id: "qbo_custom_field_#{field.id}",
|
||||||
|
list: "qbo-custom-field-options-#{field.id}", maxlength: 31, autocomplete: 'off', spellcheck: false,
|
||||||
|
class: 'qbo-custom-field' %>
|
||||||
|
<datalist id="qbo-custom-field-options-<%= field.id %>">
|
||||||
|
<% Array(field_options[field.id.to_s]).each do |option| %>
|
||||||
|
<option value="<%= option[:value] %>"><%= option[:label] %></option>
|
||||||
|
<% end %>
|
||||||
|
</datalist>
|
||||||
|
</div>
|
||||||
|
<% end %>
|
||||||
|
<% if settings_read && (sales_field.nil? || custom_fields.empty?) && 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) %>">
|
||||||
|
<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 show_discount %>
|
||||||
|
<%# A percent of the subtotal or a dollar amount; QuickBooks' discount line %>
|
||||||
|
<tr class="qbo-estimate-discount">
|
||||||
|
<th>
|
||||||
|
<label for="qbo_estimate_discount_value"><%= l(:label_discount_from_quickbooks) %></label>
|
||||||
|
<%= text_field_tag 'estimate[discount_value]', form.discount_value, id: 'qbo_estimate_discount_value',
|
||||||
|
size: 6, inputmode: 'decimal', autocomplete: 'off', placeholder: '0' %>
|
||||||
|
<%= select_tag 'estimate[discount_type]',
|
||||||
|
options_for_select([[l(:label_discount_percent), 'percent'], [l(:label_discount_amount), 'amount']], form.discount_type),
|
||||||
|
id: 'qbo_estimate_discount_type', 'aria-label': l(:label_discount_type) %>
|
||||||
|
</th>
|
||||||
|
<td id="qbo-estimate-discount"><%= "-#{number_to_currency(form.discount_amount)}" if form.discount? %></td>
|
||||||
|
</tr>
|
||||||
|
<% end %>
|
||||||
|
<tr>
|
||||||
|
<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" data-saving-text="<%= l(:text_qbo_saving) %>">
|
||||||
|
<%= link_to l(:button_cancel), cancel_path, class: 'qbo-button qbo-button-dark', id: 'qbo-estimate-cancel' %>
|
||||||
|
<% unless form.locked %>
|
||||||
|
<span class="qbo-estimate-actions-save">
|
||||||
|
<%# Shown while a save is on its way to QuickBooks (qbo_estimates/_script) %>
|
||||||
|
<span class="qbo-saving-status" role="status" aria-live="polite" hidden></span>
|
||||||
|
<% unless form.persisted? %>
|
||||||
|
<%# Kept in Redmine only, however incomplete (QboDraftHandling) %>
|
||||||
|
<% if draft %>
|
||||||
|
<%= link_to l(:button_qbo_delete_draft), qbo_draft_path(draft), method: :delete,
|
||||||
|
data: { confirm: l(:text_are_you_sure) }, class: 'qbo-button qbo-button-dark', id: 'qbo-delete-draft' %>
|
||||||
|
<% end %>
|
||||||
|
<%= submit_tag l(:button_qbo_save_draft), name: 'save_draft', class: 'qbo-button qbo-button-dark',
|
||||||
|
id: 'qbo-save-draft', formnovalidate: true, data: { saving_text: l(:text_qbo_saving_draft) } %>
|
||||||
|
<% end %>
|
||||||
|
<%= submit_tag l(:button_save), name: 'save', class: 'qbo-button qbo-button-dark' %>
|
||||||
|
<% if sender %>
|
||||||
|
<%= submit_tag l(:button_save_and_send), name: 'save_and_send', class: 'qbo-button qbo-button-primary',
|
||||||
|
id: 'qbo-estimate-save-and-send',
|
||||||
|
data: { needs_email_text: l(:text_estimate_send_needs_email), saving_text: l(:text_qbo_saving_and_sending) } %>
|
||||||
|
<% end %>
|
||||||
|
</span>
|
||||||
|
<% end %>
|
||||||
|
</div>
|
||||||
|
<% end %>
|
||||||
|
|
||||||
|
<%= render partial: 'qbo_estimates/styles' %>
|
||||||
|
<%= render partial: 'qbo_estimates/script' %>
|
||||||
|
<%# Plugins add their editor scripts here (see window.qboEditor and the qbo:* events in qbo_estimates/_script) %>
|
||||||
|
<%= call_hook(:view_qbo_estimate_form_bottom, { form: form, document: form.document }) %>
|
||||||
@@ -0,0 +1,94 @@
|
|||||||
|
<%# 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 %>
|
||||||
|
<% status = RedmineQboBilling::InvoiceStatus.status(total: form.total, balance: form.balance,
|
||||||
|
due_date: RedmineQboBilling::EstimateForm.date(form.due_date),
|
||||||
|
today: User.current.today) %>
|
||||||
|
<% if status %>
|
||||||
|
<% paid_on = Invoice.where(id: form.id).pick(:paid_on) if status == :paid && form.id.present? %>
|
||||||
|
<span class="qbo-estimate-status qbo-invoice-status-<%= status %>"><%= RedmineQboBilling::InvoiceStatus.label(status, paid_on: paid_on) %></span>
|
||||||
|
<% end %>
|
||||||
|
<% elsif !invoice && form.txn_status.present? %>
|
||||||
|
<span class="qbo-estimate-status qbo-estimate-status-<%= form.txn_status.downcase %>"><%= form.txn_status %></span>
|
||||||
|
<% 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 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 == :billed %>
|
||||||
|
<div class="warning qbo-estimate-notice">
|
||||||
|
<%= l(:error_estimate_billed) %>
|
||||||
|
<% if Array(form.invoiced_on).any? %>
|
||||||
|
<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>
|
||||||
|
<% end %>
|
||||||
|
</div>
|
||||||
|
<% elsif 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) %>
|
||||||
|
<%# Opened for editing anyway after a confirmation (e.g. a discount after a deposit) %>
|
||||||
|
<% if RedmineQboBilling.paid_invoice_editor?(form.fully_paid?) %>
|
||||||
|
<%= link_to sprite_icon('unlock', l(:button_unlock_invoice)), edit_qbo_invoice_path(form.id, unlock: 1),
|
||||||
|
class: 'icon icon-unlock', id: 'qbo-unlock-invoice',
|
||||||
|
data: { confirm: l(:text_unlock_invoice_confirmation) } %>
|
||||||
|
<% end %>
|
||||||
|
</p>
|
||||||
|
<% elsif form.unlocked && form.amount_paid.to_d > 0 %>
|
||||||
|
<p class="warning"><%= l(:text_invoice_unlocked, paid: number_to_currency(form.amount_paid)) %></p>
|
||||||
|
<% elsif form.locked == :bundles %>
|
||||||
|
<p class="warning"><%= l(invoice ? :error_invoice_has_bundles : :error_estimate_has_bundles) %></p>
|
||||||
|
<% end %>
|
||||||
|
|
||||||
|
<% 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,840 @@
|
|||||||
|
<%# Inline so the page never depends on precompiled plugin assets %>
|
||||||
|
<%= javascript_tag do %>
|
||||||
|
$(function () {
|
||||||
|
var $form = $('#qbo-estimate-form');
|
||||||
|
if (!$form.length) return;
|
||||||
|
|
||||||
|
// For other plugins' editor scripts (added through the view_qbo_estimate_form_bottom hook). The form also
|
||||||
|
// triggers these events (listen with $(document).on('qbo:imported', '#qbo-estimate-form', fn)):
|
||||||
|
// qbo:customer-changed (event, { customer_id, info }) info includes field_options
|
||||||
|
// qbo:imported (event, { issue_ids, estimates, issue_values }) after time/estimates are
|
||||||
|
// imported into an invoice; issue_values is { issue_id => { field_id => value } }
|
||||||
|
// and each estimate has its own custom_fields { field_id => value }
|
||||||
|
window.qboEditor = {
|
||||||
|
form: $form,
|
||||||
|
document: $form.data('document'),
|
||||||
|
// A QuickBooks custom field's box, by field id or by a name pattern (RegExp)
|
||||||
|
field: function (id) { return $('#qbo_custom_field_' + id); },
|
||||||
|
fieldNamed: function (pattern) {
|
||||||
|
var $box = $();
|
||||||
|
$form.find('.qbo-field-custom').each(function () {
|
||||||
|
if (!$box.length && pattern.test(String($(this).data('qboFieldName')))) $box = $(this).find('input.qbo-custom-field');
|
||||||
|
});
|
||||||
|
return $box;
|
||||||
|
},
|
||||||
|
fieldId: function ($box) { return $box.closest('.qbo-field-custom').data('qboFieldId'); },
|
||||||
|
// Replaces a box's suggestion list: [{ value, label }]
|
||||||
|
setFieldOptions: function (id, options) {
|
||||||
|
var $list = $('#qbo-custom-field-options-' + id).empty();
|
||||||
|
(options || []).forEach(function (o) { $('<option>').attr('value', o.value).text(o.label || o.value).appendTo($list); });
|
||||||
|
}
|
||||||
|
};
|
||||||
|
|
||||||
|
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'));
|
||||||
|
// The discount QuickBooks took off when the document was last saved (the tax shown is for that discount)
|
||||||
|
var savedDiscount = $form.data('discount') === '' ? 0 : parseFloat($form.data('discount'));
|
||||||
|
var $discountValue = $('#qbo_estimate_discount_value');
|
||||||
|
var $discountType = $('#qbo_estimate_discount_type');
|
||||||
|
var locked = $form.find('.qbo-estimate-sheet').prop('disabled');
|
||||||
|
// Row keys must be digits: Rails' strong parameters only keep a hash of rows when every key is a number
|
||||||
|
var nextKey = Date.now();
|
||||||
|
var dirty = false;
|
||||||
|
|
||||||
|
// ---- numbers ----
|
||||||
|
// A number, or simple arithmetic typed into a quantity or rate box (e.g. 33*1.3, (120+15)/2): + - * / and
|
||||||
|
// parentheses only, worked out here (never run as code). null when empty, NaN when it can't be read.
|
||||||
|
function isMath(text) { return /[*\/()+x×]/.test(text) || /.-/.test(text); }
|
||||||
|
function evaluateMath(text) {
|
||||||
|
var tokens = text.replace(/[x×]/g, '*').match(/\d*\.?\d+|[-+*\/()]/g);
|
||||||
|
if (!tokens || tokens.join('') !== text.replace(/[x×]/g, '*')) return NaN;
|
||||||
|
var i = 0;
|
||||||
|
var peek = function () { return tokens[i]; };
|
||||||
|
var expr, term, factor;
|
||||||
|
factor = function () {
|
||||||
|
var t = tokens[i++];
|
||||||
|
if (t === '-') return -factor();
|
||||||
|
if (t === '+') return factor();
|
||||||
|
if (t === '(') { var v = expr(); if (tokens[i++] !== ')') return NaN; return v; }
|
||||||
|
return t !== undefined && /^\d*\.?\d+$/.test(t) ? parseFloat(t) : NaN;
|
||||||
|
};
|
||||||
|
term = function () {
|
||||||
|
var v = factor();
|
||||||
|
while (peek() === '*' || peek() === '/') { var op = tokens[i++], r = factor(); v = op === '*' ? v * r : v / r; }
|
||||||
|
return v;
|
||||||
|
};
|
||||||
|
expr = function () {
|
||||||
|
var v = term();
|
||||||
|
while (peek() === '+' || peek() === '-') { var op = tokens[i++], r = term(); v = op === '+' ? v + r : v - r; }
|
||||||
|
return v;
|
||||||
|
};
|
||||||
|
var result = expr();
|
||||||
|
return i === tokens.length && isFinite(result) ? result : NaN;
|
||||||
|
}
|
||||||
|
function parseNumber(value) {
|
||||||
|
var text = String(value == null ? '' : value).replace(/[$,\s]/g, '');
|
||||||
|
if (text === '') return null;
|
||||||
|
if (isMath(text)) return evaluateMath(text);
|
||||||
|
var n = Number(text);
|
||||||
|
return isFinite(n) ? n : NaN;
|
||||||
|
}
|
||||||
|
// Rounds half up exactly (1.005 -> 1.01; multiplying first would give 1.00)
|
||||||
|
function round(n, places) {
|
||||||
|
if (/e/i.test(String(n))) { var f = Math.pow(10, places); return Math.round(n * f) / f; }
|
||||||
|
return Number(Math.round(Number(n + 'e' + places)) + 'e-' + places);
|
||||||
|
}
|
||||||
|
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);
|
||||||
|
}
|
||||||
|
|
||||||
|
// The discount in dollars: a percent of the subtotal or an amount, like QuickBooks works it out
|
||||||
|
function discountAmount(subtotal) {
|
||||||
|
var value = parseNumber(String($discountValue.val() || '').replace(/%/g, ''));
|
||||||
|
if (!$discountValue.length || value === null || isNaN(value) || value <= 0) return 0;
|
||||||
|
return $discountType.val() === 'percent' ? round(subtotal * value / 100, 2) : round(value, 2);
|
||||||
|
}
|
||||||
|
|
||||||
|
function recalc() {
|
||||||
|
var subtotal = 0, taxable = 0, section = 0;
|
||||||
|
rows().each(function () {
|
||||||
|
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 discount = discountAmount(subtotal);
|
||||||
|
$('#qbo-estimate-discount').text(discount > 0 ? '-' + money.format(discount) : '');
|
||||||
|
var total = round(subtotal - discount, 2);
|
||||||
|
if (savedTax !== null && savedSubtotal !== null && Math.abs(subtotal - savedSubtotal) < 0.005 &&
|
||||||
|
Math.abs(discount - savedDiscount) < 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 ----
|
||||||
|
|
||||||
|
// Fills a line from a product/service: name, id, description (unless the user typed their own), rate,
|
||||||
|
// quantity 1 if empty, taxable
|
||||||
|
function applyItem($input, item) {
|
||||||
|
var $row = $input.closest('tr');
|
||||||
|
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]);
|
||||||
|
// Tabbed into it already (the product was filled in after the search came back): keep it selected
|
||||||
|
if (document.activeElement === $description[0]) $description[0].select();
|
||||||
|
}
|
||||||
|
$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();
|
||||||
|
}
|
||||||
|
|
||||||
|
// Keyboard subtotal: typed in a line's product box, then Tab or Enter
|
||||||
|
var SUBTOTAL_SHORTCUTS = ['sub', 'subtotal', '='];
|
||||||
|
|
||||||
|
// Puts a subtotal where the shortcut was typed: an otherwise empty line becomes the subtotal; a line with a
|
||||||
|
// description, quantity or rate keeps them (the shortcut text is cleared) and the subtotal goes after it.
|
||||||
|
// Then the next line's product box gets the focus, to carry on typing.
|
||||||
|
function insertSubtotalAt($row) {
|
||||||
|
var $subtotal = $(subtotalTemplate.replace(/__KEY__/g, String(nextKey++)));
|
||||||
|
var $product = $row.find('.qbo-line-item-name');
|
||||||
|
var otherwiseEmpty = !$row.find('.qbo-line-description-input').val().trim() &&
|
||||||
|
!$row.find('.qbo-line-qty-input').val().trim() && !$row.find('.qbo-line-rate-input').val().trim();
|
||||||
|
if (otherwiseEmpty) {
|
||||||
|
$row.replaceWith($subtotal);
|
||||||
|
} else {
|
||||||
|
$product.val('');
|
||||||
|
$row.removeClass('qbo-line-unmatched').after($subtotal);
|
||||||
|
}
|
||||||
|
renumber();
|
||||||
|
changed();
|
||||||
|
var $next = $subtotal.nextAll('tr.qbo-line').not('.qbo-line-subtotal').first();
|
||||||
|
if (!$next.length) $next = addRow();
|
||||||
|
$next.find('.qbo-line-item-name').trigger('focus');
|
||||||
|
}
|
||||||
|
|
||||||
|
// The product typed text points to: an exact name match, else the only result, else the only one whose name
|
||||||
|
// starts with the text (e.g. "lab" -> Labor). Nothing when it's ambiguous.
|
||||||
|
function bestItem(term, items) {
|
||||||
|
var t = term.trim().toLowerCase();
|
||||||
|
if (!t || !items || !items.length) return null;
|
||||||
|
var exact = items.filter(function (i) { return String(i.name).toLowerCase() === t; });
|
||||||
|
if (exact.length === 1) return exact[0];
|
||||||
|
if (items.length === 1) return items[0];
|
||||||
|
var starts = items.filter(function (i) { return String(i.name).toLowerCase().indexOf(t) === 0; });
|
||||||
|
return starts.length === 1 ? starts[0] : null;
|
||||||
|
}
|
||||||
|
|
||||||
|
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) {
|
||||||
|
$input.data('qboResults', { term: request.term, items: items });
|
||||||
|
response(items.map(function (item) {
|
||||||
|
return { label: item.name, value: item.name, item: item };
|
||||||
|
}));
|
||||||
|
})
|
||||||
|
.fail(function () { response([]); });
|
||||||
|
},
|
||||||
|
select: function (event, ui) {
|
||||||
|
applyItem($input, ui.item.item);
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
// Typing "sub", "subtotal" or "=" then Tab or Enter makes a subtotal here (see insertSubtotalAt)
|
||||||
|
$input.on('keydown', function (event) {
|
||||||
|
if ((event.key !== 'Tab' && event.key !== 'Enter') || event.shiftKey) return;
|
||||||
|
var $row = $input.closest('tr');
|
||||||
|
if (SUBTOTAL_SHORTCUTS.indexOf($input.val().trim().toLowerCase()) < 0 || $row.find('.qbo-line-item-id').val()) return;
|
||||||
|
event.preventDefault();
|
||||||
|
event.stopImmediatePropagation();
|
||||||
|
var search = $input.autocomplete('instance');
|
||||||
|
clearTimeout(search.searching);
|
||||||
|
search.cancelSearch = true;
|
||||||
|
$input.autocomplete('close');
|
||||||
|
insertSubtotalAt($row);
|
||||||
|
});
|
||||||
|
|
||||||
|
// Tab picks the product the text points to (an item highlighted in the list is picked by the
|
||||||
|
// autocomplete itself). If the search hasn't come back yet, the line is filled in when it does.
|
||||||
|
$input.on('keydown', function (event) {
|
||||||
|
if (event.key !== 'Tab' || event.shiftKey) return;
|
||||||
|
var menu = $input.autocomplete('instance').menu;
|
||||||
|
if (menu && menu.active) return;
|
||||||
|
var $row = $input.closest('tr');
|
||||||
|
var term = $input.val();
|
||||||
|
if ($row.find('.qbo-line-item-id').val() || !term.trim()) return;
|
||||||
|
|
||||||
|
var known = $input.data('qboResults');
|
||||||
|
if (known && known.term.trim().toLowerCase() === term.trim().toLowerCase()) {
|
||||||
|
var pick = bestItem(term, known.items);
|
||||||
|
if (pick) applyItem($input, pick);
|
||||||
|
$input.autocomplete('close');
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
$.getJSON($form.data('itemsUrl'), { q: term }).done(function (items) {
|
||||||
|
var pick = bestItem(term, items);
|
||||||
|
if (pick && $input.val() === term && !$row.find('.qbo-line-item-id').val()) applyItem($input, pick);
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
$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();
|
||||||
|
}
|
||||||
|
|
||||||
|
// ---- keyboard ----
|
||||||
|
// Tabbing into a line's description, quantity or rate selects what's there, so typing replaces it (a click
|
||||||
|
// still places the cursor)
|
||||||
|
var tabbedAt = 0;
|
||||||
|
$(document).on('keydown', function (event) { if (event.key === 'Tab') tabbedAt = Date.now(); });
|
||||||
|
// A click right after a Tab is still a click
|
||||||
|
$(document).on('mousedown touchstart', function () { tabbedAt = 0; });
|
||||||
|
$tbody.on('focus', '.qbo-line-description-input, .qbo-line-qty-input, .qbo-line-rate-input', function () {
|
||||||
|
if (Date.now() - tabbedAt > 500) return;
|
||||||
|
// Right away, so the first key typed already replaces the text; and again once the browser has placed
|
||||||
|
// its cursor (a textarea, the description, puts it back at the start), unless typing has begun
|
||||||
|
var box = this, before = box.value;
|
||||||
|
$(box).data('qboTabbedValue', before);
|
||||||
|
box.select();
|
||||||
|
setTimeout(function () { if (document.activeElement === box && box.value === before) box.select(); }, 0);
|
||||||
|
});
|
||||||
|
// Some browsers (Safari, Firefox) place the cursor after that; the Tab key's release arrives here once they
|
||||||
|
// have, so select again if nothing was typed yet
|
||||||
|
$tbody.on('keyup', '.qbo-line-description-input, .qbo-line-qty-input, .qbo-line-rate-input', function (event) {
|
||||||
|
if (event.key !== 'Tab') return;
|
||||||
|
var tabbed = $(this).data('qboTabbedValue');
|
||||||
|
$(this).removeData('qboTabbedValue');
|
||||||
|
if (tabbed !== undefined && this.value === tabbed) this.select();
|
||||||
|
});
|
||||||
|
|
||||||
|
// ---- 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 (or math, e.g. 300*1.1, rounded to the penny) 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;
|
||||||
|
if (isMath($(this).val().replace(/[$,\s]/g, ''))) amount = round(amount, 2);
|
||||||
|
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');
|
||||||
|
// Math in the rate box is rounded to the nearest penny
|
||||||
|
if (isRate && isMath(this.value.replace(/[$,\s]/g, ''))) n = round(n, 2);
|
||||||
|
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 () {
|
||||||
|
function clearLines() {
|
||||||
|
rows().remove();
|
||||||
|
addRow(); addRow();
|
||||||
|
changed();
|
||||||
|
}
|
||||||
|
// redmine_dark_mode asks in a dark dialog on dark pages; otherwise the browser's own box
|
||||||
|
var message = $(this).data('confirmText');
|
||||||
|
if (window.RedmineDarkMode && window.RedmineDarkMode.confirm) {
|
||||||
|
window.RedmineDarkMode.confirm(message, clearLines);
|
||||||
|
} else if (window.confirm(message)) {
|
||||||
|
clearLines();
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
// Drag lines by the handle to reorder them; they're saved in table order
|
||||||
|
$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 loadedEmail = $email.val();
|
||||||
|
|
||||||
|
$('#customer_id').on('change', function () {
|
||||||
|
var id = $(this).val();
|
||||||
|
if (!id) return;
|
||||||
|
dirty = true;
|
||||||
|
$.getJSON($form.data('customerInfoUrl'), { customer_id: id, document: $form.data('document') }).done(function (info) {
|
||||||
|
// A new invoice's open issues notice follows the customer
|
||||||
|
if (info.open_issues_html !== undefined) $('#qbo-open-issues').replaceWith(info.open_issues_html);
|
||||||
|
// Replace the email only if it was the previous customer's (or empty)
|
||||||
|
if (!$email.val().trim() || $email.val() === loadedEmail) $email.val(info.email || '');
|
||||||
|
loadedEmail = info.email || '';
|
||||||
|
$('#qbo-estimate-address').text(info.billing_address || '');
|
||||||
|
|
||||||
|
// Plugins' suggestions for this customer go in the custom field boxes' lists; the boxes themselves
|
||||||
|
// stay as they are (a new document starts blank)
|
||||||
|
$form.find('.qbo-field-custom').each(function () {
|
||||||
|
var fieldId = $(this).data('qboFieldId');
|
||||||
|
window.qboEditor.setFieldOptions(fieldId, (info.field_options || {})[String(fieldId)]);
|
||||||
|
});
|
||||||
|
$form.trigger('qbo:customer-changed', [{ customer_id: id, info: info }]);
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
// Clearing the customer name clears the customer
|
||||||
|
$('#qbo_estimate_customer_name').on('input', function () {
|
||||||
|
if (!this.value.trim()) $('#customer_id').val('');
|
||||||
|
});
|
||||||
|
|
||||||
|
// 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;
|
||||||
|
};
|
||||||
|
|
||||||
|
// Pairs imported time with the invoice lines ticked under "Replace these lines": first by description,
|
||||||
|
// since issues created from an estimate take the line's description as their subject and the time names
|
||||||
|
// it ("Install #134: Install Lift Kit" <-> "Install Lift Kit"); what's left is paired in order.
|
||||||
|
// Returns { pairs: [{ time, line }], extraTimes: [...], extraLines: [...] }.
|
||||||
|
var pairTimeWithLines = function (times, lines) {
|
||||||
|
var norm = function (text) { return String(text || '').split('\n')[0].toLowerCase().replace(/\s+/g, ' ').trim(); };
|
||||||
|
var subject = function (activity) { return norm(String(activity.description || '').replace(/^[^\n]*?#\d+:\s*/, '')); };
|
||||||
|
var lineText = function (line) { return norm($(line).find('.qbo-line-description-input').val()); };
|
||||||
|
var freeTimes = times.slice(), freeLines = [], pairs = [];
|
||||||
|
lines.forEach(function (line) {
|
||||||
|
var text = lineText(line);
|
||||||
|
var i = text ? freeTimes.findIndex(function (t) { return subject(t) === text; }) : -1;
|
||||||
|
if (i >= 0) { pairs.push({ time: freeTimes[i], line: line }); freeTimes.splice(i, 1); } else { freeLines.push(line); }
|
||||||
|
});
|
||||||
|
while (freeTimes.length && freeLines.length) pairs.push({ time: freeTimes.shift(), line: freeLines.shift() });
|
||||||
|
return { pairs: pairs, extraTimes: freeTimes, extraLines: freeLines };
|
||||||
|
};
|
||||||
|
|
||||||
|
// Rows go after the last filled line, above the spare empty rows
|
||||||
|
var insertAfterFilled = function ($rows) {
|
||||||
|
var $filled = rows().filter(function () { return !rowIsBlank($(this)); });
|
||||||
|
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).
|
||||||
|
// Only lines with one of the labor products/services (plugin settings) are offered; if none are known,
|
||||||
|
// every line is.
|
||||||
|
var replaceable = ($form.data('laborItemIds') || []).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() };
|
||||||
|
|
||||||
|
// Each time entry replaces one ticked line, in that line's place (see pairTimeWithLines). Time left over
|
||||||
|
// goes after the last replaced line; ticked lines left over are removed (ticked means replace).
|
||||||
|
if (times.length) {
|
||||||
|
var ticked = $('#qbo-import-replace input:checked').map(function () { return $(this).data('row')[0]; }).get();
|
||||||
|
ticked = rows().get().filter(function (row) { return ticked.indexOf(row) >= 0; }); // table order
|
||||||
|
var pairing = pairTimeWithLines(times, ticked);
|
||||||
|
var timeRow = function (activity) { return makeRow($.extend({}, activity, { time_activity_id: activity.id })); };
|
||||||
|
var $last = $();
|
||||||
|
pairing.pairs.forEach(function (pair) {
|
||||||
|
var $row = timeRow(pair.time);
|
||||||
|
$(pair.line).replaceWith($row);
|
||||||
|
if (!$last.length || $row.index() > $last.index()) $last = $row;
|
||||||
|
});
|
||||||
|
pairing.extraLines.forEach(function (line) { $(line).remove(); });
|
||||||
|
if (pairing.extraTimes.length) {
|
||||||
|
var $extra = $(pairing.extraTimes.map(function (activity) { return timeRow(activity)[0]; }));
|
||||||
|
if ($last.length) { $last.after($extra); } else { insertAfterFilled($extra); }
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Each estimate's lines go right after the time for the same issue (e.g. lineitems' "Added from:
|
||||||
|
// 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));
|
||||||
|
});
|
||||||
|
$panel.prop('hidden', true);
|
||||||
|
// Plugins fill their custom fields from the work orders (e.g. redmine_qbo_vehicles: VIN and mileage)
|
||||||
|
$form.trigger('qbo:imported', [{ issue_ids: issueIds, estimates: estimates,
|
||||||
|
issue_values: (importData && importData.issue_values) || {} }]);
|
||||||
|
$('#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);
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
$discountValue.on('input', function () { dirty = true; recalc(); });
|
||||||
|
$discountType.on('change', function () { dirty = true; recalc(); });
|
||||||
|
// Math typed in the discount box (e.g. 1500-1250) is worked out, to the cent
|
||||||
|
function tidyDiscount() {
|
||||||
|
var text = String($discountValue.val() || '').replace(/[$,\s%]/g, '');
|
||||||
|
var value = parseNumber(text);
|
||||||
|
if (value !== null && !isNaN(value) && isMath(text)) $discountValue.val(plain(round(value, 2), 2));
|
||||||
|
}
|
||||||
|
$discountValue.on('blur', function () { tidyDiscount(); recalc(); });
|
||||||
|
|
||||||
|
// ---- saving ----
|
||||||
|
$form.on('input change', '.qbo-estimate-top input, .qbo-estimate-details input, .qbo-estimate-notes textarea', function () { dirty = true; });
|
||||||
|
|
||||||
|
// 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();
|
||||||
|
});
|
||||||
|
|
||||||
|
// Set once a save is on its way, so more clicks don't save (or send) it twice
|
||||||
|
var saving = false;
|
||||||
|
|
||||||
|
$form.on('submit', function (event) {
|
||||||
|
if (saving) { event.preventDefault(); return; }
|
||||||
|
var submitter = event.originalEvent && event.originalEvent.submitter;
|
||||||
|
if (submitter && submitter.id === 'qbo-estimate-save-and-send' && !$email.val().trim()) {
|
||||||
|
event.preventDefault();
|
||||||
|
window.alert($(submitter).data('needsEmailText'));
|
||||||
|
$email.trigger('focus');
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
// Math still in a box is worked out before saving
|
||||||
|
rows().each(function () { tidyNumbers($(this)); });
|
||||||
|
tidyDiscount();
|
||||||
|
dirty = false;
|
||||||
|
|
||||||
|
// After every submit handler has run (and the form's values are already taken, so disabling the buttons
|
||||||
|
// doesn't drop which one was clicked): unless one stopped the save, show it's saving and lock the buttons
|
||||||
|
setTimeout(function () {
|
||||||
|
var stopped = event.originalEvent ? event.originalEvent.defaultPrevented : event.isDefaultPrevented();
|
||||||
|
if (stopped) return;
|
||||||
|
saving = true;
|
||||||
|
showSaving(submitter);
|
||||||
|
}, 0);
|
||||||
|
});
|
||||||
|
|
||||||
|
function showSaving(submitter) {
|
||||||
|
var $bar = $form.find('.qbo-estimate-actions');
|
||||||
|
var $clicked = submitter ? $(submitter) : $bar.find('input[type=submit][name=save]');
|
||||||
|
var text = $clicked.data('savingText') || $bar.data('savingText');
|
||||||
|
|
||||||
|
$bar.addClass('qbo-saving');
|
||||||
|
$bar.find('input[type=submit]').prop('disabled', true);
|
||||||
|
$bar.find('a.qbo-button').addClass('qbo-button-disabled').attr('aria-disabled', 'true');
|
||||||
|
$bar.find('.qbo-saving-status').text(text).prop('hidden', false);
|
||||||
|
}
|
||||||
|
|
||||||
|
// Coming back with the browser's Back button can show the page as it was left, still "saving"
|
||||||
|
window.addEventListener('pageshow', function (event) {
|
||||||
|
if (!event.persisted || !saving) return;
|
||||||
|
saving = false;
|
||||||
|
var $bar = $form.find('.qbo-estimate-actions');
|
||||||
|
$bar.removeClass('qbo-saving');
|
||||||
|
$bar.find('input[type=submit]').prop('disabled', false);
|
||||||
|
$bar.find('a.qbo-button').removeClass('qbo-button-disabled').removeAttr('aria-disabled');
|
||||||
|
$bar.find('.qbo-saving-status').prop('hidden', true);
|
||||||
|
});
|
||||||
|
|
||||||
|
window.addEventListener('beforeunload', function (event) {
|
||||||
|
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,17 @@
|
|||||||
|
<%# QuickBooks status badges: the estimate page's header and the estimate lists (customer and vehicle pages) %>
|
||||||
|
<style>
|
||||||
|
.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; }
|
||||||
|
.qbo-estimate-status-rejected { background: #fdecea; color: #b71c1c; }
|
||||||
|
.qbo-estimate-list .qbo-estimate-status { font-size: .8em; padding: 1px 7px; margin-left: 4px; }
|
||||||
|
/* Invoices (RedmineQboBilling::InvoiceStatus) */
|
||||||
|
.qbo-invoice-status-paid { background: #e6f4e4; color: #108000; }
|
||||||
|
.qbo-invoice-status-partial { background: #fff4d6; color: #8a6100; }
|
||||||
|
.qbo-invoice-status-overdue { background: #fdecea; color: #b71c1c; }
|
||||||
|
.qbo-invoice-status-open { background: #e8eefa; color: #0d47a1; }
|
||||||
|
.qbo-invoice-status-voided { background: #eceef1; color: #6b6c72; text-decoration: line-through; }
|
||||||
|
.qbo-invoice-list .qbo-estimate-status { font-size: .8em; padding: 1px 7px; margin-left: 4px; }
|
||||||
|
</style>
|
||||||
@@ -0,0 +1,176 @@
|
|||||||
|
<%# 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: .85; }
|
||||||
|
/* A locked document is still read here: browsers grey out disabled boxes' text (Safari nearly to nothing,
|
||||||
|
through -webkit-text-fill-color), so it's drawn in the normal text color */
|
||||||
|
.qbo-estimate-sheet[disabled] :is(input, textarea, select) { color: #393a3d; -webkit-text-fill-color: #393a3d; opacity: 1; }
|
||||||
|
/* ...but not hints in empty boxes, which would read as if they were filled in */
|
||||||
|
.qbo-estimate-sheet[disabled] :is(input, textarea)::placeholder { color: transparent; -webkit-text-fill-color: transparent; }
|
||||||
|
.qbo-estimate-sheet[disabled] .qbo-estimate-line-buttons, .qbo-estimate-sheet[disabled] .qbo-line-handle svg,
|
||||||
|
.qbo-estimate-sheet[disabled] .qbo-line-remove-button { display: none; }
|
||||||
|
.qbo-estimate-top { display: flex; justify-content: space-between; align-items: flex-start; gap: 24px; }
|
||||||
|
.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-custom input { width: 200px; }
|
||||||
|
.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-discount th { white-space: nowrap; }
|
||||||
|
.qbo-estimate-discount input { width: 5em; text-align: right; margin-left: 6px; }
|
||||||
|
.qbo-estimate-discount select { width: auto; }
|
||||||
|
.qbo-estimate-totals #qbo-estimate-tax.qbo-pending { color: var(--qbo-muted); font-style: italic; font-size: .9em; }
|
||||||
|
.qbo-estimate-totals .qbo-estimate-total th, .qbo-estimate-totals .qbo-estimate-total td { font-weight: 700; font-size: 1.15em; border-top: 1px solid #d4d7dc; padding-top: 10px; }
|
||||||
|
|
||||||
|
.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; }
|
||||||
|
|
||||||
|
/* While saving: the buttons are locked and a spinner says what's happening */
|
||||||
|
.qbo-estimate .qbo-saving .qbo-button[disabled],
|
||||||
|
.qbo-estimate .qbo-saving .qbo-button-disabled { opacity: .6; cursor: progress; pointer-events: none; }
|
||||||
|
.qbo-estimate .qbo-saving-status { display: inline-flex; align-items: center; gap: 8px; color: #fff; font-weight: 600; margin-right: 8px; }
|
||||||
|
.qbo-estimate .qbo-saving-status[hidden] { display: none; }
|
||||||
|
.qbo-estimate .qbo-saving-status::before { content: ""; width: 16px; height: 16px; border-radius: 50%; box-sizing: border-box;
|
||||||
|
border: 2px solid rgba(255,255,255,.35); border-top-color: #fff; animation: qbo-saving-spin .8s linear infinite; }
|
||||||
|
@keyframes qbo-saving-spin { to { transform: rotate(360deg); } }
|
||||||
|
@media (prefers-reduced-motion: reduce) { .qbo-estimate .qbo-saving-status::before { animation-duration: 2.4s; } }
|
||||||
|
.qbo-estimate .qbo-saving { cursor: progress; }
|
||||||
|
|
||||||
|
/* Warnings with a list (linked issues, invoices): the text, then one item per line */
|
||||||
|
div.warning.qbo-estimate-notice { text-align: left; }
|
||||||
|
div.warning.qbo-estimate-notice ul { margin: 6px 0 0; padding-left: 22px; }
|
||||||
|
div.warning.qbo-estimate-notice li { margin: 2px 0; }
|
||||||
|
.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>
|
||||||
|
<%= render partial: 'qbo_estimates/status_styles' %>
|
||||||