groups.delete
Delete an existing group. Destroys all associated records (expenses, etc.)
groups.restore
Restores a deleted group.
**Note**: 200 OK does not indicate a successful response. You must check the `success` value of the response.
groups.add_user
**Note**: 200 OK does not indicate a successful response. You must check the `success` value of the response.
groups.remove_user
Remove a user from a group. Does not succeed if the user has a non-zero balance.
**Note:** 200 OK does not indicate a successful response. You must check the success value of the response.
friends.list
**Note**: `group` objects only include group balances with that friend.
friends.get
Returns details about a single friendship including balances by currency and any pending expenses with that friend.
friends.create
Adds a friend. If the other user does not exist, you must supply `user_first_name`.
If the other user exists, `user_first_name` and `user_last_name` will be ignored.
friends.create_batch
Add multiple friends at once.
For each user, if the other user does not exist, you must supply `users__{index}__first_name`.
**Note**: user parameters must be flattened into the format `users__{index}__{property}`, where
`property` is `first_name`, `last_name`, or `email`.
friends.delete
Given a friend ID, break off the friendship between the current user and the specified user.
**Note**: 200 OK does not indicate a successful response. You must check the `success` value of the response.
reference.currencies
Returns a list of all currencies allowed by the system. These are mostly ISO 4217 codes, but we do
sometimes use pending codes or unofficial, colloquial codes (like BTC instead of XBT for Bitcoin).
expenses.get
Returns full details for a single expense by id: payers, splits, shares, comments count, group, and audit metadata.
expenses.list
List expenses visible to the authenticated user. Supports filters: group_id, friend_id, dated_after, dated_before, updated_after, updated_before, limit, offset.
expenses.create
Creates an expense. You may either split an expense equally (only with `group_id` provided),
or supply a list of shares.
When splitting equally, the authenticated user is assumed to be the payer.
When providing a list of shares, each share must include `paid_share` and `owed_share`, and must be identified by one of the following:
- `email`, `first_name`, and `last_name`
- `user_id`
**Note**: 200 OK does not indicate a successful response. The operation was successful only if `errors` is empty.
expenses.update
Updates an expense. Parameters are the same as in `create_expense`, but you only need to include parameters
that are changing from the previous values. If any values is supplied for `users__{index}__{property}`, _all_
shares for the expense will be overwritten with the provided values.
**Note**: 200 OK does not indicate a successful response. The operation was successful only if `errors` is empty.
expenses.delete
**Note**: 200 OK does not indicate a successful response. The operation was successful only if `success` is true.
expenses.restore
**Note**: 200 OK does not indicate a successful response. The operation was successful only if `success` is true.
comments.list
Returns the comments on a given expense. `expense_id` is required.
comments.create
Add a comment to an existing expense by expense_id.
comments.delete
Deletes a comment. Returns the deleted comment.
notifications.list
Return a list of recent activity on the users account with the most recent items first.
`content` will be suitable for display in HTML and uses only the `<strong>`, `<strike>`, `<small>`,
`<br>` and `<font color="#FFEE44">` tags.
The `type` value indicates what the notification is about. Notification types may be added in the future
without warning. Below is an incomplete list of notification types.
| Type | Meaning |
| ---- | ------- |
| 0 | Expense added |
| 1 | Expense updated |
| 2 | Expense deleted |
| 3 | Comment added |
| 4 | Added to group |
| 5 | Removed from group |
| 6 | Group deleted |
| 7 | Group settings changed |
| 8 | Added as friend |
| 9 | Removed as friend |
| 10 | News (a URL should be included) |
| 11 | Debt simplification |
| 12 | Group undeleted |
| 13 | Expense undeleted |
| 14 | Group currency conversion |
| 15 | Friend currency conversion |
**Note**: While all parameters are optional, the server sets arbitrary (but large) limits
on the number of
reference.categories
Returns a list of all categories Splitwise allows for expenses. There are parent categories that represent groups of categories with subcategories for more specific categorization.
When creating expenses, you must use a subcategory, not a parent category.
If you intend for an expense to be represented by the parent category and nothing more specific, please use the "Other" subcategory.