You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: README.md
+1-1
Original file line number
Diff line number
Diff line change
@@ -18,7 +18,7 @@ Pull requests are welcome and appreciated. To contribute to BTCPay Server, first
18
18
19
19
If you're beginner, take a look at the step by step guide on how to contribute to BTCPay Server documentation below.
20
20
21
-
[](https://www.youtube.com/watch?v=bSDROcdSSWw"How BTCPay Server Works")
21
+
[](https://www.youtube.com/watch?v=bSDROcdSSWw'How BTCPay Server Works')
Copy file name to clipboardexpand all lines: docs/Accounting.md
+28-28
Original file line number
Diff line number
Diff line change
@@ -4,41 +4,41 @@ BTCPay Server offers several tools that make **cryptocurrency bookkeeping** easi
4
4
5
5
## Invoice Export
6
6
7
-
![Invoice exporting in BTCPay Server](./img/invoice/invoice-export.jpg"Invoice exporting in BTCPay Server")
7
+
8
8
9
9
To export the **invoices**, go to Invoices > Export invoices, select the export format (CSV/JSON) and download the file. You can then customize the fields to fit your **business needs** and import the data into your **accounting software**, or create pivot tables from the exported data.
10
10
11
11
The fields are the following:
12
12
13
-
| Field name |Description |
14
-
|:-:|---|
15
-
| ReceivedDate | Date the payment has been received |
16
-
| StoreId |The store receiving the payment |
17
-
| OrderId | The order Id of the invoice |
18
-
| InvoiceId | The invoice ID |
19
-
| InvoiceCreatedDate | Date of creation of the invoice |
20
-
| InvoiceExpirationDate | Date of expiration of the invoice |
21
-
| InvoiceMonitoringDate | Date your BTCPay Server ceases to monitor events of the invoice |
22
-
| PaymentId | Unique identifier of a payment |
23
-
| Destination | The destination address the customer paid to |
24
-
| PaymentType | The type of payment (`OnChain`, `Offchain`) |
25
-
| CryptoCode | Currency code of the method of payment (e.g. `BTC`) |
26
-
| Paid | Amount paid in the currency defined in CryptoCode |
27
-
| NetworkFee |[Network fee](./FAQ/Stores.md#add-network-fee-to-invoice-vary-with-mining-fees) paid by the user in this payment |
28
-
| ConversionRate | The conversion rate at the time of invoice creation between `CryptoCode` and `InvoiceCurrency`|
29
-
| PaidCurrency | Amount paid, denominated in `InvoiceCurrency`|
30
-
| InvoiceCurrency | The currency code of the invoice (e.g. `USD`) |
31
-
| InvoiceDue | The amount still due to fully pay the invoice after this payment (minus `NetworkFee`, denominated in `InvoiceCurrency`) |
32
-
| InvoicePrice | The total price of the invoice (minus Network Fee, denominated in `InvoiceCurrency`) |
33
-
| InvoiceItemCode | The item code afferent to the products/services billed by the invoice |
34
-
| InvoiceItemDesc | The item description afferent to the products/services billed by the invoice |
35
-
| InvoiceFullStatus | The full status of the invoice (e.g. `expired (paidPartial)`) |
36
-
| InvoiceStatus | The simplified status of the invoice (e.g. `expired`) |
37
-
| InvoiceException | The status of the invoice (e.g. `paidPartial`) |
|ReceivedDate | Date the payment has been received|
16
+
|StoreId |The store receiving the payment|
17
+
|OrderId | The order Id of the invoice|
18
+
|InvoiceId | The invoice ID|
19
+
|InvoiceCreatedDate | Date of creation of the invoice|
20
+
| InvoiceExpirationDate | Date of expiration of the invoice|
21
+
| InvoiceMonitoringDate | Date your BTCPay Server ceases to monitor events of the invoice|
22
+
|PaymentId | Unique identifier of a payment|
23
+
|Destination | The destination address the customer paid to|
24
+
|PaymentType | The type of payment (`OnChain`, `Offchain`)|
25
+
|CryptoCode | Currency code of the method of payment (e.g. `BTC`)|
26
+
|Paid | Amount paid in the currency defined in CryptoCode|
27
+
|NetworkFee |[Network fee](./FAQ/Stores.md#add-network-fee-to-invoice-vary-with-mining-fees) paid by the user in this payment|
28
+
|ConversionRate | The conversion rate at the time of invoice creation between `CryptoCode` and `InvoiceCurrency`|
29
+
|PaidCurrency | Amount paid, denominated in `InvoiceCurrency`|
30
+
|InvoiceCurrency | The currency code of the invoice (e.g. `USD`)|
31
+
|InvoiceDue| The amount still due to fully pay the invoice after this payment (minus `NetworkFee`, denominated in `InvoiceCurrency`) |
32
+
|InvoicePrice | The total price of the invoice (minus Network Fee, denominated in `InvoiceCurrency`)|
33
+
|InvoiceItemCode | The item code afferent to the products/services billed by the invoice|
34
+
|InvoiceItemDesc | The item description afferent to the products/services billed by the invoice|
35
+
|InvoiceFullStatus | The full status of the invoice (e.g. `expired (paidPartial)`)|
36
+
|InvoiceStatus | The simplified status of the invoice (e.g. `expired`)|
37
+
|InvoiceException | The status of the invoice (e.g. `paidPartial`)|
38
+
|BuyerEmail | The payer's email.|
39
39
40
40
## QuickBooks Online Connector for BTCPay Server
41
41
42
42
**BTCQBO** is a third-party plugin that **enables QuickBooks Online users to connect their BTCPay server** easily. Besides **bookkeeping**, users can quickly **generate invoices from their QuickBooks**. For more information about the BTCQBO and all the features it offers, [check the plugin repository](https://github.com/JeffVandrewJr/btcqbo) or watch the video below.
43
43
44
-
[](https://www.youtube.com/watch?v=srgwL9ozg6c"BTCPay Server QuickBooks")
44
+
[](https://www.youtube.com/watch?v=srgwL9ozg6c'BTCPay Server QuickBooks')
Copy file name to clipboardexpand all lines: docs/Apps.md
+16-14
Original file line number
Diff line number
Diff line change
@@ -1,12 +1,13 @@
1
1
---
2
2
description: Apps allow users an easy way to extend BTCPay Server.
3
3
tags:
4
-
- BTCPay Server
5
-
- Apps
6
-
- Point of Sale
7
-
- Crowdfunding
8
-
- Payment Button
4
+
- BTCPay Server
5
+
- Apps
6
+
- Point of Sale
7
+
- Crowdfunding
8
+
- Payment Button
9
9
---
10
+
10
11
# BTCPay Server Apps
11
12
12
13
The primary purpose of BTCPay Server is to remove dependencies on trusted third-parties. The Apps are built in applications that obsolete central-authorities and allow users an easy way to extend the [use case](./UseCase.md) of the software. Users can self-host all sorts of customizable applications that work out of the box.
@@ -17,16 +18,17 @@ To create an app, go to Apps > Create a new app. Apps are store-dependent, which
17
18
18
19
The **web-based PoS app** allows users with brick and mortar stores to readily **accept cryptocurrencies without fees or a third-party**, directly to their wallet. The **PoS** can be displayed easily on tablets or any other devices which support web browsing. Users can easily create a homescreen shortcut for a quick access to the web-app.
Adding new products is easy. The app has a **shopping cart feature**, **tips**, **product inventory**, **custom payment options** and more.
23
24
24
25
The **Point of sale app** can also be used to receive donations, tips or even as a small e-commerce shop, depending on the options or customizations applied.
25
26
26
27
Curently, the **Point of Sale app** supports three different views:
27
-
* A `Static` view representing only the items for sale.
28
-
* A `Cart` view including items for sale and a cart for checkout.
29
-
* A `Light` view consisting only of a keypad for easy and quick payments (Starting from [v1.0.5.6](https://blog.btcpayserver.org/btcpay-server-1-0-5-6/#simplePOS)).
28
+
29
+
- A `Static` view representing only the items for sale.
30
+
- A `Cart` view including items for sale and a cart for checkout.
31
+
- A `Light` view consisting only of a keypad for easy and quick payments (Starting from [v1.0.5.6](https://blog.btcpayserver.org/btcpay-server-1-0-5-6/#simplePOS)).
30
32
31
33
To get your first **Point of Sale app** running, follow theses few simple steps:
32
34
@@ -53,7 +55,7 @@ You can change the appearance of your **Point of Sale app** by following the [th
53
55
7. Click "Save Settings".
54
56
8. Click "View App" to view your Crowdfund (Contributors can access the crowdfund through that link).
55
57
56
-
[](https://www.youtube.com/watch?v=tFbfyneDj88"BTCPay Server Crowdfunding")
58
+
[](https://www.youtube.com/watch?v=tFbfyneDj88'BTCPay Server Crowdfunding')
57
59
58
60
If you would like to provide digital or physical products to the backers of your **crowdfunding campaign**, you can [integrate WooCommerce store into it](./FAQ/Apps.md#how-to-integrate-woocommerce-store-into-a-btcpay-crowdfund-app). You can also set limits on contribution perks using the inventory feature.
59
61
@@ -66,7 +68,7 @@ Easily-embeddable HTML and highly-customizable **payment buttons** allow users t
66
68
3. Customize your button.
67
69
4. Copy the generated form and embed it on your website.
68
70
69
-
[](https://www.youtube.com/watch?v=MIWGvl6_WzI"BTCPay Server Payment Button")
71
+
[](https://www.youtube.com/watch?v=MIWGvl6_WzI'BTCPay Server Payment Button')
70
72
71
73
## Lightning Network Apps (Lapps)
72
74
@@ -76,8 +78,8 @@ BTCPay exposes all the necessary information required to connect your internal *
76
78
77
79
Below are videos that showcase how to connect some of the lapps to BTCPay.
78
80
79
-
[](https://www.youtube.com/watch?v=6EHNq1anD1k"BTCPay Server - c-lightning and lapps intro")
81
+
[](https://www.youtube.com/watch?v=6EHNq1anD1k'BTCPay Server - c-lightning and lapps intro')
80
82
81
-
[](https://www.youtube.com/watch?v=ZbM3jcxau0o"BTCPay Server - c-lightning and lapps publisher")
83
+
[](https://www.youtube.com/watch?v=ZbM3jcxau0o'BTCPay Server - c-lightning and lapps publisher')
82
84
83
-
[](https://www.youtube.com/watch?v=EYrsU3LGpbI"BTCPay Server - c-lightning and lapps woo lightning")
85
+
[](https://www.youtube.com/watch?v=EYrsU3LGpbI'BTCPay Server - c-lightning and lapps woo lightning')
0 commit comments