README: invoices from Redmine, redmine_qbo 2026.11.21, full sync once

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
This commit is contained in:
rickyandClaude Opus 5.5 committed 2026-11-17 18:45:31 -05:00
1 parent ccc70171b4
commit 595e86ff02
1 file changed
+7 -5
+7 -5
View File
@@ -10,10 +10,10 @@ All the numbers can be changed in the settings.
## What counts as a sale ## What counts as a sale
* **Invoices paid in full in the month.** An invoice is paid in full on the later of its own date and the date of the last payment or credit memo applied to it. A deposit taken months before the work counts in the month the job was invoiced and the last of it paid. * **Invoices paid in full in the month.** An invoice is paid in full on the later of its own date and the date of the last payment or credit memo applied to it. A deposit taken months before the work counts in the month the job was invoiced and the last of it paid. These come from Redmine's own copy of the invoices: redmine_qbo keeps each invoice's sales tax and the day it was paid in full, up to date through QuickBooks' webhooks, so a month opens without reading its invoices from QuickBooks.
* **Sales receipts dated in the month** (counter sales paid on the spot). These can be turned off in the settings. * **Sales receipts dated in the month** (counter sales paid on the spot). These can be turned off in the settings.
Amounts are without sales tax. Voided transactions ($0) don't count. Amounts are without sales tax: the page shows each transaction's total, tax and the amount that counts. Voided transactions ($0) don't count.
## Deductions ## Deductions
@@ -24,16 +24,16 @@ Returns, canceled orders and refunded deposits are deducted from the month's sal
## Approving a month ## Approving a month
**Sales commission** in the top menu opens this month, so far. It shows the month's sales, how far they are from the threshold, the pool, and each rep's payout. QuickBooks is read at most every 15 minutes; **Read from QuickBooks** reads it again now. **Sales commission** in the top menu opens this month, so far. It shows the month's sales, how far they are from the threshold, the pool, and each rep's payout. The sales receipts, refund receipts and credit memos are read from QuickBooks, all three at once, and kept for 15 minutes. **Read from QuickBooks** brings everything up to date now: it syncs the invoices changed in QuickBooks since the last sync, and reads the receipts and credit memos again.
Once the month is over, **Approve for payroll** reads QuickBooks one last time. It records the sales, deductions, threshold, rates and payouts, so the month no longer changes with QuickBooks or the settings. **Payroll CSV** downloads each rep's payout. **Reopen** puts an approved month back to being worked out from QuickBooks; the unticked items, adjustments and notes are kept. Once the month is over, **Approve for payroll** does the same one last time. It records the sales, deductions, threshold, rates and payouts, so the month no longer changes with QuickBooks or the settings. **Payroll CSV** downloads each rep's payout. **Reopen** puts an approved month back to being worked out from QuickBooks; the unticked items, adjustments and notes are kept.
Approvers see each invoice linked to its page in Redmine (or its PDF without the Write invoices permission), each sales receipt, refund receipt and credit memo linked to QuickBooks' PDF of it (opened through Redmine, without signing in to QuickBooks), and the list of months with the month picker. Approvers see each invoice linked to its page in Redmine (or its PDF without the Write invoices permission), each sales receipt, refund receipt and credit memo linked to QuickBooks' PDF of it (opened through Redmine, without signing in to QuickBooks), and the list of months with the month picker.
## Requirements ## Requirements
* Redmine 7 * Redmine 7
* redmine_qbo 2026.11.0 or later, connected to QuickBooks Online * redmine_qbo 2026.11.21 or later, connected to QuickBooks Online, with its webhook set up (so invoices and payments stay up to date)
## Installation ## Installation
@@ -50,6 +50,8 @@ Restart Redmine, then:
2. **Administration » Plugins » Redmine QBO Commission plugin » Configure**: check the threshold, rates and what counts. 2. **Administration » Plugins » Redmine QBO Commission plugin » Configure**: check the threshold, rates and what counts.
3. **Administration » Roles and permissions**: give **Approve sales commission** to Management and Bookkeeping. Give **View sales commission** to the sales reps, so they can follow the month toward the threshold. Both are global permissions, so they apply to any role the user has in any project. 3. **Administration » Roles and permissions**: give **Approve sales commission** to Management and Bookkeeping. Give **View sales commission** to the sales reps, so they can follow the month toward the threshold. Both are global permissions, so they apply to any role the user has in any project.
After upgrading redmine_qbo to 2026.11.21, run a **Full sync** once (**Administration » Plugins » QuickBooks**), so invoices paid before the upgrade get the day they were paid in full. Until then, approvers see a warning on the month's page, and those invoices aren't counted.
**View sales commission** shows a month's sales, pool and payouts, read-only. It doesn't link to QuickBooks, list the months, change or approve a month, or download the payroll CSV. **View sales commission** shows a month's sales, pool and payouts, read-only. It doesn't link to QuickBooks, list the months, change or approve a month, or download the payroll CSV.
## Tests ## Tests