Skip to content
Patrimoine
v9.1.0

Overview

Patrimoine 9.24.0

Section titled “Patrimoine 9.24.0”

Information

  • OpenAPI version: 3.1.0

Operations

Section titled “Operations”
GET
/health
GET
/health/db
GET
/metrics
GET
/api/v1/accounts
POST
/api/v1/accounts
PUT
/api/v1/accounts/reorder
GET
/api/v1/accounts/{account_id}/payoff
GET
/api/v1/accounts/{account_id}/equity
GET
/api/v1/accounts/{account_id}
DELETE
/api/v1/accounts/{account_id}
PATCH
/api/v1/accounts/{account_id}
GET
/api/v1/accounts/deleted/list
DELETE
/api/v1/accounts/deleted/empty
POST
/api/v1/accounts/{account_id}/restore
DELETE
/api/v1/accounts/{account_id}/permanent
POST
/api/v1/accounts/{account_id}/archive
POST
/api/v1/accounts/{account_id}/unarchive
POST
/api/v1/accounts/{account_id}/close
GET
/api/v1/admin/users
DELETE
/api/v1/admin/users/{user_id}
PATCH
/api/v1/admin/users/{user_id}
POST
/api/v1/admin/users/{user_id}/mfa/disable
PATCH
/api/v1/admin/users/{user_id}/email
GET
/api/v1/admin/users/invites
POST
/api/v1/admin/users/invites
DELETE
/api/v1/admin/users/invites/{invite_id}
POST
/api/v1/admin/users/invites/purge
GET
/api/v1/admin/users/audit
GET
/api/v1/admin/users/audit/export
GET
/api/v1/alerts
GET
/api/v1/alerts/unread-count
POST
/api/v1/alerts/read-all
POST
/api/v1/alerts/{alert_id}/read
POST
/api/v1/alerts/{alert_id}/dismiss
GET
/api/v1/alert-rules
PUT
/api/v1/alert-rules
GET
/api/v1/notification-preferences
PUT
/api/v1/notification-preferences/{rule_type}
GET
/api/v1/snapshots
POST
/api/v1/snapshots
POST
/api/v1/snapshots/upsert
POST
/api/v1/snapshots/batch-upsert
GET
/api/v1/snapshots/grid
GET
/api/v1/snapshots/latest-per-account
GET
/api/v1/snapshots/counts
GET
/api/v1/snapshots/{snapshot_id}
DELETE
/api/v1/snapshots/{snapshot_id}
PATCH
/api/v1/snapshots/{snapshot_id}
DELETE
/api/v1/snapshots/by-date/{target_date}
POST
/api/v1/snapshots/{snapshot_id}/restore
GET
/api/v1/charts/net-worth
GET
/api/v1/charts/net-worth-adjusted
GET
/api/v1/charts/account-trends
GET
/api/v1/charts/stacked-by-type
GET
/api/v1/charts/statistics
GET
/api/v1/charts/delta-heatmap
GET
/api/v1/charts/waterfall
GET
/api/v1/charts/net-worth-change
GET
/api/v1/charts/concentration
GET
/api/v1/charts/liquidity
GET
/api/v1/charts/balance-forecast
POST
/api/v1/charts/balance-forecast/what-if
GET
/api/v1/chart-annotations
POST
/api/v1/chart-annotations
DELETE
/api/v1/chart-annotations/{annotation_id}
PATCH
/api/v1/chart-annotations/{annotation_id}
GET
/api/v1/export/csv
GET
/api/v1/export/ods
GET
/api/v1/export/xlsx
GET
/api/v1/export/summary
GET
/api/v1/export/backup
GET
/api/v1/export/holdings/csv
GET
/api/v1/export/holdings/ods
GET
/api/v1/export/holdings/xlsx
GET
/auth/oidc/start
GET
/auth/callback
POST
/auth/logout
GET
/auth/config
POST
/auth/register
GET
/auth/invites/validate
POST
/auth/invites/validate
POST
/auth/invites/redeem
POST
/auth/login
POST
/auth/login/token
POST
/auth/mobile/exchange
POST
/auth/forgot-password
GET
/auth/reset-password/validate
POST
/auth/reset-password/validate
POST
/auth/reset-password
POST
/api/v1/auth/email-change/request
POST
/api/v1/auth/email-change/confirm
GET
/api/v1/auth/me
DELETE
/api/v1/auth/me
PATCH
/api/v1/auth/me
GET
/api/v1/auth/custom-css/rules
POST
/api/v1/auth/change-password
POST
/api/v1/auth/totp/setup
POST
/api/v1/auth/totp/verify
GET
/api/v1/auth/totp/recovery-status
POST
/api/v1/auth/totp/recovery-codes
POST
/api/v1/auth/totp/disable
POST
/api/v1/auth/token/revoke
GET
/api/v1/auth/sessions
POST
/api/v1/auth/sessions/revoke-others
DELETE
/api/v1/auth/sessions/{session_id}
POST
/api/v1/import/parse
POST
/api/v1/import/commit
POST
/api/v1/import/backup/parse
POST
/api/v1/import/backup
GET
/api/v1/categories
POST
/api/v1/categories
GET
/api/v1/categories/{category_id}
DELETE
/api/v1/categories/{category_id}
PATCH
/api/v1/categories/{category_id}
PUT
/api/v1/categories/reorder
GET
/api/v1/subcategories
POST
/api/v1/subcategories
GET
/api/v1/subcategories/{subcategory_id}
DELETE
/api/v1/subcategories/{subcategory_id}
PATCH
/api/v1/subcategories/{subcategory_id}
PUT
/api/v1/subcategories/reorder
PUT
/api/v1/subcategories/{subcategory_id}/move
GET
/api/v1/institutions
POST
/api/v1/institutions
GET
/api/v1/institutions/deleted/list
DELETE
/api/v1/institutions/deleted/empty
PUT
/api/v1/institutions/reorder
GET
/api/v1/institutions/grid
GET
/api/v1/institutions/{institution_id}
DELETE
/api/v1/institutions/{institution_id}
PATCH
/api/v1/institutions/{institution_id}
POST
/api/v1/institutions/{institution_id}/archive
POST
/api/v1/institutions/{institution_id}/unarchive
POST
/api/v1/institutions/{institution_id}/restore
DELETE
/api/v1/institutions/{institution_id}/permanent
GET
/api/v1/recurring-snapshots
POST
/api/v1/recurring-snapshots
GET
/api/v1/recurring-snapshots/{rs_id}
DELETE
/api/v1/recurring-snapshots/{rs_id}
PATCH
/api/v1/recurring-snapshots/{rs_id}
GET
/api/v1/envelopes
POST
/api/v1/envelopes
GET
/api/v1/envelopes/free-to-use
GET
/api/v1/envelopes/payday-plan
GET
/api/v1/envelopes/{envelope_id}
DELETE
/api/v1/envelopes/{envelope_id}
PATCH
/api/v1/envelopes/{envelope_id}
GET
/api/v1/envelopes/{envelope_id}/contributions
POST
/api/v1/envelopes/{envelope_id}/contributions
POST
/api/v1/envelopes/{envelope_id}/pay
GET
/api/v1/funding-schedules
POST
/api/v1/funding-schedules
GET
/api/v1/funding-schedules/paydays
GET
/api/v1/funding-schedules/{schedule_id}
DELETE
/api/v1/funding-schedules/{schedule_id}
PATCH
/api/v1/funding-schedules/{schedule_id}
GET
/api/v1/goal-templates
POST
/api/v1/goal-templates
GET
/api/v1/goal-templates/{template_id}
DELETE
/api/v1/goal-templates/{template_id}
PATCH
/api/v1/goal-templates/{template_id}
GET
/api/v1/saved-filters
POST
/api/v1/saved-filters
DELETE
/api/v1/saved-filters/{filter_id}
PATCH
/api/v1/saved-filters/{filter_id}
GET
/api/v1/reports/settings
PATCH
/api/v1/reports/settings
GET
/api/v1/reports/financial-independence
GET
/api/v1/reports/cash-flow
POST
/api/v1/reports/run
GET
/api/v1/reports/simulation
GET
/api/v1/saved-reports
POST
/api/v1/saved-reports
DELETE
/api/v1/saved-reports/{report_id}
PATCH
/api/v1/saved-reports/{report_id}
GET
/api/v1/dashboards
POST
/api/v1/dashboards
POST
/api/v1/dashboards/initialize
PUT
/api/v1/dashboards/reorder
DELETE
/api/v1/dashboards/{dashboard_id}
PATCH
/api/v1/dashboards/{dashboard_id}
GET
/api/v1/savings-goals
POST
/api/v1/savings-goals
GET
/api/v1/savings-goals/{goal_id}
DELETE
/api/v1/savings-goals/{goal_id}
PATCH
/api/v1/savings-goals/{goal_id}
GET
/api/v1/net-worth-thresholds
POST
/api/v1/net-worth-thresholds
GET
/api/v1/net-worth-thresholds/{threshold_id}
DELETE
/api/v1/net-worth-thresholds/{threshold_id}
PATCH
/api/v1/net-worth-thresholds/{threshold_id}
GET
/api/v1/tokens
POST
/api/v1/tokens
DELETE
/api/v1/tokens/{token_id}
GET
/api/v1/webhooks
POST
/api/v1/webhooks
DELETE
/api/v1/webhooks/{webhook_id}
GET
/api/v1/webhooks/{webhook_id}/deliveries
GET
/api/v1/exchange-rates
POST
/api/v1/exchange-rates
GET
/api/v1/exchange-rates/conversion-rates
GET
/api/v1/exchange-rates/conversion-rates/batch
GET
/api/v1/exchange-rates/coverage-audit
GET
/api/v1/exchange-rates/{rate_id}
DELETE
/api/v1/exchange-rates/{rate_id}
PATCH
/api/v1/exchange-rates/{rate_id}
POST
/api/v1/exchange-rates/refresh
POST
/api/v1/exchange-rates/backfill-snapshots
POST
/api/v1/exchange-rates/fetch
GET
/api/v1/system/info
GET
/api/v1/audit-logs
GET
/api/v1/audit-logs/export
GET
/api/v1/budget/transactions/deleted/list
POST
/api/v1/budget/transactions/{tx_id}/restore
DELETE
/api/v1/budget/transactions/{tx_id}/permanent
DELETE
/api/v1/budget/transactions/deleted/empty
POST
/api/v1/budget/transfers
GET
/api/v1/budget/transfers/suggestions
POST
/api/v1/budget/transfers/link
POST
/api/v1/budget/transactions/{tx_id}/unlink
POST
/api/v1/budget/transactions/merge
GET
/api/v1/budget/transactions/duplicates
GET
/api/v1/budget/transactions/{transaction_id}/similar
GET
/api/v1/budget/transactions/duplicates/dismissals
POST
/api/v1/budget/transactions/duplicates/dismissals
DELETE
/api/v1/budget/transactions/duplicates/dismissals/{dismissal_id}
POST
/api/v1/budget/transactions/duplicates/merge
PUT
/api/v1/budget/transactions/{tx_id}/splits
DELETE
/api/v1/budget/transactions/{tx_id}/splits
GET
/api/v1/budget/transactions
POST
/api/v1/budget/transactions
GET
/api/v1/budget/transactions/converted
DELETE
/api/v1/budget/transactions/{tx_id}
PATCH
/api/v1/budget/transactions/{tx_id}
GET
/api/v1/budget/transactions/ids
GET
/api/v1/budget/transactions/summary
GET
/api/v1/budget/transactions/export/csv
GET
/api/v1/budget/transactions/export/ods
GET
/api/v1/budget/transactions/export/xlsx
POST
/api/v1/budget/transactions/batch-delete
POST
/api/v1/budget/transactions/batch-update
POST
/api/v1/budget/transactions/import/parse
POST
/api/v1/budget/transactions/import/commit
POST
/api/v1/budget/transactions/import/csv/parse
POST
/api/v1/budget/transactions/import/csv/commit
POST
/api/v1/budget/transactions/import-csv/parse
POST
/api/v1/budget/transactions/import-csv/commit
POST
/api/v1/budget/reconciliations/preview
GET
/api/v1/budget/reconciliations
POST
/api/v1/budget/reconciliations
POST
/api/v1/budget/reconciliations/{reconciliation_id}/undo
GET
/api/v1/budget/budgets
POST
/api/v1/budget/budgets
DELETE
/api/v1/budget/budgets/{budget_id}
PATCH
/api/v1/budget/budgets/{budget_id}
PUT
/api/v1/budget/budgets/{budget_id}/month-limits/{month}
DELETE
/api/v1/budget/budgets/{budget_id}/month-limits/{month}
POST
/api/v1/budget/month-limits/fill
GET
/api/v1/budget/summary/{year}/{month}
GET
/api/v1/budget/summary/range
GET
/api/v1/budget/analytics
GET
/api/v1/budget/savings-rate
GET
/api/v1/budget/spending-comparison
GET
/api/v1/budget/spendable
GET
/api/v1/categorization-rules
POST
/api/v1/categorization-rules
GET
/api/v1/categorization-rules/{rule_id}
DELETE
/api/v1/categorization-rules/{rule_id}
PATCH
/api/v1/categorization-rules/{rule_id}
POST
/api/v1/categorization-rules/preview
POST
/api/v1/categorization-rules/{rule_id}/apply
GET
/api/v1/categorization-rules/deleted/list
DELETE
/api/v1/categorization-rules/deleted/empty
POST
/api/v1/categorization-rules/{rule_id}/restore
DELETE
/api/v1/categorization-rules/{rule_id}/permanent
GET
/api/v1/planned-transactions
GET
/api/v1/planned-transactions
POST
/api/v1/planned-transactions
POST
/api/v1/planned-transactions
GET
/api/v1/planned-transactions/suggestions
GET
/api/v1/planned-transactions/suggestions
GET
/api/v1/planned-transactions/subscriptions
GET
/api/v1/planned-transactions/subscriptions
GET
/api/v1/planned-transactions/calendar
GET
/api/v1/planned-transactions/calendar
POST
/api/v1/planned-transactions/suggestions/dismissals
POST
/api/v1/planned-transactions/suggestions/dismissals
GET
/api/v1/planned-transactions/{planned_transaction_id}
GET
/api/v1/planned-transactions/{planned_transaction_id}
DELETE
/api/v1/planned-transactions/{planned_transaction_id}
DELETE
/api/v1/planned-transactions/{planned_transaction_id}
PATCH
/api/v1/planned-transactions/{planned_transaction_id}
PATCH
/api/v1/planned-transactions/{planned_transaction_id}
GET
/api/v1/planned-transactions/{planned_transaction_id}/occurrences
GET
/api/v1/planned-transactions/{planned_transaction_id}/occurrences
PUT
/api/v1/planned-transactions/{planned_transaction_id}/skips/{anchor}
PUT
/api/v1/planned-transactions/{planned_transaction_id}/skips/{anchor}
DELETE
/api/v1/planned-transactions/{planned_transaction_id}/skips/{anchor}
DELETE
/api/v1/planned-transactions/{planned_transaction_id}/skips/{anchor}
GET
/api/v1/planned-transactions/deleted/list
GET
/api/v1/planned-transactions/deleted/list
DELETE
/api/v1/planned-transactions/deleted/empty
DELETE
/api/v1/planned-transactions/deleted/empty
POST
/api/v1/planned-transactions/{planned_transaction_id}/restore
POST
/api/v1/planned-transactions/{planned_transaction_id}/restore
DELETE
/api/v1/planned-transactions/{planned_transaction_id}/permanent
DELETE
/api/v1/planned-transactions/{planned_transaction_id}/permanent
POST
/api/v1/planned-transactions/batch-delete
POST
/api/v1/planned-transactions/batch-delete
POST
/api/v1/planned-transactions/{planned_transaction_id}/pay
POST
/api/v1/planned-transactions/{planned_transaction_id}/pay
GET
/api/v1/investments/holdings
POST
/api/v1/investments/holdings
GET
/api/v1/investments/holdings/grouped
GET
/api/v1/investments/holdings/grouped-by-account
GET
/api/v1/investments/holdings/{holding_id}
DELETE
/api/v1/investments/holdings/{holding_id}
PATCH
/api/v1/investments/holdings/{holding_id}
GET
/api/v1/investments/dividends
GET
/api/v1/investments/dividends/timeline
POST
/api/v1/investments/holdings/{holding_id}/dividends
DELETE
/api/v1/investments/holdings/{holding_id}/dividends/{dividend_id}
PATCH
/api/v1/investments/holdings/{holding_id}/dividends/{dividend_id}
GET
/api/v1/investments/summary
GET
/api/v1/investments/insight/currency-allocation
GET
/api/v1/investments/insight/asset-allocation
GET
/api/v1/investments/insight/invested
GET
/api/v1/investments/insight/performance
GET
/api/v1/investments/insight/price-history
GET
/api/v1/investments/insight/period-returns
GET
/api/v1/investments/insight/value-history
GET
/api/v1/market-data/search
GET
/api/v1/market-data/quote
GET
/api/v1/market-data/historical-price
GET
/api/v1/tags
POST
/api/v1/tags
DELETE
/api/v1/tags/{tag_id}
PATCH
/api/v1/tags/{tag_id}
GET
/api/v1/tags/merge-preview
POST
/api/v1/tags/merge
GET
/api/v1/payees
POST
/api/v1/payees
GET
/api/v1/payees/merge-preview
GET
/api/v1/payees/{payee_id}/category-suggestion
POST
/api/v1/payees/merge
DELETE
/api/v1/payees/{payee_id}
PATCH
/api/v1/payees/{payee_id}