@firefly-iii-mcp/core
Version:
core modules for Firefly III MCP server
1,559 lines • 457 kB
JavaScript
// This file is auto-generated by scripts/generator.ts
export const generatedTools = [
{
"name": "get_accounts_ac",
"tags": [
"autocomplete"
],
"description": "Returns all accounts of the user returned in a basic auto-complete array.",
"inputSchema": {
"type": "object",
"properties": {
"query": {
"type": "string",
"description": "The autocomplete search query."
},
"limit": {
"type": "integer",
"format": "int32",
"description": "The number of items returned."
},
"date": {
"type": "string",
"description": "If the account is an asset account or a liability, the autocomplete will also return the balance of the account on this date."
},
"types": {
"type": "array",
"items": {
"type": "string",
"enum": [
"all",
"asset",
"cash",
"expense",
"revenue",
"special",
"hidden",
"liability",
"liabilities",
"Default account",
"Cash account",
"Asset account",
"Expense account",
"Revenue account",
"Initial balance account",
"Beneficiary account",
"Import account",
"Reconciliation account",
"Loan",
"Debt",
"Mortgage"
],
"description": "The type of accounts you wish to limit the search to."
},
"description": "Optional filter on the account type(s) used in the autocomplete."
}
}
},
"method": "get",
"pathTemplate": "/v1/autocomplete/accounts",
"executionParameters": [
{
"name": "query",
"in": "query"
},
{
"name": "limit",
"in": "query"
},
{
"name": "date",
"in": "query"
},
{
"name": "types",
"in": "query"
}
],
"operationId": "get_accounts_ac"
},
{
"name": "get_bills_ac",
"tags": [
"autocomplete"
],
"description": "Returns all bills of the user returned in a basic auto-complete array.",
"inputSchema": {
"type": "object",
"properties": {
"query": {
"type": "string",
"description": "The autocomplete search query."
},
"limit": {
"type": "integer",
"format": "int32",
"description": "The number of items returned."
}
}
},
"method": "get",
"pathTemplate": "/v1/autocomplete/bills",
"executionParameters": [
{
"name": "query",
"in": "query"
},
{
"name": "limit",
"in": "query"
}
],
"operationId": "get_bills_ac"
},
{
"name": "get_budgets_ac",
"tags": [
"autocomplete"
],
"description": "Returns all budgets of the user returned in a basic auto-complete array.",
"inputSchema": {
"type": "object",
"properties": {
"query": {
"type": "string",
"description": "The autocomplete search query."
},
"limit": {
"type": "integer",
"format": "int32",
"description": "The number of items returned."
}
}
},
"method": "get",
"pathTemplate": "/v1/autocomplete/budgets",
"executionParameters": [
{
"name": "query",
"in": "query"
},
{
"name": "limit",
"in": "query"
}
],
"operationId": "get_budgets_ac"
},
{
"name": "get_categories_ac",
"tags": [
"autocomplete"
],
"description": "Returns all categories of the user returned in a basic auto-complete array.",
"inputSchema": {
"type": "object",
"properties": {
"query": {
"type": "string",
"description": "The autocomplete search query."
},
"limit": {
"type": "integer",
"format": "int32",
"description": "The number of items returned."
}
}
},
"method": "get",
"pathTemplate": "/v1/autocomplete/categories",
"executionParameters": [
{
"name": "query",
"in": "query"
},
{
"name": "limit",
"in": "query"
}
],
"operationId": "get_categories_ac"
},
{
"name": "get_currencies_ac",
"tags": [
"autocomplete"
],
"description": "Returns all currencies of the user returned in a basic auto-complete array.",
"inputSchema": {
"type": "object",
"properties": {
"query": {
"type": "string",
"description": "The autocomplete search query."
},
"limit": {
"type": "integer",
"format": "int32",
"description": "The number of items returned."
}
}
},
"method": "get",
"pathTemplate": "/v1/autocomplete/currencies",
"executionParameters": [
{
"name": "query",
"in": "query"
},
{
"name": "limit",
"in": "query"
}
],
"operationId": "get_currencies_ac"
},
{
"name": "get_currencies_code_ac",
"tags": [
"autocomplete"
],
"description": "Returns all currencies of the user returned in a basic auto-complete array. This endpoint is DEPRECATED and I suggest you DO NOT use it.",
"inputSchema": {
"type": "object",
"properties": {
"query": {
"type": "string",
"description": "The autocomplete search query."
},
"limit": {
"type": "integer",
"format": "int32",
"description": "The number of items returned."
}
}
},
"method": "get",
"pathTemplate": "/v1/autocomplete/currencies-with-code",
"executionParameters": [
{
"name": "query",
"in": "query"
},
{
"name": "limit",
"in": "query"
}
],
"operationId": "get_currencies_code_ac"
},
{
"name": "get_object_groups_ac",
"tags": [
"autocomplete"
],
"description": "Returns all object groups of the user returned in a basic auto-complete array.",
"inputSchema": {
"type": "object",
"properties": {
"query": {
"type": "string",
"description": "The autocomplete search query."
},
"limit": {
"type": "integer",
"format": "int32",
"description": "The number of items returned."
}
}
},
"method": "get",
"pathTemplate": "/v1/autocomplete/object-groups",
"executionParameters": [
{
"name": "query",
"in": "query"
},
{
"name": "limit",
"in": "query"
}
],
"operationId": "get_object_groups_ac"
},
{
"name": "get_piggies_ac",
"tags": [
"autocomplete"
],
"description": "Returns all piggy banks of the user returned in a basic auto-complete array.",
"inputSchema": {
"type": "object",
"properties": {
"query": {
"type": "string",
"description": "The autocomplete search query."
},
"limit": {
"type": "integer",
"format": "int32",
"description": "The number of items returned."
}
}
},
"method": "get",
"pathTemplate": "/v1/autocomplete/piggy-banks",
"executionParameters": [
{
"name": "query",
"in": "query"
},
{
"name": "limit",
"in": "query"
}
],
"operationId": "get_piggies_ac"
},
{
"name": "get_piggies_balance_ac",
"tags": [
"autocomplete"
],
"description": "Returns all piggy banks of the user returned in a basic auto-complete array.",
"inputSchema": {
"type": "object",
"properties": {
"query": {
"type": "string",
"description": "The autocomplete search query."
},
"limit": {
"type": "integer",
"format": "int32",
"description": "The number of items returned."
}
}
},
"method": "get",
"pathTemplate": "/v1/autocomplete/piggy-banks-with-balance",
"executionParameters": [
{
"name": "query",
"in": "query"
},
{
"name": "limit",
"in": "query"
}
],
"operationId": "get_piggies_balance_ac"
},
{
"name": "get_recurring_ac",
"tags": [
"autocomplete"
],
"description": "Returns all recurring transactions of the user returned in a basic auto-complete array.",
"inputSchema": {
"type": "object",
"properties": {
"query": {
"type": "string",
"description": "The autocomplete search query."
},
"limit": {
"type": "integer",
"format": "int32",
"description": "The number of items returned."
}
}
},
"method": "get",
"pathTemplate": "/v1/autocomplete/recurring",
"executionParameters": [
{
"name": "query",
"in": "query"
},
{
"name": "limit",
"in": "query"
}
],
"operationId": "get_recurring_ac"
},
{
"name": "get_rule_groups_ac",
"tags": [
"autocomplete"
],
"description": "Returns all rule groups of the user returned in a basic auto-complete array.",
"inputSchema": {
"type": "object",
"properties": {
"query": {
"type": "string",
"description": "The autocomplete search query."
},
"limit": {
"type": "integer",
"format": "int32",
"description": "The number of items returned."
}
}
},
"method": "get",
"pathTemplate": "/v1/autocomplete/rule-groups",
"executionParameters": [
{
"name": "query",
"in": "query"
},
{
"name": "limit",
"in": "query"
}
],
"operationId": "get_rule_groups_ac"
},
{
"name": "get_rules_ac",
"tags": [
"autocomplete"
],
"description": "Returns all rules of the user returned in a basic auto-complete array.",
"inputSchema": {
"type": "object",
"properties": {
"query": {
"type": "string",
"description": "The autocomplete search query."
},
"limit": {
"type": "integer",
"format": "int32",
"description": "The number of items returned."
}
}
},
"method": "get",
"pathTemplate": "/v1/autocomplete/rules",
"executionParameters": [
{
"name": "query",
"in": "query"
},
{
"name": "limit",
"in": "query"
}
],
"operationId": "get_rules_ac"
},
{
"name": "get_tag_ac",
"tags": [
"autocomplete"
],
"description": "Returns all tags of the user returned in a basic auto-complete array.",
"inputSchema": {
"type": "object",
"properties": {
"query": {
"type": "string",
"description": "The autocomplete search query."
},
"limit": {
"type": "integer",
"format": "int32",
"description": "The number of items returned."
}
}
},
"method": "get",
"pathTemplate": "/v1/autocomplete/tags",
"executionParameters": [
{
"name": "query",
"in": "query"
},
{
"name": "limit",
"in": "query"
}
],
"operationId": "get_tag_ac"
},
{
"name": "get_transaction_types_ac",
"tags": [
"autocomplete"
],
"description": "Returns all transaction types returned in a basic auto-complete array. English only.",
"inputSchema": {
"type": "object",
"properties": {
"query": {
"type": "string",
"description": "The autocomplete search query."
},
"limit": {
"type": "integer",
"format": "int32",
"description": "The number of items returned."
}
}
},
"method": "get",
"pathTemplate": "/v1/autocomplete/transaction-types",
"executionParameters": [
{
"name": "query",
"in": "query"
},
{
"name": "limit",
"in": "query"
}
],
"operationId": "get_transaction_types_ac"
},
{
"name": "get_transactions_ac",
"tags": [
"autocomplete"
],
"description": "Returns all transaction descriptions of the user returned in a basic auto-complete array.",
"inputSchema": {
"type": "object",
"properties": {
"query": {
"type": "string",
"description": "The autocomplete search query."
},
"limit": {
"type": "integer",
"format": "int32",
"description": "The number of items returned."
}
}
},
"method": "get",
"pathTemplate": "/v1/autocomplete/transactions",
"executionParameters": [
{
"name": "query",
"in": "query"
},
{
"name": "limit",
"in": "query"
}
],
"operationId": "get_transactions_ac"
},
{
"name": "get_transactions_idac",
"tags": [
"autocomplete"
],
"description": "Returns all transactions, complemented with their ID, of the user returned in a basic auto-complete array. This endpoint is DEPRECATED and I suggest you DO NOT use it.",
"inputSchema": {
"type": "object",
"properties": {
"query": {
"type": "string",
"description": "The autocomplete search query."
},
"limit": {
"type": "integer",
"format": "int32",
"description": "The number of items returned."
}
}
},
"method": "get",
"pathTemplate": "/v1/autocomplete/transactions-with-id",
"executionParameters": [
{
"name": "query",
"in": "query"
},
{
"name": "limit",
"in": "query"
}
],
"operationId": "get_transactions_idac"
},
{
"name": "get_chart_account_overview",
"tags": [
"charts"
],
"description": "This endpoint returns the data required to generate a chart with basic asset account balance information.\n",
"inputSchema": {
"type": "object",
"properties": {
"start": {
"type": "string",
"description": "A date formatted YYYY-MM-DD.\n"
},
"end": {
"type": "string",
"description": "A date formatted YYYY-MM-DD.\n"
}
},
"required": [
"start",
"end"
]
},
"method": "get",
"pathTemplate": "/v1/chart/account/overview",
"executionParameters": [
{
"name": "start",
"in": "query"
},
{
"name": "end",
"in": "query"
}
],
"operationId": "get_chart_account_overview"
},
{
"name": "bulk_update_transactions",
"tags": [
"data"
],
"description": "Allows you to update transactions in bulk.\n",
"inputSchema": {
"type": "object",
"properties": {
"query": {
"type": "string",
"description": "The JSON query."
}
},
"required": [
"query"
]
},
"method": "post",
"pathTemplate": "/v1/data/bulk/transactions",
"executionParameters": [
{
"name": "query",
"in": "query"
}
],
"operationId": "bulk_update_transactions"
},
{
"name": "destroy_data",
"tags": [
"data"
],
"description": "A call to this endpoint deletes the requested data type. Use it with care and always with user permission.\nThe demo user is incapable of using this endpoint.\n",
"inputSchema": {
"type": "object",
"properties": {
"objects": {
"type": "string",
"enum": [
"not_assets_liabilities",
"budgets",
"bills",
"piggy_banks",
"rules",
"recurring",
"categories",
"tags",
"object_groups",
"accounts",
"asset_accounts",
"expense_accounts",
"revenue_accounts",
"liabilities",
"transactions",
"withdrawals",
"deposits",
"transfers"
],
"description": "The type of data that you wish to destroy. You can only use one at a time."
}
},
"required": [
"objects"
]
},
"method": "delete",
"pathTemplate": "/v1/data/destroy",
"executionParameters": [
{
"name": "objects",
"in": "query"
}
],
"operationId": "destroy_data"
},
{
"name": "export_accounts",
"tags": [
"data"
],
"description": "This endpoint allows you to export your accounts from Firefly III into a file. Currently supports CSV exports only.\n",
"inputSchema": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"csv"
],
"description": "The file type the export file (CSV is currently the only option)."
}
}
},
"method": "get",
"pathTemplate": "/v1/data/export/accounts",
"executionParameters": [
{
"name": "type",
"in": "query"
}
],
"operationId": "export_accounts"
},
{
"name": "export_bills",
"tags": [
"data"
],
"description": "This endpoint allows you to export your bills from Firefly III into a file. Currently supports CSV exports only.\n",
"inputSchema": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"csv"
],
"description": "The file type the export file (CSV is currently the only option)."
}
}
},
"method": "get",
"pathTemplate": "/v1/data/export/bills",
"executionParameters": [
{
"name": "type",
"in": "query"
}
],
"operationId": "export_bills"
},
{
"name": "export_budgets",
"tags": [
"data"
],
"description": "This endpoint allows you to export your budgets and associated budget data from Firefly III into a file. Currently supports CSV exports only.\n",
"inputSchema": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"csv"
],
"description": "The file type the export file (CSV is currently the only option)."
}
}
},
"method": "get",
"pathTemplate": "/v1/data/export/budgets",
"executionParameters": [
{
"name": "type",
"in": "query"
}
],
"operationId": "export_budgets"
},
{
"name": "export_categories",
"tags": [
"data"
],
"description": "This endpoint allows you to export your categories from Firefly III into a file. Currently supports CSV exports only.\n",
"inputSchema": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"csv"
],
"description": "The file type the export file (CSV is currently the only option)."
}
}
},
"method": "get",
"pathTemplate": "/v1/data/export/categories",
"executionParameters": [
{
"name": "type",
"in": "query"
}
],
"operationId": "export_categories"
},
{
"name": "export_piggies",
"tags": [
"data"
],
"description": "This endpoint allows you to export your piggy banks from Firefly III into a file. Currently supports CSV exports only.\n",
"inputSchema": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"csv"
],
"description": "The file type the export file (CSV is currently the only option)."
}
}
},
"method": "get",
"pathTemplate": "/v1/data/export/piggy-banks",
"executionParameters": [
{
"name": "type",
"in": "query"
}
],
"operationId": "export_piggies"
},
{
"name": "export_recurring",
"tags": [
"data"
],
"description": "This endpoint allows you to export your recurring transactions from Firefly III into a file. Currently supports CSV exports only.\n",
"inputSchema": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"csv"
],
"description": "The file type the export file (CSV is currently the only option)."
}
}
},
"method": "get",
"pathTemplate": "/v1/data/export/recurring",
"executionParameters": [
{
"name": "type",
"in": "query"
}
],
"operationId": "export_recurring"
},
{
"name": "export_rules",
"tags": [
"data"
],
"description": "This endpoint allows you to export your rules and rule groups from Firefly III into a file. Currently supports CSV exports only.\n",
"inputSchema": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"csv"
],
"description": "The file type the export file (CSV is currently the only option)."
}
}
},
"method": "get",
"pathTemplate": "/v1/data/export/rules",
"executionParameters": [
{
"name": "type",
"in": "query"
}
],
"operationId": "export_rules"
},
{
"name": "export_tags",
"tags": [
"data"
],
"description": "This endpoint allows you to export your tags from Firefly III into a file. Currently supports CSV exports only.\n",
"inputSchema": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"csv"
],
"description": "The file type the export file (CSV is currently the only option)."
}
}
},
"method": "get",
"pathTemplate": "/v1/data/export/tags",
"executionParameters": [
{
"name": "type",
"in": "query"
}
],
"operationId": "export_tags"
},
{
"name": "export_transactions",
"tags": [
"data"
],
"description": "This endpoint allows you to export transactions from Firefly III into a file. Currently supports CSV exports only.\n",
"inputSchema": {
"type": "object",
"properties": {
"start": {
"type": "string",
"description": "A date formatted YYYY-MM-DD.\n"
},
"end": {
"type": "string",
"description": "A date formatted YYYY-MM-DD.\n"
},
"accounts": {
"type": "string",
"description": "Limit the export of transactions to these accounts only. Only asset accounts will be accepted. Other types will be silently dropped.\n"
},
"type": {
"type": "string",
"enum": [
"csv"
],
"description": "The file type the export file (CSV is currently the only option)."
}
},
"required": [
"start",
"end"
]
},
"method": "get",
"pathTemplate": "/v1/data/export/transactions",
"executionParameters": [
{
"name": "start",
"in": "query"
},
{
"name": "end",
"in": "query"
},
{
"name": "accounts",
"in": "query"
},
{
"name": "type",
"in": "query"
}
],
"operationId": "export_transactions"
},
{
"name": "purge_data",
"tags": [
"data"
],
"description": "A call to this endpoint purges all previously deleted data. Use it with care and always with user permission.\nThe demo user is incapable of using this endpoint.\n",
"inputSchema": {
"type": "object",
"properties": {}
},
"method": "delete",
"pathTemplate": "/v1/data/purge",
"executionParameters": [],
"operationId": "purge_data"
},
{
"name": "insight_expense_expense",
"tags": [
"insight"
],
"description": "This endpoint gives a summary of the expenses made by the user, grouped by expense account.\n",
"inputSchema": {
"type": "object",
"properties": {
"start": {
"type": "string",
"description": "A date formatted YYYY-MM-DD.\n"
},
"end": {
"type": "string",
"description": "A date formatted YYYY-MM-DD.\n"
},
"accounts[]": {
"type": "array",
"items": {
"type": "integer",
"format": "int64"
},
"example": [
1,
2,
3
],
"description": "The accounts to be included in the results. If you add the accounts ID's of expense accounts, only those accounts\nare included in the results. If you include ID's of asset accounts or liabilities, only withdrawals from those\nasset accounts / liabilities will be included. You can combine both asset / liability and expense account ID's.\nOther account ID's will be ignored.\n"
}
},
"required": [
"start",
"end"
]
},
"method": "get",
"pathTemplate": "/v1/insight/expense/expense",
"executionParameters": [
{
"name": "start",
"in": "query"
},
{
"name": "end",
"in": "query"
},
{
"name": "accounts[]",
"in": "query"
}
],
"operationId": "insight_expense_expense"
},
{
"name": "insight_expense_asset",
"tags": [
"insight"
],
"description": "This endpoint gives a summary of the expenses made by the user, grouped by asset account.\n",
"inputSchema": {
"type": "object",
"properties": {
"start": {
"type": "string",
"description": "A date formatted YYYY-MM-DD.\n"
},
"end": {
"type": "string",
"description": "A date formatted YYYY-MM-DD.\n"
},
"accounts[]": {
"type": "array",
"items": {
"type": "integer",
"format": "int64"
},
"example": [
1,
2,
3
],
"description": "The accounts to be included in the results. If you include ID's of asset accounts or liabilities, only withdrawals from those\nasset accounts / liabilities will be included. Other account ID's will be ignored.\n"
}
},
"required": [
"start",
"end"
]
},
"method": "get",
"pathTemplate": "/v1/insight/expense/asset",
"executionParameters": [
{
"name": "start",
"in": "query"
},
{
"name": "end",
"in": "query"
},
{
"name": "accounts[]",
"in": "query"
}
],
"operationId": "insight_expense_asset"
},
{
"name": "insight_income_revenue",
"tags": [
"insight"
],
"description": "This endpoint gives a summary of the income received by the user, grouped by revenue account.\n",
"inputSchema": {
"type": "object",
"properties": {
"start": {
"type": "string",
"description": "A date formatted YYYY-MM-DD.\n"
},
"end": {
"type": "string",
"description": "A date formatted YYYY-MM-DD.\n"
},
"accounts[]": {
"type": "array",
"items": {
"type": "integer",
"format": "int64"
},
"example": [
1,
2,
3
],
"description": "The accounts to be included in the results. If you add the accounts ID's of revenue accounts, only those accounts\nare included in the results. If you include ID's of asset accounts or liabilities, only deposits to those\nasset accounts / liabilities will be included. You can combine both asset / liability and deposit account ID's.\nOther account ID's will be ignored.\n"
}
},
"required": [
"start",
"end"
]
},
"method": "get",
"pathTemplate": "/v1/insight/income/revenue",
"executionParameters": [
{
"name": "start",
"in": "query"
},
{
"name": "end",
"in": "query"
},
{
"name": "accounts[]",
"in": "query"
}
],
"operationId": "insight_income_revenue"
},
{
"name": "insight_income_asset",
"tags": [
"insight"
],
"description": "This endpoint gives a summary of the income received by the user, grouped by asset account.\n",
"inputSchema": {
"type": "object",
"properties": {
"start": {
"type": "string",
"description": "A date formatted YYYY-MM-DD.\n"
},
"end": {
"type": "string",
"description": "A date formatted YYYY-MM-DD.\n"
},
"accounts[]": {
"type": "array",
"items": {
"type": "integer",
"format": "int64"
},
"example": [
1,
2,
3
],
"description": "The accounts to be included in the results. If you include ID's of asset accounts or liabilities, only deposits to those\nasset accounts / liabilities will be included. Other account ID's will be ignored.\n"
}
},
"required": [
"start",
"end"
]
},
"method": "get",
"pathTemplate": "/v1/insight/income/asset",
"executionParameters": [
{
"name": "start",
"in": "query"
},
{
"name": "end",
"in": "query"
},
{
"name": "accounts[]",
"in": "query"
}
],
"operationId": "insight_income_asset"
},
{
"name": "insight_transfers",
"tags": [
"insight"
],
"description": "This endpoint gives a summary of the transfers made by the user, grouped by asset account or lability.\n",
"inputSchema": {
"type": "object",
"properties": {
"start": {
"type": "string",
"description": "A date formatted YYYY-MM-DD.\n"
},
"end": {
"type": "string",
"description": "A date formatted YYYY-MM-DD.\n"
},
"accounts[]": {
"type": "array",
"items": {
"type": "integer",
"format": "int64"
},
"example": [
1,
2,
3
],
"description": "The accounts to be included in the results. If you include ID's of asset accounts or liabilities, only transfers between those\nasset accounts / liabilities will be included. Other account ID's will be ignored.\n"
}
},
"required": [
"start",
"end"
]
},
"method": "get",
"pathTemplate": "/v1/insight/transfer/asset",
"executionParameters": [
{
"name": "start",
"in": "query"
},
{
"name": "end",
"in": "query"
},
{
"name": "accounts[]",
"in": "query"
}
],
"operationId": "insight_transfers"
},
{
"name": "insight_expense_bill",
"tags": [
"insight"
],
"description": "This endpoint gives a summary of the expenses made by the user, grouped by (any) bill.\n",
"inputSchema": {
"type": "object",
"properties": {
"start": {
"type": "string",
"description": "A date formatted YYYY-MM-DD.\n"
},
"end": {
"type": "string",
"description": "A date formatted YYYY-MM-DD.\n"
},
"bills[]": {
"type": "array",
"items": {
"type": "integer",
"format": "int64"
},
"example": [
1,
2,
3
],
"description": "The bills to be included in the results.\n"
},
"accounts[]": {
"type": "array",
"items": {
"type": "integer",
"format": "int64"
},
"example": [
1,
2,
3
],
"description": "The accounts to be included in the results. If you include ID's of asset accounts or liabilities, only withdrawals from those\nasset accounts / liabilities will be included. Other account ID's will be ignored.\n"
}
},
"required": [
"start",
"end"
]
},
"method": "get",
"pathTemplate": "/v1/insight/expense/bill",
"executionParameters": [
{
"name": "start",
"in": "query"
},
{
"name": "end",
"in": "query"
},
{
"name": "bills[]",
"in": "query"
},
{
"name": "accounts[]",
"in": "query"
}
],
"operationId": "insight_expense_bill"
},
{
"name": "insight_expense_no_bill",
"tags": [
"insight"
],
"description": "This endpoint gives a summary of the expenses made by the user, including only expenses with no bill.\n",
"inputSchema": {
"type": "object",
"properties": {
"start": {
"type": "string",
"description": "A date formatted YYYY-MM-DD.\n"
},
"end": {
"type": "string",
"description": "A date formatted YYYY-MM-DD.\n"
},
"accounts[]": {
"type": "array",
"items": {
"type": "integer",
"format": "int64"
},
"example": [
1,
2,
3
],
"description": "The accounts to be included in the results. If you include ID's of asset accounts or liabilities, only withdrawals from those\nasset accounts / liabilities will be included. Other account ID's will be ignored.\n"
}
},
"required": [
"start",
"end"
]
},
"method": "get",
"pathTemplate": "/v1/insight/expense/no-bill",
"executionParameters": [
{
"name": "start",
"in": "query"
},
{
"name": "end",
"in": "query"
},
{
"name": "accounts[]",
"in": "query"
}
],
"operationId": "insight_expense_no_bill"
},
{
"name": "insight_expense_budget",
"tags": [
"insight"
],
"description": "This endpoint gives a summary of the expenses made by the user, grouped by (any) budget.\n",
"inputSchema": {
"type": "object",
"properties": {
"start": {
"type": "string",
"description": "A date formatted YYYY-MM-DD.\n"
},
"end": {
"type": "string",
"description": "A date formatted YYYY-MM-DD.\n"
},
"budgets[]": {
"type": "array",
"items": {
"type": "integer",
"format": "int64"
},
"example": [
1,
2,
3
],
"description": "The budgets to be included in the results.\n"
},
"accounts[]": {
"type": "array",
"items": {
"type": "integer",
"format": "int64"
},
"example": [
1,
2,
3
],
"description": "The accounts to be included in the results. If you include ID's of asset accounts or liabilities, only withdrawals from those\nasset accounts / liabilities will be included. Other account ID's will be ignored.\n"
}
},
"required": [
"start",
"end"
]
},
"method": "get",
"pathTemplate": "/v1/insight/expense/budget",
"executionParameters": [
{
"name": "start",
"in": "query"
},
{
"name": "end",
"in": "query"
},
{
"name": "budgets[]",
"in": "query"
},
{
"name": "accounts[]",
"in": "query"
}
],
"operationId": "insight_expense_budget"
},
{
"name": "insight_expense_no_budget",
"tags": [
"insight"
],
"description": "This endpoint gives a summary of the expenses made by the user, including only expenses with no budget.\n",
"inputSchema": {
"type": "object",
"properties": {
"start": {
"type": "string",
"description": "A date formatted YYYY-MM-DD.\n"
},
"end": {
"type": "string",
"description": "A date formatted YYYY-MM-DD.\n"
},
"accounts[]": {
"type": "array",
"items": {
"type": "integer",
"format": "int64"
},
"example": [
1,
2,
3
],
"description": "The accounts to be included in the results. If you include ID's of asset accounts or liabilities, only withdrawals from those\nasset accounts / liabilities will be included. Other account ID's will be ignored.\n"
}
},
"required": [
"start",
"end"
]
},
"method": "get",
"pathTemplate": "/v1/insight/expense/no-budget",
"executionParameters": [
{
"name": "start",
"in": "query"
},
{
"name": "end",
"in": "query"
},
{
"name": "accounts[]",
"in": "query"
}
],
"operationId": "insight_expense_no_budget"
},
{
"name": "insight_expense_category",
"tags": [
"insight"
],
"description": "This endpoint gives a summary of the expenses made by the user, grouped by (any) category.\n",
"inputSchema": {
"type": "object",
"properties": {
"start": {
"type": "string",
"description": "A date formatted YYYY-MM-DD.\n"
},
"end": {
"type": "string",
"description": "A date formatted YYYY-MM-DD.\n"
},
"categories[]": {
"type": "array",
"items": {
"type": "integer",
"format": "int64"
},
"example": [
1,
2,
3
],
"description": "The categories to be included in the results.\n"
},
"accounts[]": {
"type": "array",
"items": {
"type": "integer",
"format": "int64"
},
"example": [
1,
2,
3
],
"description": "The accounts to be included in the results. If you include ID's of asset accounts or liabilities, only withdrawals from those\nasset ac