Monee Mate

Create a group for splitting shared expenses. Members are people from list-people; the user is added automatically.

create-group

Record an expense and its splits inside a private Monee Mate group the user owns or belongs to. Only existing group members may be included. This records a past payment; it does not send money, contact an external service, or invite anyone. The splits must add up to total_amount whatever the split_method says, so compute them explicitly. For "equal", divide evenly and put any rounding remainder on one member rather than letting the total drift. Naming an account changes the user's recorded account balance, which only makes sense when the payer is the user themselves.

create-group-expense

Record a repayment that already happened between existing members of a private Monee Mate group the user owns or belongs to. This only updates group records and does not send money or contact an external service. get-group reports the outstanding recorded balances.

create-group-settlement

Record money lent to, borrowed from, or repaid with a person. The four types are directional, so pick carefully: - "lent": the user gave them money and is now owed it. - "borrowed": the user received money and now owes it. - "payment_made": the user paid back something they owed. - "payment_received": they paid back something they owed the user. Naming an account changes its recorded balance. Leave it out to track the debt without changing an account balance. This does not send money or initiate a payment. A linked person also receives a mirrored record in their MoneeMate account.

create-people-transaction

Add a person to track money with. Giving an email invites them: if they already use MoneeMate the two accounts link and balances stay in sync on both sides, otherwise an invitation is sent. Adding someone without an email creates a local-only record, which is fine for tracking but never links. Sending an invitation emails a real person, so only pass an email the user gave you.

create-person

Record an expense, income or transfer. A transfer moves money between two of the user's own accounts: it needs to_account_id and takes no category. An expense or income needs a category. Set is_recurring to repeat it on a schedule.

create-transaction

Permanently delete an account together with every transaction recorded against it. This cannot be undone. Ask the user to confirm first, and suggest archive-account instead when they only want it out of the way.

delete-account

Delete a budget. Transactions in its category are untouched; only the monthly limit goes away. Ask the user to confirm first.

delete-budget

Permanently delete a category. This cannot be undone. Ask the user to confirm first, and suggest archive-category instead when they only want it hidden.

delete-category

Permanently delete a credit card together with every charge recorded on it. This cannot be undone. Ask the user to confirm first, and suggest archive-credit-card instead when they only want it hidden.

delete-credit-card

Permanently delete a credit card charge. Ask the user to confirm first. For a recurring charge, `action` decides whether one occurrence goes or the whole series.

delete-credit-card-transaction

Delete an exchange rate. Refused if any transaction still uses that currency. Ask the user to confirm first.

delete-currency-rate

Permanently delete an empty private Monee Mate group owned by the user, removing it for all its members. Groups with any recorded expenses or settlements cannot be deleted. This only deletes Monee Mate records and does not contact an external service. Ask the user to confirm first.

delete-group

Permanently delete a shared expense and its splits, which changes what every member of the group owes. Ask the user to confirm first.

delete-group-expense

Permanently delete a loan or repayment. If the person is a linked MoneeMate user, the mirrored record on their side goes too. Ask the user to confirm first.

delete-people-transaction

Permanently delete a person together with every loan and repayment recorded with them. If the two accounts were linked, the mirrored records on their side go too. Ask the user to confirm first.

delete-person

Delete a whole recurring series. Ask the user to confirm first, and be explicit about which of the two modes you are using, because they differ a lot: - "all": removes the series and every transaction it ever generated, including completed ones already reflected in account balances. - "pending": removes only the occurrences that have not been completed, leaving the historical record intact. This is usually what someone means by "cancel it".

delete-recurring-transaction

Permanently delete a transaction. Ask the user to confirm first. For a recurring row, `action` decides how much goes: only that occurrence, this one and everything after it, every occurrence, or all pending ones. Deleting a transfer removes both of its sides.

delete-transaction

Stop a recurring series from a given occurrence onwards, keeping everything before it. This is the gentle option: past occurrences and any transactions already completed stay untouched. Use delete-recurring-transaction to remove the series entirely.

end-recurring-transaction

Get the user's financial overview: balances, what is pending, what is coming up, and how the current month is going. Start here when asked a broad question about how their money looks.

get-dashboard

Get one group with its members, expenses, settlements and who currently owes whom. Member ids in this payload are the person ids the other group tools expect.

get-group

Summarise what every person owes the user and what the user owes each of them, including shared groups. A negative person balance means they owe the user; a positive one means the user owes them. The overall net is total owed to the user minus total the user owes.

get-people-balances

Get one person with their balance, including anything owed through shared groups. A negative person or total balance means they owe the user; a positive one means the user owes them. Individual group_balances use the opposite convention: positive means they owe the user.

get-person

Get the acting user's profile: their name, timezone and currency settings. Call this first when you need to know what "today" means for them or which currency the amounts are in.

get-profile

Total income and expenses per category over a date range, rolled up to the parent category. Transfers are excluded, since moving money between the user's own accounts is not spending. Use this for "where did my money go" questions instead of adding up list-transactions by hand.

get-spending-by-category

List the user's accounts with current, projected and reserved balances for a given month. Use it to discover account ids before creating transactions.

list-accounts

List monthly spending budgets with how much has been spent against each one. Budgets are per expense category and are evaluated a month at a time, so the same budget reports different numbers for different months. Only budgets whose period covers the requested month are listed, so a category can hold different limits over time. A budget marked `is_closed` was settled for that month and no longer reserves anything.

list-budgets

List the user's expense and income categories. Categories can nest one level: a child points at its parent through parent_id. Use it to discover category ids before creating transactions or budgets.

list-categories

List the charges on one credit card invoice. Get the invoice date from list-credit-cards (the current one) or list-past-invoices.

list-credit-card-transactions

List credit cards with their current invoice. An invoice is "open" while charges can still land on it, "closed" once the closing day passed and the total is fixed, and "paid" once settled from the linked account.

list-credit-cards

List the exchange rates the user has configured. A transaction can only be recorded in a currency that appears here or is one of their own two currencies.

list-currency-rates

List the shared expense groups the user owns or belongs to. Use it to discover group ids.

list-groups

List a credit card's past invoices, newest first, with their totals and whether they were paid.

list-past-invoices

List the people the user tracks money with, and what each one nets out to, including shared groups. A negative person balance means they owe the user; a positive one means the user owes them. Use it to discover person ids.

list-people

List the loans and repayments recorded with one person, plus the running balance including anything owed through shared groups.

list-people-transactions

List the recurring transaction series themselves — the rules, not the occurrences they generate. Use list-transactions to see the individual dated occurrences. A series with no end_date runs indefinitely.

list-recurring-transactions

List transactions in a date range. The listing blends real transactions with the projected occurrences of recurring ones, credit card charges, transfers and shared group expenses, exactly as the app shows them. Every row carries a `group_name` saying what it is. Pass that value, and `occurrence_number` when present, to update-transaction or delete-transaction: a row from "recurring_transactions" is a projection that does not exist as a stored record until it is edited, ignored, or completed. Each row includes is_ignored; ignored pending rows remain visible but do not affect balances. Use set-transaction-ignored to change only one pending row or occurrence.

list-transactions

Mark a credit card invoice as paid. This is when the charges finally leave the linked account, so it moves the money in the balances.

pay-invoice

Restore a previously archived account so it shows up in listings again.

restore-account

Restore a previously archived category.

restore-category