Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions astro.config.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,7 @@ export default defineConfig({
'expenses/recurring',
'expenses/receipts',
'expenses/editing',
'expenses/search-and-totals',
],
},
{ label: 'Balances', items: ['balances', 'balances/settle-up'] },
Expand Down
2 changes: 1 addition & 1 deletion src/content/docs/expenses/currencies.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -50,4 +50,4 @@ Some currencies have no reference rate. They show **No rate yet** in the picker,
- The group currency is **Locked once money has been added**. See [Group settings](/groups/settings/#details).
- The balance on Home adds up groups that use your **Default currency**. Groups in other currencies are listed separately as **Plus balances in** those currencies, because Potluck does not convert balances between groups.

You can change your default currency on the [Me page](/account/#preferences). It only affects new groups and the Home summary.
You can change your default currency on the [Me page](/account/#preferences). It only affects new groups, the Home summary, and the currency [Spending](/expenses/search-and-totals/#everything-in-one-currency) converts into.
24 changes: 23 additions & 1 deletion src/content/docs/expenses/editing.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Editing and deleting
description: Fix an expense, see what changed, delete one, and bring it back with undo or restore.
description: Fix an expense, see what changed, delete one, and bring it back with undo, restore or Recently deleted.
---

import { Steps } from '@astrojs/starlight/components'
Expand Down Expand Up @@ -66,6 +66,28 @@ Missed it? Deleted expenses are not gone for good. If you open one later, for ex

You cannot edit a deleted expense until you restore it. If someone in the split has left the group since, it cannot be restored.

### Recently deleted

Each group keeps a list of what was taken out of it. Open the group's **Totals** tab and tap **Recently deleted** at the bottom.

It lists deleted expenses and payments, most recently deleted first. Each one shows the amount, the date it was from, and who deleted it and when, for example **Deleted by Ben 2 days ago**. Tap one to open it.

<Steps>

1. Find the expense or payment in **Recently deleted**.
2. Tap **Restore** next to it.

</Steps>

It goes back where it was, with its balances, and Potluck says so, for example **"Taco night" is back.** Nothing deleted yet? The list says **Nothing in the bin**.

You see **Restore** on the items you are allowed to bring back:

- **Expenses**: the person who added it, anyone who paid for it, and the group's owner and admins.
- **Payments**: the person who paid, the person who was paid, whoever recorded it, and the group's owner and admins. See [Restore a deleted payment](/balances/settle-up/#restore-a-deleted-payment).

In an [archived group](#archived-groups-are-read-only), the list is there to read, but nothing can be restored.

## Archived groups are read only

When a group is [archived](/groups/settings/#archive-a-group), its expenses stay there to look at, but nobody can change them. The expense page says **Supper club is archived, so its expenses can be read but not added or changed.** (with your group's name), and there is no **Edit**, **Delete** or **Restore**, and no new comments.
Expand Down
17 changes: 16 additions & 1 deletion src/content/docs/expenses/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,22 @@ The **Expenses** tab lists expenses and payments by day, newest first. Each line

[Refunds](#refunds) read the other way round: **you get back** or **you owe**.

Payments between people show as, for example, **Noor paid you $35.10**. Use **Search expenses** to find something by name, or tap a category chip to see only that kind of expense.
Payments between people show as, for example, **Noor paid you $35.10**. Use **Search expenses** to find something in this group, or tap a category chip to see only that kind of expense. To search every group at once, see [Search everything](/expenses/search-and-totals/#search-everything).

## Filter the list

Tap the filters button next to **Search expenses** to narrow the **Expenses** tab down. Pick as many as you like:

- **When**: **Any time**, **This month**, **Last month**, **This year**, or **Pick dates** for your own **From** and **To**.
- **Who**: one person, who paid or is in the split. Pick yourself to see only what you are part of.
- **Category**: one or more categories.
- **Type**: **Everything**, just **Expenses**, or just **Payments**.

The list updates as you pick. Each filter that is on shows as a chip above the list: tap a chip to remove it, or tap **Clear all** in the filters. The button shows how many filters are on.

While you filter, a line above the list adds it up, for example **12 expenses, $480.00 in all** and **Your share $120.00**. Payments have no category, so they are hidden while you filter by category.

Your filters are kept in the page address, so you can bookmark them or send the link to someone in the group. They also stay put while you move around the group: check **Balances** or **Totals**, come back to **Expenses**, and the same filters are still on.

## Expense details

Expand Down
96 changes: 96 additions & 0 deletions src/content/docs/expenses/search-and-totals.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,96 @@
---
title: Search and totals
description: Find any expense or payment across your groups, and see what you spent by month and category.
---

import { Steps } from '@astrojs/starlight/components'

Looking for that taco night from March? Wondering where all the money went this year? Search finds it, and Totals adds it up.

## Search everything

Search looks through every group you are in at once: expenses and payments, old and new.

### Open search

- On a computer, click **Search** in the menu on the left.
- On a phone, tap the search button at the top of **Home**, or **Search** on the **Groups** page.
- On a keyboard, press <kbd>/</kbd> from anywhere in Potluck, as long as you are not typing in a field. If you are already on Search, it jumps back to the search box and keeps what you typed.

### What it finds

Type a word, a name or an amount into **Search everything**. Potluck looks in:

- **Descriptions**, like "tacos" or "Uber".
- **Notes** on expenses and on payments.
- **Comments** on expenses and on payments.
- **People**: who paid, who was in the split, and who paid whom.
- **Amounts**, like 42.50.

Bits of words count too, so "taco" finds "Tacos al pastor". Results are grouped by group, newest first. When something matched for a reason other than its name, a line under it says why: **Comment:** with the words that matched, **In the notes**, **With Ben**, or **Amount matches**. Tap a result to open it. If there are more, tap **Show more** at the bottom.

:::note[Amounts with a comma or a dot]
Some countries write one thousand as 1,000 and others as 1.000. When you type an amount with three digits after the comma or dot, Potluck tries it both ways. So **1,000** finds a $1,000.00 expense, and **2.500** finds €2,500.00 as well as $2.50. It will not find a $1.00 expense for **1,000**, because dollars only have two decimal places.
:::

Deleted expenses and payments do not show up in search. To find those, use [Recently deleted](/expenses/editing/#recently-deleted).

### Filter the results

Tap the filters button next to the search box. Pick as many as you like, and the results update as you go:

- **When**: **Any time**, **This month**, **Last month**, **This year**, or **Pick dates** for your own **From** and **To**.
- **Who**: someone who paid, or is in the split.
- **Category**: one or more, like Food and Drinks.
- **Group**: one group, or **All groups**.
- **Type**: **Everything**, just **Expenses**, or just **Payments**. Payments have no category, so the category filter hides while you look at payments.

Each filter that is on shows as a chip under the search box. Tap a chip to remove it, or open the filters and tap **Clear all**. You do not need to type anything: filters on their own work too, for example every Lodging expense from last year.

What you searched for is part of the page address, so you can bookmark a search or come back to it with the back button.

## Totals and charts

Totals shows what you spent, what you paid and where it went, by month and by category. There are two places to see it.

### A group's Totals tab

In a group (or a one-on-one tab with a friend), open the **Totals** tab.

At the top, choose a period: **Month**, **Year** or **All time**. Use the arrows (**Earlier** and **Later**) to step through months or years.

The big number is **Your share**: your part of everything bought in that period. Under it:

- **Total group spending**: what the whole group spent.
- **You paid for**: what you paid, including other people's shares.
- **Payments you made** and **Payments you received**: money that changed hands to settle up.
- **Change in your balance**: whether that period moved your balance **up**, **down**, or made **no change**.

The totals match the **Balances** tab to the cent, refunds and several payers included.

At the bottom of the tab are two links: **Group activity**, for who added, changed and paid what, and [Recently deleted](/expenses/editing/#recently-deleted).

### Spending across all your groups

For everything at once, open **Spending**: tap **Spending** on the **Groups** page, or the **Spending** row on **Home**. It has the same period, totals and charts, plus a **By group** chart. Tap a group there to open its Totals tab.

### The charts

- **By month** shows a column for each month. Use **Show** to switch between **Your share** and **Everyone** (what the whole group spent). The other charts follow the same choice. Tap a month to see its totals.
- **By category** lists each category with its amount and its part of the total, largest first.
- **By group** (on Spending only) does the same for your groups.

Prefer numbers? Tap **Show as a table** under the month chart to see every month and its amount in a list. The category and group charts already print every amount. You can also move through the bars with the keyboard.

### Everything in one currency

Each group keeps its own currency. If your groups use more than one, or one that is not your own, the **Show** menu on Spending lets you choose how to see them:

- **Everything in** your currency, for example **Everything in USD**. Potluck converts each expense and payment at the exchange rate on its own date, the same rates it uses when you save an expense in another currency. This is the view you start with. The currency is your **Default currency** from the [Me page](/account/#preferences).
- **USD groups only**, **EUR groups only** and so on: just the groups in that currency, with nothing converted.

If Potluck has no exchange rate for something, it leaves it out instead of guessing, and says so by name. For example: **2 items have no exchange rate yet, so they are left out: Ski trip (CHF).** Once a rate is available, they are added in. When two currencies have no direct rate, Potluck goes through US dollars or euros to find one.

:::note[Good to know]
A converted total can be a cent off from adding up the converted pieces yourself, because each amount is rounded on its own. Balances are never converted: they always stay in each group's own currency. See [Currencies](/expenses/currencies/).
:::
16 changes: 14 additions & 2 deletions src/content/docs/friends.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Friends
description: Who shows up as a friend, what you owe each other across groups, settling up with a friend in one go, and keeping a one-on-one tab outside any group.
description: Who shows up as a friend, what you owe each other across groups, settling up with a friend in one go, your activity together, and keeping a one-on-one tab outside any group.
---

import { Steps } from '@astrojs/starlight/components'
Expand Down Expand Up @@ -52,12 +52,24 @@ Not everything belongs in a group. Coffee with a roommate, a concert ticket for

</Steps>

A one-on-one tab has only **Expenses** and **Balances**. There are no plans, invite links or roles to manage. You settle up the same way as in a group: see [Recording a payment](/balances/settle-up/).
A one-on-one tab has only **Expenses**, **Balances** and **Totals** (see [Totals and charts](/expenses/search-and-totals/#totals-and-charts)). There are no plans, invite links or roles to manage. You settle up the same way as in a group: see [Recording a payment](/balances/settle-up/).

:::note[Good to know]
A one-on-one tab is separate from the groups you share. Money you owe someone in a group stays in that group, and money on your one-on-one tab stays there. The total on **Friends** adds them up, and [Settle up with a friend](#settle-up-with-a-friend) pays each one separately.
:::

## Activity with a friend

Want to see everything you and one friend have been up to? Open your one-on-one tab (tap them on **Friends**) and tap **Activity with** their name, under what you owe each other.

The activity feed opens with only what involves both of you, across every group you share:

- Expenses you both paid for or are both in, and comments on them.
- Payments between the two of you, and comments on those.
- Everything on your one-on-one tab.

A chip at the top says **You and** their name. Tap **Show all activity** to go back to the full feed.

## Add a friend

Tap **Add a friend** and pick one of your groups under **Invite them to**. Potluck makes a one-use invite link for that group that lasts a week, and opens your share sheet so you can send it. When they join, they appear on your Friends list.
Expand Down
5 changes: 3 additions & 2 deletions src/content/docs/groups/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -53,16 +53,17 @@ The tabs underneath:

| Tab | What is there |
| --- | --- |
| **Expenses** | Every expense and payment, newest first. Search, filter by category, or download a CSV. [Repeating expenses](/expenses/recurring/) sit at the top. |
| **Expenses** | Every expense and payment, newest first. Search, [filter](/expenses/#filter-the-list) by person, date, category or type, or download a CSV. [Repeating expenses](/expenses/recurring/) sit at the top. |
| **Balances** | Who owes whom, and the **Settle up** button. See [Balances](/balances/). |
| **Totals** | What the group spent and your share, by month and category, plus **Recently deleted**. See [Totals and charts](/expenses/search-and-totals/#totals-and-charts). |
| **Plans** | The group's open polls and what is on the calendar. See [Plans](/plans/). |
| **Members** | Everyone in the group, their role and their balance. See [Roles](/groups/roles/). |
| **Settings** | Name, emoji, color, currency, house rules, default split, archive, leave and delete. See [Group settings](/groups/settings/). |

On a phone the tabs scroll sideways, so swipe left to reach **Members** and **Settings**.

:::note[Good to know]
A one-on-one tab with a friend works like a small group with only **Expenses** and **Balances**. See [Friends](/friends/).
A one-on-one tab with a friend works like a small group with only **Expenses**, **Balances** and **Totals**. See [Friends](/friends/).
:::

## Download a group's expenses
Expand Down
Loading