Returns planned, spent, rollover, available and pace for each budget in one plan and month, plus totals and spending no budget covers. Envelope plans also return readyToAssign, paymentEnvelopes and unrecognizedCardInflows. Finta computes every number at request time and counts only the plan’s accounts. When includesAccountsOutsideConsent is true, the totals include accounts this key was not granted, named in accountsOutsideConsent, and their transactions stay unavailable to it. plan is null if the user has no budgets yet.
Depository balances minus totals.available minus every payment envelope's available, over the plan's accounts. Negative when over-assigned. Null unless this is an envelope plan's current month.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Finta","description":"Finta syncs financial data from banks and payment processors to productivity tools like Airtable, Notion, Google Sheets, and Coda. Documentation for setup, integrations, and troubleshooting.","colors":{"primary":"#6E56CF","light":"#6E56CF","dark":"#6E56CF"},"logo":{"light":"https://mintcdn.com/finta-10/K_IMUIs0cBRtaWOM/logo/finta-logo-black-text.svg?fit=max\u0026auto=format\u0026n=K_IMUIs0cBRtaWOM\u0026q=85\u0026s=5a36e554ada8ffbb5ce2af670ed6c896","dark":"https://mintcdn.com/finta-10/K_IMUIs0cBRtaWOM/logo/finta-logo-white-text.svg?fit=max\u0026auto=format\u0026n=K_IMUIs0cBRtaWOM\u0026q=85\u0026s=91830ef558aa1cbc384361a0d73fb04b"},"favicon":"https://mintcdn.com/finta-10/jdclNcDGGc_u6oDw/favicon.png?fit=max\u0026auto=format\u0026n=jdclNcDGGc_u6oDw\u0026q=85\u0026s=91745403bceaa562ddca8d64c9a89ff6","background":{"color":{"dark":"#111111"}},"navbar":{"links":[{"href":"mailto:hello@finta.io","label":"Contact Us"}],"primary":{"type":"button","label":"Dashboard","href":"https://app.finta.io"}},"footer":{"socials":{"twitter":"https://twitter.com/FintaApp"}},"contextual":{"options":["assistant","copy","mcp","add-mcp"],"display":"header"},"styling":{"latex":false},"navigation":{"global":{"anchors":[{"anchor":"Community","icon":"discord","href":"https://link.finta.io/discord"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"finta-10","hasAudioNarration":false,"actualSubdomain":"finta-10","customDomains":["docs.finta.io"],"gitSource":{"type":"github","owner":"fintaapp","repo":"monorepo","deployBranch":"main","contentDirectory":"apps/docs","isPrivate":false,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ae8097d348e269909a7d3e8","collectionId":"460a1d11-522d-4df8-bd83-ddb9635db695","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ae8097d348e269909a7d3e8"},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6ae8097d348e269909a7d3e8","clientVersion":"0.0.4044","searchFilterCounts":[{"language":"default","tag":"API","count":50},{"language":"default","tag":"Reference","count":40},{"language":"default","tag":"Documentation","count":33},{"language":"default","tag":"Bank Connections","count":11},{"language":"default","tag":"Budgets","count":10},{"language":"default","tag":"MCP","count":9},{"language":"default","tag":"Destinations","count":8},{"language":"default","tag":"Accounts","count":7},{"language":"default","tag":"Getting Started","count":6},{"language":"default","tag":"Charts","count":5}]},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/budgets/get-budget-status","slug":"/api-reference/budgets/get-budget-status","pageMetadata":{"title":"Get budget status","description":"Returns planned, spent, rollover, available and pace for each budget in one plan and month, plus totals and spending no budget covers. Envelope plans also return `readyToAssign`, `paymentEnvelopes` and `unrecognizedCardInflows`. Finta computes every number at request time and counts only the plan's accounts. When `includesAccountsOutsideConsent` is true, the totals include accounts this key was not granted, named in `accountsOutsideConsent`, and their transactions stay unavailable to it. `plan` is null if the user has no budgets yet.","deprecated":null,"version":null,"openapi":"/api/v2/openapi.json get /budgets/status","href":"/api-reference/budgets/get-budget-status","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_components.p, {\n children: [\"Returns planned, spent, rollover, available and pace for each budget in one plan and month, plus totals and spending no budget covers. Envelope plans also return \", _jsx(_components.code, {\n children: \"readyToAssign\"\n }), \", \", _jsx(_components.code, {\n children: \"paymentEnvelopes\"\n }), \" and \", _jsx(_components.code, {\n children: \"unrecognizedCardInflows\"\n }), \". Finta computes every number at request time and counts only the plan’s accounts. When \", _jsx(_components.code, {\n children: \"includesAccountsOutsideConsent\"\n }), \" is true, the totals include accounts this key was not granted, named in \", _jsx(_components.code, {\n children: \"accountsOutsideConsent\"\n }), \", and their transactions stay unavailable to it. \", _jsx(_components.code, {\n children: \"plan\"\n }), \" is null if the user has no budgets yet.\"]\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Get budget status","description":"Returns planned, spent, rollover, available and pace for each budget in one plan and month, plus totals and spending no budget covers. Envelope plans also return `readyToAssign`, `paymentEnvelopes` and `unrecognizedCardInflows`. Finta computes every number at request time and counts only the plan's accounts. When `includesAccountsOutsideConsent` is true, the totals include accounts this key was not granted, named in `accountsOutsideConsent`, and their transactions stay unavailable to it. `plan` is null if the user has no budgets yet.","deprecated":null,"version":null,"openapi":"/api/v2/openapi.json get /budgets/status","href":"/api-reference/budgets/get-budget-status","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"summary":"Get budget status","description":"Returns planned, spent, rollover, available and pace for each budget in one plan and month, plus totals and spending no budget covers. Envelope plans also return `readyToAssign`, `paymentEnvelopes` and `unrecognizedCardInflows`. Finta computes every number at request time and counts only the plan's accounts. When `includesAccountsOutsideConsent` is true, the totals include accounts this key was not granted, named in `accountsOutsideConsent`, and their transactions stay unavailable to it. `plan` is null if the user has no budgets yet.","operationId":"getBudgetStatusV2","tags":["Budgets"],"parameters":["19cb3361-4e68-4bb3-8aab-9fe1c65c1fa4","ccc808fd-113c-442b-b33f-d7a904766ec0"],"responses":{"200":"69cdcc16-6702-4bc7-8f78-173bd51ce0d6","400":"3bb84825-ec3a-4be7-8977-42338db02a2c","401":"0e5d58eb-7116-4617-acce-eb0edfc34269","403":"ee3b2e5e-b007-4f8b-ac21-b098dc3fcff0","404":"5d317f69-5dc8-4539-8403-09db08d48cf4","429":"5370113e-250c-4310-a788-697654ebf5f6"},"method":"get","type":"path","servers":["a695617d-a24b-4d79-8001-f41ee3fdb0cc"],"security":["46ee374d-16db-4024-a9d8-68134c916743"],"path":"/budgets/status","baseUrlOptions":["https://api.finta.io/v2"],"title":"Get budget status","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"19cb3361-4e68-4bb3-8aab-9fe1c65c1fa4":{"name":"plan","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":100,"isRequired":false,"description":"Plan name or id. Defaults to the default plan.","uniqueKey":"","typeLabel":"string"},"description":"Plan name or id. Defaults to the default plan."},"ccc808fd-113c-442b-b33f-d7a904766ec0":{"name":"period","in":"query","required":false,"schema":{"type":"string","default":"current","isRequired":false,"description":"`current` (in the user's timezone) or a month as YYYY-MM","uniqueKey":"","typeLabel":"string"},"description":"`current` (in the user's timezone) or a month as YYYY-MM"}},"responses":{"69cdcc16-6702-4bc7-8f78-173bd51ce0d6":{"description":"Budget status for the month","content":{"application/json":{"schema":{"type":"object","required":["planId","plan","period","currency","totals","readyToAssign","balancesAsOf","budgets","unbudgeted","paymentEnvelopes","unrecognizedCardInflows","meta","includesAccountsOutsideConsent","accountsOutsideConsent"],"properties":{"planId":{"oneOf":[{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"planId.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","format":"uuid","isRequired":true,"uniqueKey":"planId.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"planId","typeLabel":"string\u003cuuid> | null"},"plan":{"oneOf":[{"type":"object","required":["id","name","method","accountScope","isDefault"],"properties":{"id":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"plan.oneOf.0.id","typeLabel":"string\u003cuuid>"},"name":{"type":"string","isRequired":true,"uniqueKey":"plan.oneOf.0.name","typeLabel":"string"},"method":{"type":"string","enum":["standard","envelope"],"isRequired":true,"uniqueKey":"plan.oneOf.0.method","typeLabel":"enum\u003cstring>"},"accountScope":{"type":"string","enum":["All","Selected"],"isRequired":true,"uniqueKey":"plan.oneOf.0.accountScope","typeLabel":"enum\u003cstring>"},"isDefault":{"type":"boolean","isRequired":true,"uniqueKey":"plan.oneOf.0.isDefault","typeLabel":"boolean"}},"isRequired":true,"uniqueKey":"plan.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"plan.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"plan","typeLabel":"object | null"},"period":{"type":"object","required":["key","cadence","startDate","endDate"],"properties":{"key":{"type":"string","example":"2026-11","isRequired":true,"uniqueKey":"period.key","typeLabel":"string"},"cadence":{"type":"string","enum":["monthly"],"isRequired":true,"uniqueKey":"period.cadence","typeLabel":"enum\u003cstring>"},"startDate":{"type":"string","format":"date","isRequired":true,"uniqueKey":"period.startDate","typeLabel":"string\u003cdate>"},"endDate":{"type":"string","format":"date","isRequired":true,"uniqueKey":"period.endDate","typeLabel":"string\u003cdate>"}},"isRequired":true,"uniqueKey":"period","typeLabel":"object"},"currency":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"currency.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"currency.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"currency","typeLabel":"string | null"},"totals":{"type":"object","description":"A category budget inside a budgeted group counts once, through the group.","required":["planned","spent","rollover","available","unbudgetedSpent","uncategorizedSpent","totalSpent"],"properties":{"planned":{"type":"number","isRequired":true,"uniqueKey":"totals.planned","typeLabel":"number"},"spent":{"type":"number","isRequired":true,"uniqueKey":"totals.spent","typeLabel":"number"},"rollover":{"type":"number","isRequired":true,"uniqueKey":"totals.rollover","typeLabel":"number"},"available":{"type":"number","isRequired":true,"uniqueKey":"totals.available","typeLabel":"number"},"unbudgetedSpent":{"type":"number","description":"Spend in categories no budget covers","isRequired":true,"uniqueKey":"totals.unbudgetedSpent","typeLabel":"number"},"uncategorizedSpent":{"type":"number","description":"Spend on transactions with no category","isRequired":true,"uniqueKey":"totals.uncategorizedSpent","typeLabel":"number"},"totalSpent":{"type":"number","isRequired":true,"uniqueKey":"totals.totalSpent","typeLabel":"number"}},"isRequired":true,"uniqueKey":"totals","typeLabel":"object"},"readyToAssign":{"oneOf":[{"type":"number","description":"Depository balances minus `totals.available` minus every payment envelope's `available`, over the plan's accounts. Negative when over-assigned. Null unless this is an envelope plan's current month.","isRequired":true,"uniqueKey":"readyToAssign.oneOf.0","typeLabel":"number"},{"type":"null","description":"Depository balances minus `totals.available` minus every payment envelope's `available`, over the plan's accounts. Negative when over-assigned. Null unless this is an envelope plan's current month.","isRequired":true,"uniqueKey":"readyToAssign.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"readyToAssign","typeLabel":"number | null"},"balancesAsOf":{"oneOf":[{"type":"string","format":"date-time","description":"Time of the oldest balance behind `readyToAssign`","isRequired":true,"uniqueKey":"balancesAsOf.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"Time of the oldest balance behind `readyToAssign`","isRequired":true,"uniqueKey":"balancesAsOf.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"balancesAsOf","typeLabel":"string\u003cdate-time> | null"},"budgets":{"type":"array","items":{"type":"object","required":["budgetId","targetType","categoryId","categoryGroupId","name","categoryIds","rolloverEnabled","planned","plannedSource","suggestedAmount","overrideSource","spent","rollover","available","pace","targetProgress","rolloverPeriodsWalked"],"properties":{"budgetId":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"budgets.items.[INDEX].budgetId","typeLabel":"string\u003cuuid>"},"targetType":{"type":"string","enum":["category","category_group"],"isRequired":true,"uniqueKey":"budgets.items.[INDEX].targetType","typeLabel":"enum\u003cstring>"},"categoryId":{"oneOf":[{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"budgets.items.[INDEX].categoryId.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","format":"uuid","isRequired":true,"uniqueKey":"budgets.items.[INDEX].categoryId.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"budgets.items.[INDEX].categoryId","typeLabel":"string\u003cuuid> | null"},"categoryGroupId":{"oneOf":[{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"budgets.items.[INDEX].categoryGroupId.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","format":"uuid","isRequired":true,"uniqueKey":"budgets.items.[INDEX].categoryGroupId.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"budgets.items.[INDEX].categoryGroupId","typeLabel":"string\u003cuuid> | null"},"name":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"budgets.items.[INDEX].name.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"budgets.items.[INDEX].name.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"budgets.items.[INDEX].name","typeLabel":"string | null"},"categoryIds":{"type":"array","items":{"type":"string","format":"uuid","uniqueKey":"budgets.items.[INDEX].categoryIds.items.[INDEX]","typeLabel":"string\u003cuuid>"},"description":"Categories whose spend counts toward this budget","isRequired":true,"uniqueKey":"budgets.items.[INDEX].categoryIds","typeLabel":"string\u003cuuid>[]"},"rolloverEnabled":{"type":"boolean","isRequired":true,"uniqueKey":"budgets.items.[INDEX].rolloverEnabled","typeLabel":"boolean"},"planned":{"type":"number","isRequired":true,"uniqueKey":"budgets.items.[INDEX].planned","typeLabel":"number"},"plannedSource":{"type":"string","enum":["template","override","unassigned"],"description":"`unassigned` is an envelope plan's month with nothing assigned, so `planned` is 0.","isRequired":true,"uniqueKey":"budgets.items.[INDEX].plannedSource","typeLabel":"enum\u003cstring>"},"suggestedAmount":{"oneOf":[{"type":"number","description":"Envelope plans: the template, as a quick-fill suggestion","isRequired":true,"uniqueKey":"budgets.items.[INDEX].suggestedAmount.oneOf.0","typeLabel":"number"},{"type":"null","description":"Envelope plans: the template, as a quick-fill suggestion","isRequired":true,"uniqueKey":"budgets.items.[INDEX].suggestedAmount.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"budgets.items.[INDEX].suggestedAmount","typeLabel":"number | null"},"overrideSource":{"oneOf":[{"type":"string","enum":["user_edited","snapshot"],"isRequired":true,"uniqueKey":"budgets.items.[INDEX].overrideSource.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["user_edited","snapshot"],"isRequired":true,"uniqueKey":"budgets.items.[INDEX].overrideSource.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"budgets.items.[INDEX].overrideSource","typeLabel":"enum\u003cstring> | null"},"spent":{"type":"number","isRequired":true,"uniqueKey":"budgets.items.[INDEX].spent","typeLabel":"number"},"rollover":{"type":"number","isRequired":true,"uniqueKey":"budgets.items.[INDEX].rollover","typeLabel":"number"},"available":{"type":"number","description":"What's left. Negative when overspent.","isRequired":true,"uniqueKey":"budgets.items.[INDEX].available","typeLabel":"number"},"pace":{"type":"object","required":["periodElapsedRatio","spentRatio","status","projectedSpend"],"properties":{"periodElapsedRatio":{"type":"number","isRequired":true,"uniqueKey":"budgets.items.[INDEX].pace.periodElapsedRatio","typeLabel":"number"},"spentRatio":{"oneOf":[{"type":"number","isRequired":true,"uniqueKey":"budgets.items.[INDEX].pace.spentRatio.oneOf.0","typeLabel":"number"},{"type":"null","isRequired":true,"uniqueKey":"budgets.items.[INDEX].pace.spentRatio.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"budgets.items.[INDEX].pace.spentRatio","typeLabel":"number | null"},"status":{"type":"string","enum":["under","on_track","over","unknown"],"isRequired":true,"uniqueKey":"budgets.items.[INDEX].pace.status","typeLabel":"enum\u003cstring>"},"projectedSpend":{"oneOf":[{"type":"number","isRequired":true,"uniqueKey":"budgets.items.[INDEX].pace.projectedSpend.oneOf.0","typeLabel":"number"},{"type":"null","isRequired":true,"uniqueKey":"budgets.items.[INDEX].pace.projectedSpend.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"budgets.items.[INDEX].pace.projectedSpend","typeLabel":"number | null"}},"isRequired":true,"uniqueKey":"budgets.items.[INDEX].pace","typeLabel":"object"},"targetProgress":{"oneOf":[{"type":"object","required":["targetAmount","targetDate","currentAmount","remainingAmount","progressRatio","isMet","periodsRemaining","requiredPerPeriod"],"properties":{"targetAmount":{"type":"number","isRequired":true,"uniqueKey":"budgets.items.[INDEX].targetProgress.oneOf.0.targetAmount","typeLabel":"number"},"targetDate":{"oneOf":[{"type":"string","format":"date","isRequired":true,"uniqueKey":"budgets.items.[INDEX].targetProgress.oneOf.0.targetDate.oneOf.0","typeLabel":"string\u003cdate>"},{"type":"null","format":"date","isRequired":true,"uniqueKey":"budgets.items.[INDEX].targetProgress.oneOf.0.targetDate.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"budgets.items.[INDEX].targetProgress.oneOf.0.targetDate","typeLabel":"string\u003cdate> | null"},"currentAmount":{"type":"number","isRequired":true,"uniqueKey":"budgets.items.[INDEX].targetProgress.oneOf.0.currentAmount","typeLabel":"number"},"remainingAmount":{"type":"number","isRequired":true,"uniqueKey":"budgets.items.[INDEX].targetProgress.oneOf.0.remainingAmount","typeLabel":"number"},"progressRatio":{"oneOf":[{"type":"number","isRequired":true,"uniqueKey":"budgets.items.[INDEX].targetProgress.oneOf.0.progressRatio.oneOf.0","typeLabel":"number"},{"type":"null","isRequired":true,"uniqueKey":"budgets.items.[INDEX].targetProgress.oneOf.0.progressRatio.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"budgets.items.[INDEX].targetProgress.oneOf.0.progressRatio","typeLabel":"number | null"},"isMet":{"type":"boolean","isRequired":true,"uniqueKey":"budgets.items.[INDEX].targetProgress.oneOf.0.isMet","typeLabel":"boolean"},"periodsRemaining":{"oneOf":[{"type":"integer","isRequired":true,"uniqueKey":"budgets.items.[INDEX].targetProgress.oneOf.0.periodsRemaining.oneOf.0","typeLabel":"integer"},{"type":"null","isRequired":true,"uniqueKey":"budgets.items.[INDEX].targetProgress.oneOf.0.periodsRemaining.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"budgets.items.[INDEX].targetProgress.oneOf.0.periodsRemaining","typeLabel":"integer | null"},"requiredPerPeriod":{"oneOf":[{"type":"number","isRequired":true,"uniqueKey":"budgets.items.[INDEX].targetProgress.oneOf.0.requiredPerPeriod.oneOf.0","typeLabel":"number"},{"type":"null","isRequired":true,"uniqueKey":"budgets.items.[INDEX].targetProgress.oneOf.0.requiredPerPeriod.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"budgets.items.[INDEX].targetProgress.oneOf.0.requiredPerPeriod","typeLabel":"number | null"}},"isRequired":true,"uniqueKey":"budgets.items.[INDEX].targetProgress.oneOf.0","typeLabel":"object"},{"type":"null","required":["targetAmount","targetDate","currentAmount","remainingAmount","progressRatio","isMet","periodsRemaining","requiredPerPeriod"],"properties":{"targetAmount":{"type":"number"},"targetDate":{"oneOf":[{"type":"string","format":"date"},{"type":"null","format":"date"}]},"currentAmount":{"type":"number"},"remainingAmount":{"type":"number"},"progressRatio":{"oneOf":[{"type":"number"},{"type":"null"}]},"isMet":{"type":"boolean"},"periodsRemaining":{"oneOf":[{"type":"integer"},{"type":"null"}]},"requiredPerPeriod":{"oneOf":[{"type":"number"},{"type":"null"}]}},"isRequired":true,"uniqueKey":"budgets.items.[INDEX].targetProgress.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"budgets.items.[INDEX].targetProgress","typeLabel":"object | null"},"rolloverPeriodsWalked":{"type":"integer","isRequired":true,"uniqueKey":"budgets.items.[INDEX].rolloverPeriodsWalked","typeLabel":"integer"}},"uniqueKey":"budgets.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"budgets","typeLabel":"object[]"},"unbudgeted":{"type":"array","items":{"type":"object","required":["categoryId","name","categoryGroupId","spent"],"properties":{"categoryId":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"unbudgeted.items.[INDEX].categoryId","typeLabel":"string\u003cuuid>"},"name":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"unbudgeted.items.[INDEX].name.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"unbudgeted.items.[INDEX].name.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"unbudgeted.items.[INDEX].name","typeLabel":"string | null"},"categoryGroupId":{"oneOf":[{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"unbudgeted.items.[INDEX].categoryGroupId.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","format":"uuid","isRequired":true,"uniqueKey":"unbudgeted.items.[INDEX].categoryGroupId.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"unbudgeted.items.[INDEX].categoryGroupId","typeLabel":"string\u003cuuid> | null"},"spent":{"type":"number","isRequired":true,"uniqueKey":"unbudgeted.items.[INDEX].spent","typeLabel":"number"}},"uniqueKey":"unbudgeted.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"unbudgeted","typeLabel":"object[]"},"paymentEnvelopes":{"type":"array","description":"One per credit card in an envelope plan's accounts. Otherwise empty.","items":{"type":"object","required":["budgetId","accountId","name","assigned","rollover","movedIn","paid","available","owed"],"properties":{"budgetId":{"oneOf":[{"type":"string","format":"uuid","description":"Null until the first assignment","isRequired":true,"uniqueKey":"paymentEnvelopes.items.[INDEX].budgetId.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","format":"uuid","description":"Null until the first assignment","isRequired":true,"uniqueKey":"paymentEnvelopes.items.[INDEX].budgetId.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"paymentEnvelopes.items.[INDEX].budgetId","typeLabel":"string\u003cuuid> | null"},"accountId":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"paymentEnvelopes.items.[INDEX].accountId","typeLabel":"string\u003cuuid>"},"name":{"type":"string","isRequired":true,"uniqueKey":"paymentEnvelopes.items.[INDEX].name","typeLabel":"string"},"assigned":{"type":"number","isRequired":true,"uniqueKey":"paymentEnvelopes.items.[INDEX].assigned","typeLabel":"number"},"rollover":{"type":"number","description":"Carried from earlier months","isRequired":true,"uniqueKey":"paymentEnvelopes.items.[INDEX].rollover","typeLabel":"number"},"movedIn":{"type":"number","description":"Budgeted spend on this card this month, net of refunds","isRequired":true,"uniqueKey":"paymentEnvelopes.items.[INDEX].movedIn","typeLabel":"number"},"paid":{"type":"number","isRequired":true,"uniqueKey":"paymentEnvelopes.items.[INDEX].paid","typeLabel":"number"},"available":{"type":"number","description":"What's set aside for the payment","isRequired":true,"uniqueKey":"paymentEnvelopes.items.[INDEX].available","typeLabel":"number"},"owed":{"type":"number","description":"The card's current balance, whichever month this is. Not subtracted from `readyToAssign`.","isRequired":true,"uniqueKey":"paymentEnvelopes.items.[INDEX].owed","typeLabel":"number"}},"uniqueKey":"paymentEnvelopes.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"paymentEnvelopes","typeLabel":"object[]"},"unrecognizedCardInflows":{"oneOf":[{"type":"object","description":"This month's inflows on a card in an income category or with no category. Null for standard plans.","required":["count","amount"],"properties":{"count":{"type":"integer","isRequired":true,"uniqueKey":"unrecognizedCardInflows.oneOf.0.count","typeLabel":"integer"},"amount":{"type":"number","isRequired":true,"uniqueKey":"unrecognizedCardInflows.oneOf.0.amount","typeLabel":"number"}},"isRequired":true,"uniqueKey":"unrecognizedCardInflows.oneOf.0","typeLabel":"object"},{"type":"null","description":"This month's inflows on a card in an income category or with no category. Null for standard plans.","required":["count","amount"],"properties":{"count":{"type":"integer"},"amount":{"type":"number"}},"isRequired":true,"uniqueKey":"unrecognizedCardInflows.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"unrecognizedCardInflows","typeLabel":"object | null"},"meta":{"type":"object","required":["planCount","budgetCount","rolloverBudgetCount","maxRolloverPeriodsWalked","totalRolloverPeriodsWalked","rolloverWalkTruncated","queryCount"],"properties":{"planCount":{"type":"integer","isRequired":true,"uniqueKey":"meta.planCount","typeLabel":"integer"},"budgetCount":{"type":"integer","isRequired":true,"uniqueKey":"meta.budgetCount","typeLabel":"integer"},"rolloverBudgetCount":{"type":"integer","isRequired":true,"uniqueKey":"meta.rolloverBudgetCount","typeLabel":"integer"},"maxRolloverPeriodsWalked":{"type":"integer","isRequired":true,"uniqueKey":"meta.maxRolloverPeriodsWalked","typeLabel":"integer"},"totalRolloverPeriodsWalked":{"type":"integer","isRequired":true,"uniqueKey":"meta.totalRolloverPeriodsWalked","typeLabel":"integer"},"rolloverWalkTruncated":{"type":"boolean","isRequired":true,"uniqueKey":"meta.rolloverWalkTruncated","typeLabel":"boolean"},"queryCount":{"type":"integer","isRequired":true,"uniqueKey":"meta.queryCount","typeLabel":"integer"}},"isRequired":true,"uniqueKey":"meta","typeLabel":"object"},"includesAccountsOutsideConsent":{"type":"boolean","description":"True when the totals include accounts this key was not granted","isRequired":true,"uniqueKey":"includesAccountsOutsideConsent","typeLabel":"boolean"},"accountsOutsideConsent":{"type":"array","items":{"type":"object","required":["id","name"],"properties":{"id":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"accountsOutsideConsent.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"name":{"type":"string","isRequired":true,"uniqueKey":"accountsOutsideConsent.items.[INDEX].name","typeLabel":"string"}},"uniqueKey":"accountsOutsideConsent.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"accountsOutsideConsent","typeLabel":"object[]"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"planId":"3c90c3cc-0d44-4b50-8888-8dd25736052a","plan":{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","name":"\u003cstring>","method":"standard","accountScope":"All","isDefault":true},"period":{"key":"2026-11","cadence":"monthly","startDate":"2023-12-25","endDate":"2023-12-25"},"currency":"\u003cstring>","totals":{"planned":123,"spent":123,"rollover":123,"available":123,"unbudgetedSpent":123,"uncategorizedSpent":123,"totalSpent":123},"readyToAssign":123,"balancesAsOf":"2023-11-07T05:31:56Z","budgets":[{"budgetId":"3c90c3cc-0d44-4b50-8888-8dd25736052a","targetType":"category","categoryId":"3c90c3cc-0d44-4b50-8888-8dd25736052a","categoryGroupId":"3c90c3cc-0d44-4b50-8888-8dd25736052a","name":"\u003cstring>","categoryIds":["3c90c3cc-0d44-4b50-8888-8dd25736052a"],"rolloverEnabled":true,"planned":123,"plannedSource":"template","suggestedAmount":123,"overrideSource":"user_edited","spent":123,"rollover":123,"available":123,"pace":{"periodElapsedRatio":123,"spentRatio":123,"status":"under","projectedSpend":123},"targetProgress":{"targetAmount":123,"targetDate":"2023-12-25","currentAmount":123,"remainingAmount":123,"progressRatio":123,"isMet":true,"periodsRemaining":123,"requiredPerPeriod":123},"rolloverPeriodsWalked":123}],"unbudgeted":[{"categoryId":"3c90c3cc-0d44-4b50-8888-8dd25736052a","name":"\u003cstring>","categoryGroupId":"3c90c3cc-0d44-4b50-8888-8dd25736052a","spent":123}],"paymentEnvelopes":[{"budgetId":"3c90c3cc-0d44-4b50-8888-8dd25736052a","accountId":"3c90c3cc-0d44-4b50-8888-8dd25736052a","name":"\u003cstring>","assigned":123,"rollover":123,"movedIn":123,"paid":123,"available":123,"owed":123}],"unrecognizedCardInflows":{"count":123,"amount":123},"meta":{"planCount":123,"budgetCount":123,"rolloverBudgetCount":123,"maxRolloverPeriodsWalked":123,"totalRolloverPeriodsWalked":123,"rolloverWalkTruncated":true,"queryCount":123},"includesAccountsOutsideConsent":true,"accountsOutsideConsent":[{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","name":"\u003cstring>"}]}}},"exampleType":"generated"}},"exampleType":"generated"},"3bb84825-ec3a-4be7-8977-42338db02a2c":{"description":"Invalid period or query parameters","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","example":"STORAGE_MODE_REQUIRED","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"STORAGE_MODE_REQUIRED","message":"\u003cstring>"}}}},"exampleType":"generated"}},"exampleType":"generated"},"0e5d58eb-7116-4617-acce-eb0edfc34269":{"description":"Missing or invalid API key","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"string","example":"Missing or invalid Authorization header","isRequired":true,"uniqueKey":"error","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"Missing or invalid Authorization header"}}},"exampleType":"generated"}},"exampleType":"generated"},"ee3b2e5e-b007-4f8b-ac21-b098dc3fcff0":{"description":"Storage mode required or subscription inactive","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","example":"STORAGE_MODE_REQUIRED","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"STORAGE_MODE_REQUIRED","message":"\u003cstring>"}}}},"exampleType":"generated"}},"exampleType":"generated"},"5d317f69-5dc8-4539-8403-09db08d48cf4":{"description":"`NOT_FOUND`. The plan, budget, category or account does not exist, or budgets are not enabled for this account yet. A bad plan lists the user's plan names in `message`.","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","example":"STORAGE_MODE_REQUIRED","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"STORAGE_MODE_REQUIRED","message":"\u003cstring>"}}}},"exampleType":"generated"}},"exampleType":"generated"},"5370113e-250c-4310-a788-697654ebf5f6":{"description":"Rate limit exceeded","headers":{"Retry-After":{"description":"Seconds until the rate-limit window resets","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","example":"STORAGE_MODE_REQUIRED","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"example":{"error":{"code":"RATE_LIMITED","message":"Per-minute rate limit exceeded (standard plan)"}},"examples":{"Example":{"title":"Example","value":{"error":{"code":"RATE_LIMITED","message":"Per-minute rate limit exceeded (standard plan)"}}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"46ee374d-16db-4024-a9d8-68134c916743":{"bearerAuth":{"type":"http","scheme":"bearer","description":"A Finta API key from API settings, or an OAuth access token issued to an authorized app. Send either as `Authorization: Bearer \u003ctoken>`.","scopes":[],"schemeName":"bearerAuth"}}},"servers":{"a695617d-a24b-4d79-8001-f41ee3fdb0cc":{"url":"https://api.finta.io/v2","description":"Production server"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","description":"A Finta API key from API settings, or an OAuth access token issued to an authorized app. Send either as `Authorization: Bearer \u003ctoken>`.","scopes":[],"schemeName":"bearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"A Finta API key from API settings, or an OAuth access token issued to an authorized app. Send either as `Authorization: Bearer \u003ctoken>`.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"}]},"originalFileLocation":"api/v2/openapi.json"},"subdomain":"finta-10","siteName":"Finta","title":"Get budget status - Finta","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-02T03:54:43.065Z","originalFileLocation":"api-reference/budgets/get-budget-status.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Returns planned, spent, rollover, available and pace for each budget in one plan and month, plus totals and spending no budget covers. Envelope plans also return readyToAssign, paymentEnvelopes and unrecognizedCardInflows. Finta computes every number at request time and counts only the plan\u0026#x27;s accounts. When includesAccountsOutsideConsent is true, the totals include accounts this key was not granted, named in accountsOutsideConsent, and their transactions stay unavailable to it. plan is null if the user has no budgets yet.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Finta\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/finta-10/Jt7kz6C6qwcjCWVy/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/finta-10/Jt7kz6C6qwcjCWVy/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/finta-10/Jt7kz6C6qwcjCWVy/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/finta-10/Jt7kz6C6qwcjCWVy/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/finta-10/Jt7kz6C6qwcjCWVy/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/finta-10/Jt7kz6C6qwcjCWVy/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/finta-10/Jt7kz6C6qwcjCWVy/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/finta-10/Jt7kz6C6qwcjCWVy/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/finta-10/Jt7kz6C6qwcjCWVy/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Get budget status - Finta\">\u003cmeta data-mint-head property=\"og:description\" content=\"Returns planned, spent, rollover, available and pace for each budget in one plan and month, plus totals and spending no budget covers. Envelope plans also return readyToAssign, paymentEnvelopes and unrecognizedCardInflows. Finta computes every number at request time and counts only the plan\u0026#x27;s accounts. When includesAccountsOutsideConsent is true, the totals include accounts this key was not granted, named in accountsOutsideConsent, and their transactions stay unavailable to it. plan is null if the user has no budgets yet.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Finta\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.finta.io/api-reference/budgets/get-budget-status\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://finta-10.mintlify.app/_mintlify/api/og/v2?division=Budgets\u0026amp;title=Get+budget+status\u0026amp;description=Returns+planned%2C+spent%2C+rollover%2C+available+and+pace+for+each+budget+in+one+plan+and+month%2C+plus+totals+and+spending+no+budget+covers.+Envelope+plans+also+retur\u0026amp;theme=ce8291f76a2c0db9e1376b0f\u0026amp;signature=0d4cc3fc065d00ef0bbfdac0c8b8a4b0fbd7ae501bc1e63c2418623a32023499\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Get budget status - Finta\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Returns planned, spent, rollover, available and pace for each budget in one plan and month, plus totals and spending no budget covers. Envelope plans also return readyToAssign, paymentEnvelopes and unrecognizedCardInflows. Finta computes every number at request time and counts only the plan\u0026#x27;s accounts. When includesAccountsOutsideConsent is true, the totals include accounts this key was not granted, named in accountsOutsideConsent, and their transactions stay unavailable to it. plan is null if the user has no budgets yet.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://finta-10.mintlify.app/_mintlify/api/og/v2?division=Budgets\u0026amp;title=Get+budget+status\u0026amp;description=Returns+planned%2C+spent%2C+rollover%2C+available+and+pace+for+each+budget+in+one+plan+and+month%2C+plus+totals+and+spending+no+budget+covers.+Envelope+plans+also+retur\u0026amp;theme=ce8291f76a2c0db9e1376b0f\u0026amp;signature=0d4cc3fc065d00ef0bbfdac0c8b8a4b0fbd7ae501bc1e63c2418623a32023499\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/finta-10/Jt7kz6C6qwcjCWVy/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Finta\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#6E56CF\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.finta.io/api-reference/budgets/get-budget-status\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/budgets/get-budget-status.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.finta.io/#organization\",\"name\":\"Finta\",\"url\":\"https://docs.finta.io\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/finta-10/K_IMUIs0cBRtaWOM/logo/finta-logo-black-text.svg?fit=max\u0026auto=format\u0026n=K_IMUIs0cBRtaWOM\u0026q=85\u0026s=5a36e554ada8ffbb5ce2af670ed6c896\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.finta.io#website\",\"name\":\"Finta\",\"url\":\"https://docs.finta.io\",\"publisher\":{\"@id\":\"https://docs.finta.io/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.finta.io/api-reference/budgets/get-budget-status#webpage\",\"url\":\"https://docs.finta.io/api-reference/budgets/get-budget-status\",\"name\":\"Get budget status\",\"description\":\"Returns planned, spent, rollover, available and pace for each budget in one plan and month, plus totals and spending no budget covers. Envelope plans also return readyToAssign, paymentEnvelopes and unrecognizedCardInflows. Finta computes every number at request time and counts only the plan's accounts. When includesAccountsOutsideConsent is true, the totals include accounts this key was not granted, named in accountsOutsideConsent, and their transactions stay unavailable to it. plan is null if the user has no budgets yet.\",\"dateModified\":\"2026-11-02T03:54:43.065Z\",\"isPartOf\":{\"@id\":\"https://docs.finta.io#website\"},\"breadcrumb\":{\"@id\":\"https://docs.finta.io/api-reference/budgets/get-budget-status#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.finta.io/api-reference/budgets/get-budget-status#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Reference\",\"item\":\"https://docs.finta.io/api-reference/health/health-check\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Budgets\",\"item\":\"https://docs.finta.io/api-reference/budgets/list-budget-plans\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Get budget status\",\"item\":\"https://docs.finta.io/api-reference/budgets/get-budget-status\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.finta.io/api-reference/budgets/get-budget-status#apireference\",\"headline\":\"Get budget status\",\"name\":\"Get budget status\",\"description\":\"Returns planned, spent, rollover, available and pace for each budget in one plan and month, plus totals and spending no budget covers. Envelope plans also return readyToAssign, paymentEnvelopes and unrecognizedCardInflows. Finta computes every number at request time and counts only the plan's accounts. When includesAccountsOutsideConsent is true, the totals include accounts this key was not granted, named in accountsOutsideConsent, and their transactions stay unavailable to it. plan is null if the user has no budgets yet.\",\"url\":\"https://docs.finta.io/api-reference/budgets/get-budget-status\",\"mainEntityOfPage\":{\"@id\":\"https://docs.finta.io/api-reference/budgets/get-budget-status#webpage\"},\"dateModified\":\"2026-11-02T03:54:43.065Z\",\"publisher\":{\"@id\":\"https://docs.finta.io/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.finta.io#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Finta\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Finta","nav":{"global":{"anchors":[{"anchor":"Community","icon":"discord","href":"https://link.finta.io/discord"}]},"tabs":[{"tab":"Documentation","icon":"book-open","pages":[{"title":"Documentation","href":"/introduction"}]},{"tab":"API","icon":"code","groups":[{"group":"API","pages":[{"title":"Overview","href":"/api/v2/overview"},{"title":"Authentication","href":"/api/v2/authentication"},{"title":"API Keys","href":"/api/v2/api-keys"},{"title":"Data Types","href":"/api/v2/data-types"},{"title":"Budgets","href":"/api/v2/budgets"}]},{"group":"Reference","pages":[{"group":"Health","pages":[{"title":"Health Check","deprecated":null,"version":null,"openapi":"/api/v2/openapi.json get /health","href":"/api-reference/health/health-check"}]},{"group":"Bank Connections","pages":[{"title":"List bank connections","deprecated":null,"version":null,"openapi":"/api/v2/openapi.json get /bank-connections","href":"/api-reference/bank-connections/list-bank-connections"}]},{"group":"Me","pages":[{"title":"Current API user","deprecated":null,"version":null,"openapi":"/api/v2/openapi.json get /me","href":"/api-reference/me/current-api-user"}]},{"group":"Accounts","pages":[{"title":"List accounts","deprecated":null,"version":null,"openapi":"/api/v2/openapi.json get /accounts","href":"/api-reference/accounts/list-accounts"},{"title":"Create a manual account","deprecated":null,"version":null,"openapi":"/api/v2/openapi.json post /accounts","href":"/api-reference/accounts/create-a-manual-account"},{"title":"List balance history","deprecated":null,"version":null,"openapi":"/api/v2/openapi.json get /accounts/balance-history","href":"/api-reference/accounts/list-balance-history"},{"title":"Get account","deprecated":null,"version":null,"openapi":"/api/v2/openapi.json get /accounts/{accountId}","href":"/api-reference/accounts/get-account"},{"title":"Delete a manual account","deprecated":null,"version":null,"openapi":"/api/v2/openapi.json delete /accounts/{accountId}","href":"/api-reference/accounts/delete-a-manual-account"},{"title":"Update a manual account","deprecated":null,"version":null,"openapi":"/api/v2/openapi.json patch /accounts/{accountId}","href":"/api-reference/accounts/update-a-manual-account"},{"title":"List account balance history","deprecated":null,"version":null,"openapi":"/api/v2/openapi.json get /accounts/{accountId}/balance-history","href":"/api-reference/accounts/list-account-balance-history"}]},{"group":"Investments","pages":[{"title":"List securities","deprecated":null,"version":null,"openapi":"/api/v2/openapi.json get /securities","href":"/api-reference/investments/list-securities"},{"title":"List holdings","deprecated":null,"version":null,"openapi":"/api/v2/openapi.json get /holdings","href":"/api-reference/investments/list-holdings"},{"title":"List investment transactions","deprecated":null,"version":null,"openapi":"/api/v2/openapi.json get /investment-transactions","href":"/api-reference/investments/list-investment-transactions"}]},{"group":"Transactions","pages":[{"title":"List transactions","deprecated":null,"version":null,"openapi":"/api/v2/openapi.json get /transactions","href":"/api-reference/transactions/list-transactions"},{"title":"Update a transaction","deprecated":null,"version":null,"openapi":"/api/v2/openapi.json patch /transactions/{id}","href":"/api-reference/transactions/update-a-transaction"},{"title":"Batch update transactions","deprecated":null,"version":null,"openapi":"/api/v2/openapi.json post /transactions/batch","href":"/api-reference/transactions/batch-update-transactions"}]},{"group":"Categories","pages":[{"title":"List categories","deprecated":null,"version":null,"openapi":"/api/v2/openapi.json get /categories","href":"/api-reference/categories/list-categories"},{"title":"Create a category","deprecated":null,"version":null,"openapi":"/api/v2/openapi.json post /categories","href":"/api-reference/categories/create-a-category"},{"title":"Batch update categories","deprecated":null,"version":null,"openapi":"/api/v2/openapi.json post /categories/batch","href":"/api-reference/categories/batch-update-categories"},{"title":"Delete a category","deprecated":null,"version":null,"openapi":"/api/v2/openapi.json delete /categories/{id}","href":"/api-reference/categories/delete-a-category"},{"title":"Update a category","deprecated":null,"version":null,"openapi":"/api/v2/openapi.json patch /categories/{id}","href":"/api-reference/categories/update-a-category"}]},{"group":"Category Groups","pages":[{"title":"List category groups","deprecated":null,"version":null,"openapi":"/api/v2/openapi.json get /category-groups","href":"/api-reference/category-groups/list-category-groups"},{"title":"Create a category group","deprecated":null,"version":null,"openapi":"/api/v2/openapi.json post /category-groups","href":"/api-reference/category-groups/create-a-category-group"},{"title":"Delete a category group","deprecated":null,"version":null,"openapi":"/api/v2/openapi.json delete /category-groups/{id}","href":"/api-reference/category-groups/delete-a-category-group"},{"title":"Update a category group","deprecated":null,"version":null,"openapi":"/api/v2/openapi.json patch /category-groups/{id}","href":"/api-reference/category-groups/update-a-category-group"}]},{"group":"Rules","pages":[{"title":"List transaction rules","deprecated":null,"version":null,"openapi":"/api/v2/openapi.json get /rules","href":"/api-reference/rules/list-transaction-rules"},{"title":"Create a transaction rule","deprecated":null,"version":null,"openapi":"/api/v2/openapi.json post /rules","href":"/api-reference/rules/create-a-transaction-rule"},{"title":"Run transaction rules","deprecated":null,"version":null,"openapi":"/api/v2/openapi.json post /rules/run","href":"/api-reference/rules/run-transaction-rules"},{"title":"Archive a transaction rule","deprecated":null,"version":null,"openapi":"/api/v2/openapi.json delete /rules/{ruleId}","href":"/api-reference/rules/archive-a-transaction-rule"},{"title":"Update a transaction rule","deprecated":null,"version":null,"openapi":"/api/v2/openapi.json patch /rules/{ruleId}","href":"/api-reference/rules/update-a-transaction-rule"}]},{"group":"Budgets","pages":[{"title":"List budget plans","deprecated":null,"version":null,"openapi":"/api/v2/openapi.json get /budget-plans","href":"/api-reference/budgets/list-budget-plans"},{"title":"Create a budget plan","deprecated":null,"version":null,"openapi":"/api/v2/openapi.json post /budget-plans","href":"/api-reference/budgets/create-a-budget-plan"},{"title":"Delete a budget plan","deprecated":null,"version":null,"openapi":"/api/v2/openapi.json delete /budget-plans/{id}","href":"/api-reference/budgets/delete-a-budget-plan"},{"title":"Update a budget plan","deprecated":null,"version":null,"openapi":"/api/v2/openapi.json patch /budget-plans/{id}","href":"/api-reference/budgets/update-a-budget-plan"},{"title":"List budgets","deprecated":null,"version":null,"openapi":"/api/v2/openapi.json get /budgets","href":"/api-reference/budgets/list-budgets"},{"title":"Set a budget","deprecated":null,"version":null,"openapi":"/api/v2/openapi.json post /budgets","href":"/api-reference/budgets/set-a-budget"},{"title":"Move money between budgets","description":"Move an amount between two budgets in the same plan for one month. Changes that month's planned amounts and leaves the template amounts alone. Send an `Idempotency-Key` so a retry doesn't move the money twice.","deprecated":null,"version":null,"openapi":"/api/v2/openapi.json post /budgets/reallocate","href":"/api-reference/budgets/move-money-between-budgets"},{"title":"Get budget status","deprecated":null,"version":null,"openapi":"/api/v2/openapi.json get /budgets/status","href":"/api-reference/budgets/get-budget-status"},{"title":"Delete a budget","description":"Delete a budget and all its per-month amounts. This can't be undone. The category's spending then reports as unbudgeted.","deprecated":null,"version":null,"openapi":"/api/v2/openapi.json delete /budgets/{id}","href":"/api-reference/budgets/delete-a-budget"},{"title":"Update a budget","deprecated":null,"version":null,"openapi":"/api/v2/openapi.json patch /budgets/{id}","href":"/api-reference/budgets/update-a-budget"}]}]}]},{"tab":"MCP","icon":"plug","pages":[{"title":"MCP","href":"/mcp/overview"}]}]},"basePath":"","title":"Get budget status - Finta","buildId":"dpl_DeHjVRGfFnhYQwHnfC2pjeXXv8h9","deploymentId":"dpl_DeHjVRGfFnhYQwHnfC2pjeXXv8h9","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-CS552b7R.js","utils-DDTCYAF2.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-De8ttokP.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-DrwRDvAh.js","snippetPresets-DtAN0nWx.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-D5rWArI6.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-O2i12wsz.js","shallow-DV8xABTt.js","getApiPlaygroundDisplay-DBZ0B5Jx.js","CodeSnippet-BVi0tPUX.js","CodeSnippets-CqASbIwY.js","Page-m07pfKpT.js","getPastedJson-DG9vsMS8.js","icon-CXzRSCr8.js","MethodPill-BdKVtEuX.js","DuplicateIcon-CZlmBrJI.js","createIcon-biFEUKPL.js","DynamicMarkdown-B54_zNBF.js","SectionHeading-DwwHK3Pt.js","axios-vUo_bRtp.js","Markdown-DfhCTwyA.js","clsx-xpJZXxdP.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-BTZUMDnx.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-DqdKa2R4.js"]}