Rewrite Accounting documentation to explain Reporting (#1336)

btcpayserver · Oct 1, 2023 · ac4092d · ac4092d
1 parent 62fef31
commit ac4092d
Show file tree

Hide file tree

Showing 6 changed files with 16 additions and 47 deletions.
diff --git a/docs/.vuepress/config.js b/docs/.vuepress/config.js
@@ -85,7 +85,7 @@ const sidebarUserGuide = [
         children: [['/AdvancedForms', 'Advanced Forms']]
       },
       ['/Apps', 'Apps'],
-      ['/Accounting', 'Accounting'],
+      ['/Reporting', 'Reporting'],
       {
         title: 'Payjoin',
         path: '/Payjoin',

diff --git a/docs/.vuepress/redirects.js b/docs/.vuepress/redirects.js
@@ -103,7 +103,8 @@ module.exports = [
   { path: '/features/wallet', redirect: '/Wallet/' },
   { path: '/features/invoices', redirect: '/Invoices/' },
   { path: '/features/lightningnetwork', redirect: '/LightningNetwork/' },
-  { path: '/features/accounting', redirect: '/Accounting/' },
+  { path: '/features/accounting', redirect: '/Reporting/' },
+  { path: '/Accounting', redirect: '/Reporting/' },
   { path: '/features/paymentrequests', redirect: '/PaymentRequests/' },
   { path: '/features/vault', redirect: '/HardwareWalletIntegration/' },
   { path: '/Vault', redirect: '/HardwareWalletIntegration/' },

diff --git a/docs/Accounting.md b/docs/Accounting.md
diff --git a/docs/Invoices.md b/docs/Invoices.md
@@ -61,7 +61,7 @@ Invoices can be filtered via the quick filters located next to the search button
 
 ### Invoice export
 
-BTCPay Server Invoices can be exported in CSV or JSON format. For more information about invoice export and accounting, [see this page](./Accounting.md).
+BTCPay Server Invoices can be exported in CSV or JSON format. For more information about invoice export and accounting, [see this page](./Reporting.md).
 
 ## Refunding an invoice
 

diff --git a/docs/Reporting.md b/docs/Reporting.md
@@ -0,0 +1,12 @@
+# Reporting in BTCPay
+
+BTCPay Server offers several tools that make **cryptocurrency bookkeeping** easier.
+Reporting will allow you to visualize and export CSV data of your store.
+
+A report consist of table of tabular data along with some useful aggregates.
+
+You can find the following reports:
+
+* On-Chain Wallets: Each line show you the on-chain transactions affecting your wallet.
+* Products Sold: Each line represents a quantity of item sold. This is useful if you are using Point of Sale or Crowdfunding.
+* Payments: Each line represents an accounted payment to an invoice.
diff --git a/docs/img/invoice/invoice-export.jpg b/docs/img/invoice/invoice-export.jpg