Skip to content

Commit

Permalink
[docs] add credit card
Browse files Browse the repository at this point in the history
  • Loading branch information
ananthakumaran committed Jan 27, 2024
1 parent 4bcf2cc commit 46b4820
Show file tree
Hide file tree
Showing 3 changed files with 53 additions and 0 deletions.
16 changes: 16 additions & 0 deletions docs/reference/config.md
Original file line number Diff line number Diff line change
Expand Up @@ -269,4 +269,20 @@ user_accounts:
password: sha256:a96dc73edd639b1c711b006e714bd2ff5bf5c1aecd77d0b3c3370403c66d58e5
# Required, password hashed twice with sha256, then prefixed sha256:
# echo -n 'secret' | sha256sum | head -c 64 | sha256sum | head -c 64

## List of credit cards
# OPTIONAL, DEFAULT: []
credit_cards:
- account: Liabilities:CreditCard:Freedom
# Required, account name
credit_limit: 150000
# Required, credit limit of the card
statement_end_day: 8
# Required, the day of the month when the statement is generated
due_day: 20
# Required, the day of the month when the payment is due
network: visa
# Required, the network of the card
number: "0007"
# Required, the last 4 digits of the card number
```
36 changes: 36 additions & 0 deletions docs/reference/credit-cards.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
---
description: "How to configure credit cards in Paisa"
---

# Credit Cards

Paisa allows you to track your credit card bills and payments. Let's
say you have a liability account called
`Liabilities:CreditCard:Freedom` to track your real world credit card,
you can configure it in Paisa as follows:

```yaml
credit_cards:
- account: Liabilities:CreditCard:Freedom #(1)!
credit_limit: 150000 #(2)!
statement_end_day: 8 #(3)!
due_day: 20 #(4)!
network: visa #(5)!
number: "0007" #(6)!
```
1. Account name
2. Credit limit of the card
3. The day of the month when the statement is generated
4. The day of the month when the payment is due
5. The network of the card
6. The last 4 digits of the card number
The above configuration can be done from the `More > Configuration`
page. Expand the `Credit Cards` section and click
:fontawesome-solid-circle-plus: icon to add a new one

Once configured, the credit card will show up on the `Liabilities >
Credit Cards` page. Paisa will automatically calculate and display
various information like the amount due, payment due date, credit
limit utilized, etc.
1 change: 1 addition & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@ nav:
- reference/ledger-cli.md
- reference/editor.md
- reference/user-authentication.md
- reference/credit-cards.md
- reference/analysis.md
- 'Tax':
- reference/tax/index.md
Expand Down

0 comments on commit 46b4820

Please sign in to comment.