settle_up
Record a payment between users to settle debts in Splitwise by specifying payer, recipient, amount, and currency.
Instructions
Record a payment from one user to another, settling part of their balance.
Exactly one of from_user_id/from_user_name and one of to_user_id/ to_user_name must be given for each side, resolved against the settling group's members (if group_id/group_name given) or against the authenticated user plus their friends.
Splitwise represents a cash payment as an expense with a payment
flag so its UI shows a distinct "paid" icon rather than a shared
cost; SplitwiseClient.create_expense does not expose that flag, so
this records the settlement as an ordinary expense where from_user_id
owes nothing and paid the full amount while to_user_id owes the full
amount and paid nothing. The balance effect is identical to a true
payment, but Splitwise's UI will display it like a regular expense.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| date | No | Date the payment occurred. Defaults to now. A value with no timezone is treated as UTC. | |
| amount | Yes | Amount being paid. | |
| group_id | No | Id of the group this payment settles within. | |
| group_name | No | Name (or partial name) of the group this payment settles within. | |
| to_user_id | No | Id of the user receiving the payment. | |
| from_user_id | No | Id of the user making the payment. | |
| to_user_name | No | Name (or partial name) of the user receiving the payment. | |
| currency_code | Yes | ISO 4217 currency code, e.g. 'USD'. | |
| from_user_name | No | Name (or partial name) of the user making the payment. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | Splitwise's numeric id for this expense. | |
| cost | Yes | Total cost of the expense, in currency_code units. | |
| date | Yes | Date and time the expense occurred. | |
| splits | No | Per-participant owed and paid shares for this expense. | |
| deleted | No | Whether this expense has been soft-deleted in Splitwise. | |
| category | No | Category assigned to this expense, if any. | |
| group_id | No | Id of the group this expense belongs to, if any. | |
| description | Yes | Short human-readable description of the expense. | |
| currency_code | Yes | ISO 4217 currency code the cost is denominated in. |