Lifous

Finance

The finance endpoints of the Lifous API.

A * marks a required field. Path fields go in the address, query fields after a ?, body fields in JSON.

GET/api/v1/finance/overview

Your Money Overview

What the Money Overview page shows for a period: balances, income, spending, the savings rate, the budget in force, your goals, and recent and upcoming entries. Amounts are whole minor units (1250 is 12.50). `setUp: false` until Finance has been set up on the website.

FieldInTypeMeaning
rangequeryweek | month | lastMonth | 3months | year | customThe period. month when omitted; custom needs from and to.
fromqueryYYYY-MM-DDFirst day, with custom.
toqueryYYYY-MM-DDLast day, with custom.
timezonequeryIANA zoneWhich calendar day "today" is. Your account’s zone when omitted.

MCP tool: finance_overview

GET/api/v1/finance/accounts

Your accounts

Every account with its type, currency and balance today, archived ones included. A balance is whole minor units of the account’s own currency.

MCP tool: list_finance_accounts

GET/api/v1/finance/categories

Your categories

Income and expense categories, one level of subcategories (`parentId`), archived ones included.

MCP tool: list_finance_categories

GET/api/v1/finance/transactions

Your entries

Income, expenses, transfers and refunds, newest first, 25 a page. A transfer is one entry holding both accounts and is neither income nor spending.

FieldInTypeMeaning
typequeryincome | expense | transfer | refundOne kind only. Every kind when omitted.
accountIdqueryuuidEntries of one account.
categoryIdqueryuuidEntries of one category.
fromqueryYYYY-MM-DDFirst day.
toqueryYYYY-MM-DDLast day.
searchquerystringWords in the payee or note.
pagequeryintegerFrom 1. 1 when omitted.

MCP tool: list_finance_transactions

POST/api/v1/finance/transactions

Add an entry

Records income, an expense, a refund or a transfer in one of your accounts. `amountMinor` is always positive and in whole minor units of the account’s currency: 1250 for 12.50. The type gives the direction. A transfer needs `toAccountId`.

FieldInTypeMeaning
type *bodyincome | expense | transfer | refundWhat kind of entry.
accountId *bodyuuidThe account. For a transfer, the one the money leaves.
amountMinor *bodyintegerWhole minor units, positive: 1250 is 12.50.
categoryIdbodyuuidA category of the same kind. Never on a transfer.
toAccountIdbodyuuidA transfer’s destination account.
toAmountMinorbodyintegerWhat arrived, when the destination holds another currency.
datebodyYYYY-MM-DDToday when omitted. Never the future.
payeebodystringUp to 80 characters.
descriptionbodystringUp to 140 characters.
notesbodystringUp to 2,000 characters.
tagsbodystring[]Up to 10 short tags.
refundOfIdbodyuuidA refund’s original expense, when you know it.
timezonebodyIANA zoneWhich day today is. Your account’s zone when omitted.
Body
{ "type": "expense", "accountId": "…", "amountMinor": 1250, "payee": "Bakery" }

MCP tool: add_finance_transaction

GET/api/v1/finance/budgets

Your budgets

Every budget with its period and limits and, for a live one, where it stands now: spent, remaining, and an estimate for the period.

FieldInTypeMeaning
timezonequeryIANA zoneWhich calendar day "today" is. Your account’s zone when omitted.

MCP tool: list_finance_budgets

GET/api/v1/finance/goals

Your savings goals

Every savings goal with its target, what is set aside, the progress, and whether it is on track for its date.

FieldInTypeMeaning
timezonequeryIANA zoneWhich calendar day "today" is. Your account’s zone when omitted.

MCP tool: list_finance_goals