From 46b4820bce1f2a4cc328fd83ff1ad0c432d34824 Mon Sep 17 00:00:00 2001
From: Anantha Kumaran <ananthakumaran@gmail.com>
Date: Sat, 27 Jan 2024 12:09:27 +0530
Subject: [PATCH] [docs] add credit card

---
 docs/reference/config.md       | 16 +++++++++++++++
 docs/reference/credit-cards.md | 36 ++++++++++++++++++++++++++++++++++
 mkdocs.yml                     |  1 +
 3 files changed, 53 insertions(+)
 create mode 100644 docs/reference/credit-cards.md

diff --git a/docs/reference/config.md b/docs/reference/config.md
index bc1d02b4..68424838 100644
--- a/docs/reference/config.md
+++ b/docs/reference/config.md
@@ -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
 ```
diff --git a/docs/reference/credit-cards.md b/docs/reference/credit-cards.md
new file mode 100644
index 00000000..ca9127df
--- /dev/null
+++ b/docs/reference/credit-cards.md
@@ -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.
diff --git a/mkdocs.yml b/mkdocs.yml
index a89223f3..bef11583 100644
--- a/mkdocs.yml
+++ b/mkdocs.yml
@@ -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