Teal does not enforce any other conventions or patterns on naming schemes; however, we recommend you use concise, descriptive names, especially for financial account ledgers.
Determines the display order in reports, ordered digit by digit, starting from the leftmost position. For example, 20010 will come before 3050.
Teal does not enforce any other conventions or patterns on sort codes. However, it is recommended to adopt a common convention such as starting all ledgers of the same type with the same number (assets start with 1, liabilities start with 2, etc.). The default CoA templates provided by Teal follow best practices for sort code numbering.
Required if financial_account_type is not specified.
Indicates the purpose and location of the funds and value recorded in the ledger and which report it is included in: asset, liability and equity ledgers are displayed on the balance sheet; revenue and expenses are displayed on the income statement.
Required if financial_account_type is not specified.
Whether to include this ledger in cash flow reports. Important: This field can only be updated for ledgers without a financial_account_type. For financial account ledgers, attempting to update this field will result in an error. Recommended values: true for operating accounts (checking, credit card), false for non-operating accounts (loans, investments).
Indicates that the ledger is a system ledger required for Teal to work. These ledgers can be renamed to fit your needs but cannot be deleted. Their behaviour is identified by required_ledger_purpose; see that field's enum for the full set of purposes (e.g. account_transfers, opening_balances, uncat_inflow, uncat_outflow, retained_earnings, current_year_earnings, accounts_receivable, accounts_payable, and the payroll system ledgers).
Whether or not this ledger is included in the cash flow report. For ledgers with a financial_account_type, this value is automatically determined and cannot be modified.
Indicates the purpose and location of the funds and value recorded in the ledger and which report it is included in: asset, liability and equity ledgers are displayed on the balance sheet; revenue and expenses are displayed on the income statement.
Available actions under Teal's ordinary deletion policy. Computed for top-level ledgers in direct ledger responses; null for expanded parents and ledgers embedded in other resources. Delete reasons are stable codes; messages are human-readable explanations. Child ledgers must be deleted first, even when delete.allowed is true. Deletion rechecks eligibility because it can change after this response.
Expandable. If the ledger is a child ledger, the parent ledger object.
{"docsConfig":{"$schema":"https://mintlify.com/docs.json","theme":"mint","name":"Teal","colors":{"primary":"#1E293B","light":"#1E293B","dark":"#1E293B"},"favicon":"https://mintcdn.com/tealplatforms/om5wdJ93k9u6SxcW/favicon.png?fit=max\u0026auto=format\u0026n=om5wdJ93k9u6SxcW\u0026q=85\u0026s=72abd52206475d1fe8e89523087d976d","logo":{"light":"https://mintcdn.com/tealplatforms/ufhJUlAWlrZ-dzAl/logo/dark.svg?fit=max\u0026auto=format\u0026n=ufhJUlAWlrZ-dzAl\u0026q=85\u0026s=f2864cdeef7a8e45083ea99a1454bdf4","dark":"https://mintcdn.com/tealplatforms/ufhJUlAWlrZ-dzAl/logo/dark.svg?fit=max\u0026auto=format\u0026n=ufhJUlAWlrZ-dzAl\u0026q=85\u0026s=f2864cdeef7a8e45083ea99a1454bdf4","href":"https://teal.dev"},"api":{"mdx":{"server":null,"auth":{"method":"bearer","name":null}}},"appearance":{"default":"light","strict":true},"background":{"image":"https://mintlify.s3.us-west-1.amazonaws.com/tealplatforms/background.png","decoration":null,"color":{"light":"#F8FAFC","dark":"#1E293B"}},"navbar":{"links":[],"primary":{"type":"button","label":"Developer Portal","href":"https://developer.teal.dev"}},"styling":{"latex":false},"integrations":{"koala":{"publicApiKey":"pk_98a1ffe3eda6dafde172cefc5681332b75fe"}},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"tealplatforms","hasAudioNarration":false,"actualSubdomain":"tealplatforms","customDomains":["docs.teal.dev"],"gitSource":{"type":"github","owner":"mercurytechnologies","repo":"teal-docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6abc132fa094daac31317329","collectionId":"3e59e3fe-e416-42be-8e28-a086ce0492b4","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6abc132fa094daac31317329"},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6abc132fa094daac31317329","clientVersion":"0.0.4044","searchFilterCounts":[{"language":"default","tag":"API Reference","count":98},{"language":"default","tag":"Teal API Endpoints","count":86},{"language":"default","tag":"Guides","count":27},{"language":"default","tag":"Reports","count":13},{"language":"default","tag":"Tags","count":11},{"language":"default","tag":"Reconciliations","count":9},{"language":"default","tag":"Transactions","count":9},{"language":"default","tag":"Core accounting interfaces","count":9},{"language":"default","tag":"Chart of Accounts Templates","count":8},{"language":"default","tag":"Instances","count":8}]},"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/ledgers/update-a-ledger","slug":"/api-reference/ledgers/update-a-ledger","pageMetadata":{"title":"Update a Ledger","openapi":"PUT /v0/ledgers/{ledger_id}","description":"Updates a Ledger.","href":"/api-reference/ledgers/update-a-ledger"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Updates a Ledger.\"\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":"Update a Ledger","openapi":"PUT /v0/ledgers/{ledger_id}","description":"Updates a Ledger.","href":"/api-reference/ledgers/update-a-ledger"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/tealplatforms/84e6d7ce1b0df358/scripts/cleanup_openapi.js","/_mintlify/custom/tealplatforms/d8fb6eab696d5c42/scripts/scrape_openapi.js"],"openApiReferenceData":{"operation":{"tags":["Ledgers"],"summary":"Update a Ledger","description":"Updates a Ledger.","operationId":"update_ledger_v0_ledgers__ledger_id__put","security":["cf4e3b0d-ebf4-4969-b783-d892c5111484"],"parameters":["3f29ca43-6ced-4c29-a56b-64a104bb86b0","1162d62a-89fa-43de-904e-de84f28934d9","c704f083-0f52-4705-bdc6-ed13c27bb654","4728036b-659e-42db-9a16-e21b0b44ffa2"],"requestBody":"8a1ee1b4-3879-4bc5-a756-91f8bcf5e03b","responses":{"201":"728bcb47-9dfd-4af8-90d9-81568474d7d3","403":"cb00ed86-b778-4e46-ad3f-e33cfd0604eb","404":"7816b8e7-4440-4897-9a78-077d1d0a32ed","422":"310c6b08-684b-4769-94bf-d9ad84953b5e","503":"1d3c0941-b337-45a6-8f5a-a148f15f144a"},"method":"put","type":"path","servers":["d77a5682-df6d-4b53-9e28-211e969535f0","3bfc594c-f680-4779-9599-36cbc72e78ff"],"path":"/v0/ledgers/{ledger_id}","baseUrlOptions":["https://api.sandbox.teal.dev","https://api.teal.dev"],"title":"Update a Ledger","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"3f29ca43-6ced-4c29-a56b-64a104bb86b0":{"name":"ledger_id","in":"path","required":true,"schema":{"type":"string","description":"The ledger ID","title":"Ledger Id","isRequired":true,"uniqueKey":"","typeLabel":"string"},"description":"The ledger ID"},"1162d62a-89fa-43de-904e-de84f28934d9":{"name":"expand","in":"query","required":false,"schema":{"oneOf":[{"type":"array","items":{"type":"string","enum":["parent","parent.parent","details"],"title":"LedgerExpandPath","uniqueKey":"oneOf.0.items.[INDEX]","typeLabel":"enum\u003cstring>"},"title":"Expand","description":"Comma-separated list of Ledger expand paths.","uniqueKey":"oneOf.0","typeLabel":"enum\u003cstring>[]"},{"type":"null","title":"Expand","description":"Comma-separated list of Ledger expand paths.","uniqueKey":"oneOf.1","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"enum\u003cstring>[] | null"},"description":"Comma-separated list of Ledger expand paths."},"c704f083-0f52-4705-bdc6-ed13c27bb654":{"name":"teal-instance-id","in":"header","required":true,"schema":{"type":"string","description":"The Teal instance ID","title":"Teal-Instance-Id","isRequired":true,"uniqueKey":"","typeLabel":"string"},"description":"The Teal instance ID"},"4728036b-659e-42db-9a16-e21b0b44ffa2":{"name":"modified-by","in":"header","required":false,"schema":{"oneOf":[{"type":"string","title":"Modified-By","description":"An optional identifier for audit logging.","uniqueKey":"oneOf.0","typeLabel":"string"},{"type":"null","title":"Modified-By","description":"An optional identifier for audit logging.","uniqueKey":"oneOf.1","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"string | null"},"description":"An optional identifier for audit logging."}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"debit_credit":{"oneOf":[{"type":"string","title":"DebitCredit","description":"Indicates if the ledger is a credit or debit ledger.\n\nRequired if `financial_account_type` is not specified.","enum":["debit","credit"],"example":"debit","uniqueKey":"debit_credit.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","description":"Indicates if the ledger is a credit or debit ledger.\n\nRequired if `financial_account_type` is not specified.","example":"debit","uniqueKey":"debit_credit.oneOf.1","typeLabel":"null"}],"uniqueKey":"debit_credit","typeLabel":"enum\u003cstring> | null"},"name":{"oneOf":[{"type":"string","title":"Name","description":"The name of the ledger.\n\nTeal does not enforce any other conventions or patterns on naming schemes; however, we recommend you use concise, descriptive names, especially for financial account ledgers.","maxLength":255,"example":"Pluto Checking 4242","uniqueKey":"name.oneOf.0","typeLabel":"string"},{"type":"null","title":"Name","description":"The name of the ledger.\n\nTeal does not enforce any other conventions or patterns on naming schemes; however, we recommend you use concise, descriptive names, especially for financial account ledgers.","example":"Pluto Checking 4242","uniqueKey":"name.oneOf.1","typeLabel":"null"}],"uniqueKey":"name","typeLabel":"string | null"},"parent_id":{"oneOf":[{"type":"string","title":"Parent Id","description":"If the ledger is a child Ledger, the ID of the parent ledger object.","example":null,"uniqueKey":"parent_id.oneOf.0","typeLabel":"string"},{"type":"null","title":"Parent Id","description":"If the ledger is a child Ledger, the ID of the parent ledger object.","example":null,"uniqueKey":"parent_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"parent_id","typeLabel":"string | null"},"sort_code":{"oneOf":[{"type":"string","title":"Sort Code","description":"Determines the display order in reports, ordered digit by digit, starting from the leftmost position. For example, `20010` will come before `3050`.\n\nTeal does not enforce any other conventions or patterns on sort codes. However, it is recommended to adopt a common convention such as starting all ledgers of the same type with the same number (assets start with 1, liabilities start with 2, etc.). The default CoA templates provided by Teal follow best practices for sort code numbering.\n\nRequired if `financial_account_type` is not specified.","maxLength":20,"pattern":"^[0-9]+$","example":"1400","uniqueKey":"sort_code.oneOf.0","typeLabel":"string"},{"type":"null","title":"Sort Code","description":"Determines the display order in reports, ordered digit by digit, starting from the leftmost position. For example, `20010` will come before `3050`.\n\nTeal does not enforce any other conventions or patterns on sort codes. However, it is recommended to adopt a common convention such as starting all ledgers of the same type with the same number (assets start with 1, liabilities start with 2, etc.). The default CoA templates provided by Teal follow best practices for sort code numbering.\n\nRequired if `financial_account_type` is not specified.","example":"1400","uniqueKey":"sort_code.oneOf.1","typeLabel":"null"}],"uniqueKey":"sort_code","typeLabel":"string | null"},"sub_type":{"oneOf":[{"type":"string","title":"LedgerSubType","description":"Indicates similar characteristics and accounting treatment for a group of ledgers within a `type`.\n\nRequired if `financial_account_type` is not specified.","enum":["current_assets","non-current_assets","transfers_between_accounts","uncategorized_assets","current_liabilities","non-current_liabilities","equity","operating_revenues","other_income","cost_of_goods_sold","operating_expenses","other_expenses","retained_earnings"],"example":"current_assets","uniqueKey":"sub_type.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","description":"Indicates similar characteristics and accounting treatment for a group of ledgers within a `type`.\n\nRequired if `financial_account_type` is not specified.","example":"current_assets","uniqueKey":"sub_type.oneOf.1","typeLabel":"null"}],"uniqueKey":"sub_type","typeLabel":"enum\u003cstring> | null"},"type":{"oneOf":[{"type":"string","title":"LedgerType","description":"Indicates the purpose and location of the funds and value recorded in the ledger and which report it is included in: `asset`, `liability` and `equity` ledgers are displayed on the balance sheet; `revenue` and `expenses` are displayed on the income statement.\n\nRequired if `financial_account_type` is not specified.","enum":["asset","liability","equity","revenue","expense"],"example":"asset","uniqueKey":"type.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","description":"Indicates the purpose and location of the funds and value recorded in the ledger and which report it is included in: `asset`, `liability` and `equity` ledgers are displayed on the balance sheet; `revenue` and `expenses` are displayed on the income statement.\n\nRequired if `financial_account_type` is not specified.","example":"asset","uniqueKey":"type.oneOf.1","typeLabel":"null"}],"uniqueKey":"type","typeLabel":"enum\u003cstring> | null"},"report_cash_flow":{"oneOf":[{"type":"boolean","title":"Report Cash Flow","description":"Whether to include this ledger in cash flow reports. **Important:** This field can only be updated for ledgers without a `financial_account_type`. For financial account ledgers, attempting to update this field will result in an error. Recommended values: true for operating accounts (checking, credit card), false for non-operating accounts (loans, investments).","example":true,"uniqueKey":"report_cash_flow.oneOf.0","typeLabel":"boolean"},{"type":"null","title":"Report Cash Flow","description":"Whether to include this ledger in cash flow reports. **Important:** This field can only be updated for ledgers without a `financial_account_type`. For financial account ledgers, attempting to update this field will result in an error. Recommended values: true for operating accounts (checking, credit card), false for non-operating accounts (loans, investments).","example":true,"uniqueKey":"report_cash_flow.oneOf.1","typeLabel":"null"}],"uniqueKey":"report_cash_flow","typeLabel":"boolean | null"},"clear_fields":{"oneOf":[{"type":"array","items":{"type":"string","enum":["parent_id"],"title":"LedgerClearField","uniqueKey":"clear_fields.oneOf.0.items.[INDEX]","typeLabel":"enum\u003cstring>"},"title":"Clear Fields","description":"A list of fields to be cleared.","example":["parent_id"],"uniqueKey":"clear_fields.oneOf.0","typeLabel":"enum\u003cstring>[]"},{"type":"null","title":"Clear Fields","description":"A list of fields to be cleared.","example":["parent_id"],"uniqueKey":"clear_fields.oneOf.1","typeLabel":"null"}],"uniqueKey":"clear_fields","typeLabel":"enum\u003cstring>[] | null"}},"type":"object","title":"LedgerUpdate","uniqueKey":"","typeLabel":"LedgerUpdate · object"},"examples":{"Example":{"title":"Example","value":{"debit_credit":"debit","name":"Pluto Checking 4242","parent_id":null,"sort_code":"1400","sub_type":"current_assets","type":"asset","report_cash_flow":true,"clear_fields":["parent_id"]}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"728bcb47-9dfd-4af8-90d9-81568474d7d3":{"description":"Successful Response","content":{"application/json":{"schema":{"properties":{"id":{"type":"string","title":"Id","description":"The unique ID of the object.","examples":["7JRNsKwy2Lw66caxVU7WGC"],"isRequired":true,"uniqueKey":"id","typeLabel":"string"},"name":{"type":"string","maxLength":255,"title":"Name","description":"The name of the ledger.","examples":["Pluto Checking 4242"],"isRequired":true,"uniqueKey":"name","typeLabel":"string"},"debit_credit":{"type":"string","enum":["debit","credit"],"title":"DebitCredit","description":"Indicates if the ledger is a credit or debit ledger.","examples":["debit"],"isRequired":true,"uniqueKey":"debit_credit","typeLabel":"enum\u003cstring>"},"editable":{"type":"boolean","title":"Editable","description":"Whether line entries can be manually added or removed from the ledger.","examples":[false],"isRequired":true,"uniqueKey":"editable","typeLabel":"boolean"},"is_required":{"type":"boolean","title":"Is Required","description":"Indicates that the ledger is a system ledger required for Teal to work. These ledgers can be renamed to fit your needs but cannot be deleted. Their behaviour is identified by `required_ledger_purpose`; see that field's enum for the full set of purposes (e.g. `account_transfers`, `opening_balances`, `uncat_inflow`, `uncat_outflow`, `retained_earnings`, `current_year_earnings`, `accounts_receivable`, `accounts_payable`, and the payroll system ledgers).","examples":[false],"isRequired":true,"uniqueKey":"is_required","typeLabel":"boolean"},"parent_id":{"oneOf":[{"type":"string","title":"Parent Id","description":"If the ledger is a child Ledger, the ID of the parent ledger object.","example":null,"isRequired":true,"uniqueKey":"parent_id.oneOf.0","typeLabel":"string"},{"type":"null","title":"Parent Id","description":"If the ledger is a child Ledger, the ID of the parent ledger object.","example":null,"isRequired":true,"uniqueKey":"parent_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"parent_id","typeLabel":"string | null"},"report_cash_flow":{"type":"boolean","title":"Report Cash Flow","description":"Whether or not this ledger is included in the cash flow report. For ledgers with a financial_account_type, this value is automatically determined and cannot be modified.","examples":[false],"isRequired":true,"uniqueKey":"report_cash_flow","typeLabel":"boolean"},"sort_code":{"type":"string","maxLength":20,"title":"Sort Code","description":"Determines the display order in reports, ordered digit by digit, starting from the leftmost position. For example, `20010` will come before `3050`.","examples":["1400"],"isRequired":true,"uniqueKey":"sort_code","typeLabel":"string"},"sub_type":{"type":"string","enum":["current_assets","non-current_assets","transfers_between_accounts","uncategorized_assets","current_liabilities","non-current_liabilities","equity","operating_revenues","other_income","cost_of_goods_sold","operating_expenses","other_expenses","retained_earnings"],"title":"LedgerSubType","description":"Indicates similar characteristics and accounting treatment for a group of ledgers within a `type`.","examples":["current_assets"],"isRequired":true,"uniqueKey":"sub_type","typeLabel":"enum\u003cstring>"},"type":{"type":"string","enum":["asset","liability","equity","revenue","expense"],"title":"LedgerType","description":"Indicates the purpose and location of the funds and value recorded in the ledger and which report it is included in: `asset`, `liability` and `equity` ledgers are displayed on the balance sheet; `revenue` and `expenses` are displayed on the income statement.","examples":["asset"],"isRequired":true,"uniqueKey":"type","typeLabel":"enum\u003cstring>"},"created_at":{"type":"string","format":"date-time","title":"Created At","description":"The datetime when the ledger was created.","examples":["2024-01-01T00:00:00Z"],"isRequired":true,"uniqueKey":"created_at","typeLabel":"string\u003cdate-time>"},"actions":{"oneOf":[{"type":"object","title":"LedgerActions","description":"Available actions under Teal's ordinary deletion policy. Computed for top-level ledgers in direct ledger responses; null for expanded parents and ledgers embedded in other resources. Delete reasons are stable codes; messages are human-readable explanations. Child ledgers must be deleted first, even when delete.allowed is true. Deletion rechecks eligibility because it can change after this response.","required":["delete"],"properties":{"delete":{"properties":{"allowed":{"type":"boolean","title":"Allowed","isRequired":true,"uniqueKey":"actions.oneOf.0.delete.allowed","typeLabel":"boolean"},"reason":{"oneOf":[{"type":"string","title":"Reason","enum":["required_ledger","has_line_entries","linked_transaction_source"],"uniqueKey":"actions.oneOf.0.delete.reason.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","title":"Reason","uniqueKey":"actions.oneOf.0.delete.reason.oneOf.1","typeLabel":"null"}],"uniqueKey":"actions.oneOf.0.delete.reason","typeLabel":"enum\u003cstring> | null"},"message":{"oneOf":[{"type":"string","title":"Message","uniqueKey":"actions.oneOf.0.delete.message.oneOf.0","typeLabel":"string"},{"type":"null","title":"Message","uniqueKey":"actions.oneOf.0.delete.message.oneOf.1","typeLabel":"null"}],"uniqueKey":"actions.oneOf.0.delete.message","typeLabel":"string | null"}},"type":"object","required":["allowed"],"title":"LedgerDeleteAction","isRequired":true,"uniqueKey":"actions.oneOf.0.delete","typeLabel":"LedgerDeleteAction · object"}},"uniqueKey":"actions.oneOf.0","typeLabel":"LedgerActions · object"},{"type":"null","description":"Available actions under Teal's ordinary deletion policy. Computed for top-level ledgers in direct ledger responses; null for expanded parents and ledgers embedded in other resources. Delete reasons are stable codes; messages are human-readable explanations. Child ledgers must be deleted first, even when delete.allowed is true. Deletion rechecks eligibility because it can change after this response.","uniqueKey":"actions.oneOf.1","typeLabel":"null"}],"uniqueKey":"actions","typeLabel":"LedgerActions · object | null"},"financial_account_type":{"oneOf":[{"type":"string","title":"FinancialAccountType","description":"Indicates that the ledger represents a real-world financial account.","enum":["bank_account","credit_card","payments","payroll","loan","prepaid_card","accounts_receivable","accounts_payable","treasury","investment"],"example":"bank_account","uniqueKey":"financial_account_type.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","description":"Indicates that the ledger represents a real-world financial account.","example":"bank_account","uniqueKey":"financial_account_type.oneOf.1","typeLabel":"null"}],"uniqueKey":"financial_account_type","typeLabel":"enum\u003cstring> | null"},"required_ledger_purpose":{"oneOf":[{"type":"string","title":"SpecialLedgerType","description":"Required ledgers fulfill specific system functions and are necessary for the accounting system to operate.","enum":["uncat_inflow","uncat_outflow","account_transfers","opening_balances","retained_earnings","current_year_earnings","accounts_receivable","accounts_payable","wages_expense","bonus_expense","commissions_expense","contractor_expense","employee_reimbursements","severance_expense","payroll_tax_expense","employer_benefits_expense","health_insurance_expense","benefits_expense","donations_expense","wages_payable","payroll_tax_payable","employee_benefit_liabilities","payroll_liabilities","payroll_adjustments_clearing","benefits_payable","payroll_tax_accruals","stock_exercise_clearing","payroll_clearing"],"example":"account_transfers","uniqueKey":"required_ledger_purpose.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","description":"Required ledgers fulfill specific system functions and are necessary for the accounting system to operate.","example":"account_transfers","uniqueKey":"required_ledger_purpose.oneOf.1","typeLabel":"null"}],"uniqueKey":"required_ledger_purpose","typeLabel":"enum\u003cstring> | null"},"parent":{"oneOf":[{"description":"Expandable. If the ledger is a child ledger, the parent ledger object.","uniqueKey":"parent.oneOf.0","typeLabel":"any"},{"type":"null","description":"Expandable. If the ledger is a child ledger, the parent ledger object.","uniqueKey":"parent.oneOf.1","typeLabel":"null"}],"uniqueKey":"parent","typeLabel":"any | null"}},"type":"object","required":["id","name","debit_credit","editable","is_required","parent_id","report_cash_flow","sort_code","sub_type","type","created_at"],"title":"Ledger","uniqueKey":"","typeLabel":"Ledger · object"},"examples":{"Example":{"title":"Example","value":{"id":"7JRNsKwy2Lw66caxVU7WGC","name":"Pluto Checking 4242","debit_credit":"debit","editable":false,"is_required":false,"parent_id":null,"report_cash_flow":false,"sort_code":"1400","sub_type":"current_assets","type":"asset","created_at":"2024-01-01T00:00:00Z","actions":{"delete":{"allowed":true,"reason":"required_ledger","message":"\u003cstring>"}},"financial_account_type":"bank_account","required_ledger_purpose":"account_transfers","parent":"\u003cunknown>"}}},"exampleType":"generated"}},"exampleType":"generated"},"cb00ed86-b778-4e46-ad3f-e33cfd0604eb":{"content":{"application/json":{"schema":{"properties":{"message":{"oneOf":[{"type":"string","title":"Message","description":"A description of the error for API developers.","isRequired":true,"uniqueKey":"message.oneOf.0","typeLabel":"string"},{"type":"null","title":"Message","description":"A description of the error for API developers.","isRequired":true,"uniqueKey":"message.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"message","typeLabel":"string | null"},"data":{"title":"Data","description":"Data associated with the error.","uniqueKey":"data","typeLabel":"any"},"display_message":{"oneOf":[{"type":"string","title":"Display Message","description":"A description of the error for end users.","uniqueKey":"display_message.oneOf.0","typeLabel":"string"},{"type":"null","title":"Display Message","description":"A description of the error for end users.","uniqueKey":"display_message.oneOf.1","typeLabel":"null"}],"uniqueKey":"display_message","typeLabel":"string | null"},"error_code":{"oneOf":[{"type":"string","title":"TealErrorCode","description":"Error code associated with the error.","enum":["invalid_date","invalid_ledger","invalid_accounting_basis","missing_parameters","duplicate_name","duplicate_sort_code","invalid_ledger_type","invalid_ledger_report_cash_flow","deleting_required_ledger","repeated_tag_group","deleting_transaction_line","modifying_read_only_ledger","debits_credits_not_equal","modifying_opening_balance_journal_entry","modifying_accrual_journal_entry","modifying_payment_application_journal_entry","deleting_accrual_linked_journal_entry","selecting_opening_balance_ledger","invalid_deferral_ledger","payment_exceeds_amount_remaining","line_entry_already_applied","payment_total_mismatch","accrual_source_not_payable","accrual_source_not_found","line_entry_direction_mismatch","duplicate_statement_ending_date","reconciliation_in_progress","reconciliation_gap","reconciliation_overlap","reconciled_balance_does_not_match","journal_entry_outside_reconciliation_period","parsed_statement_balance_mismatch","entries_start_date_after_transactions","entries_start_date_after_reconciliations","entries_start_date_after_journal_entries"],"uniqueKey":"error_code.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","description":"Error code associated with the error.","uniqueKey":"error_code.oneOf.1","typeLabel":"null"}],"uniqueKey":"error_code","typeLabel":"enum\u003cstring> | null"}},"type":"object","required":["message"],"title":"TealErrorResponse","uniqueKey":"","typeLabel":"TealErrorResponse · object"},"examples":{"Example":{"title":"Example","value":{"message":"\u003cstring>","data":"\u003cunknown>","display_message":"\u003cstring>","error_code":"invalid_date"}}},"exampleType":"generated"}},"description":"Forbidden","exampleType":"generated"},"7816b8e7-4440-4897-9a78-077d1d0a32ed":{"content":{"application/json":{"schema":{"properties":{"message":{"oneOf":[{"type":"string","title":"Message","description":"A description of the error for API developers.","isRequired":true,"uniqueKey":"message.oneOf.0","typeLabel":"string"},{"type":"null","title":"Message","description":"A description of the error for API developers.","isRequired":true,"uniqueKey":"message.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"message","typeLabel":"string | null"},"data":{"title":"Data","description":"Data associated with the error.","uniqueKey":"data","typeLabel":"any"},"display_message":{"oneOf":[{"type":"string","title":"Display Message","description":"A description of the error for end users.","uniqueKey":"display_message.oneOf.0","typeLabel":"string"},{"type":"null","title":"Display Message","description":"A description of the error for end users.","uniqueKey":"display_message.oneOf.1","typeLabel":"null"}],"uniqueKey":"display_message","typeLabel":"string | null"},"error_code":{"oneOf":[{"type":"string","title":"TealErrorCode","description":"Error code associated with the error.","enum":["invalid_date","invalid_ledger","invalid_accounting_basis","missing_parameters","duplicate_name","duplicate_sort_code","invalid_ledger_type","invalid_ledger_report_cash_flow","deleting_required_ledger","repeated_tag_group","deleting_transaction_line","modifying_read_only_ledger","debits_credits_not_equal","modifying_opening_balance_journal_entry","modifying_accrual_journal_entry","modifying_payment_application_journal_entry","deleting_accrual_linked_journal_entry","selecting_opening_balance_ledger","invalid_deferral_ledger","payment_exceeds_amount_remaining","line_entry_already_applied","payment_total_mismatch","accrual_source_not_payable","accrual_source_not_found","line_entry_direction_mismatch","duplicate_statement_ending_date","reconciliation_in_progress","reconciliation_gap","reconciliation_overlap","reconciled_balance_does_not_match","journal_entry_outside_reconciliation_period","parsed_statement_balance_mismatch","entries_start_date_after_transactions","entries_start_date_after_reconciliations","entries_start_date_after_journal_entries"],"uniqueKey":"error_code.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","description":"Error code associated with the error.","uniqueKey":"error_code.oneOf.1","typeLabel":"null"}],"uniqueKey":"error_code","typeLabel":"enum\u003cstring> | null"}},"type":"object","required":["message"],"title":"TealErrorResponse","uniqueKey":"","typeLabel":"TealErrorResponse · object"},"examples":{"Example":{"title":"Example","value":{"message":"\u003cstring>","data":"\u003cunknown>","display_message":"\u003cstring>","error_code":"invalid_date"}}},"exampleType":"generated"}},"description":"Not Found","exampleType":"generated"},"310c6b08-684b-4769-94bf-d9ad84953b5e":{"content":{"application/json":{"schema":{"properties":{"message":{"oneOf":[{"type":"string","title":"Message","description":"A description of the error for API developers.","isRequired":true,"uniqueKey":"message.oneOf.0","typeLabel":"string"},{"type":"null","title":"Message","description":"A description of the error for API developers.","isRequired":true,"uniqueKey":"message.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"message","typeLabel":"string | null"},"data":{"title":"Data","description":"Data associated with the error.","uniqueKey":"data","typeLabel":"any"},"display_message":{"oneOf":[{"type":"string","title":"Display Message","description":"A description of the error for end users.","uniqueKey":"display_message.oneOf.0","typeLabel":"string"},{"type":"null","title":"Display Message","description":"A description of the error for end users.","uniqueKey":"display_message.oneOf.1","typeLabel":"null"}],"uniqueKey":"display_message","typeLabel":"string | null"},"error_code":{"oneOf":[{"type":"string","title":"TealErrorCode","description":"Error code associated with the error.","enum":["invalid_date","invalid_ledger","invalid_accounting_basis","missing_parameters","duplicate_name","duplicate_sort_code","invalid_ledger_type","invalid_ledger_report_cash_flow","deleting_required_ledger","repeated_tag_group","deleting_transaction_line","modifying_read_only_ledger","debits_credits_not_equal","modifying_opening_balance_journal_entry","modifying_accrual_journal_entry","modifying_payment_application_journal_entry","deleting_accrual_linked_journal_entry","selecting_opening_balance_ledger","invalid_deferral_ledger","payment_exceeds_amount_remaining","line_entry_already_applied","payment_total_mismatch","accrual_source_not_payable","accrual_source_not_found","line_entry_direction_mismatch","duplicate_statement_ending_date","reconciliation_in_progress","reconciliation_gap","reconciliation_overlap","reconciled_balance_does_not_match","journal_entry_outside_reconciliation_period","parsed_statement_balance_mismatch","entries_start_date_after_transactions","entries_start_date_after_reconciliations","entries_start_date_after_journal_entries"],"uniqueKey":"error_code.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","description":"Error code associated with the error.","uniqueKey":"error_code.oneOf.1","typeLabel":"null"}],"uniqueKey":"error_code","typeLabel":"enum\u003cstring> | null"}},"type":"object","required":["message"],"title":"TealErrorResponse","uniqueKey":"","typeLabel":"TealErrorResponse · object"},"examples":{"Example":{"title":"Example","value":{"message":"\u003cstring>","data":"\u003cunknown>","display_message":"\u003cstring>","error_code":"invalid_date"}}},"exampleType":"generated"}},"description":"Unprocessable Content","exampleType":"generated"},"1d3c0941-b337-45a6-8f5a-a148f15f144a":{"content":{"application/json":{"schema":{"properties":{"message":{"oneOf":[{"type":"string","title":"Message","description":"A description of the error for API developers.","isRequired":true,"uniqueKey":"message.oneOf.0","typeLabel":"string"},{"type":"null","title":"Message","description":"A description of the error for API developers.","isRequired":true,"uniqueKey":"message.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"message","typeLabel":"string | null"},"data":{"title":"Data","description":"Data associated with the error.","uniqueKey":"data","typeLabel":"any"},"display_message":{"oneOf":[{"type":"string","title":"Display Message","description":"A description of the error for end users.","uniqueKey":"display_message.oneOf.0","typeLabel":"string"},{"type":"null","title":"Display Message","description":"A description of the error for end users.","uniqueKey":"display_message.oneOf.1","typeLabel":"null"}],"uniqueKey":"display_message","typeLabel":"string | null"},"error_code":{"oneOf":[{"type":"string","title":"TealErrorCode","description":"Error code associated with the error.","enum":["invalid_date","invalid_ledger","invalid_accounting_basis","missing_parameters","duplicate_name","duplicate_sort_code","invalid_ledger_type","invalid_ledger_report_cash_flow","deleting_required_ledger","repeated_tag_group","deleting_transaction_line","modifying_read_only_ledger","debits_credits_not_equal","modifying_opening_balance_journal_entry","modifying_accrual_journal_entry","modifying_payment_application_journal_entry","deleting_accrual_linked_journal_entry","selecting_opening_balance_ledger","invalid_deferral_ledger","payment_exceeds_amount_remaining","line_entry_already_applied","payment_total_mismatch","accrual_source_not_payable","accrual_source_not_found","line_entry_direction_mismatch","duplicate_statement_ending_date","reconciliation_in_progress","reconciliation_gap","reconciliation_overlap","reconciled_balance_does_not_match","journal_entry_outside_reconciliation_period","parsed_statement_balance_mismatch","entries_start_date_after_transactions","entries_start_date_after_reconciliations","entries_start_date_after_journal_entries"],"uniqueKey":"error_code.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","description":"Error code associated with the error.","uniqueKey":"error_code.oneOf.1","typeLabel":"null"}],"uniqueKey":"error_code","typeLabel":"enum\u003cstring> | null"}},"type":"object","required":["message"],"title":"TealErrorResponse","uniqueKey":"","typeLabel":"TealErrorResponse · object"},"examples":{"Example":{"title":"Example","value":{"message":"\u003cstring>","data":"\u003cunknown>","display_message":"\u003cstring>","error_code":"invalid_date"}}},"exampleType":"generated"}},"description":"Service Unavailable","exampleType":"generated"}},"security":{"cf4e3b0d-ebf4-4969-b783-d892c5111484":{"OAuth2PasswordBearer":{"type":"oauth2","description":"Bearer authentication header of the form Bearer \u003ctoken>, where \u003ctoken> is your auth token.","flows":{"password":{"scopes":{},"tokenUrl":"https://developer.teal.dev"}},"scopes":[]}}},"servers":{"d77a5682-df6d-4b53-9e28-211e969535f0":{"url":"https://api.sandbox.teal.dev","description":"Sandbox"},"3bfc594c-f680-4779-9599-36cbc72e78ff":{"url":"https://api.teal.dev","description":"Production"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"oauth2","description":"Bearer authentication header of the form Bearer \u003ctoken>, where \u003ctoken> is your auth token.","flows":{"password":{"scopes":{},"tokenUrl":"https://developer.teal.dev"}},"scopes":[]},"schema":{"title":"OAuth2 Auth","type":"string","isRequired":true,"description":"Bearer authentication header of the form Bearer \u003ctoken>, where \u003ctoken> is your auth token.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"OAuth2PasswordBearer","name":"Authorization"}],"title":"OAuth2PasswordBearer"}]},"originalFileLocation":"openapi.json"},"subdomain":"tealplatforms","siteName":"Teal","title":"Update a Ledger - Teal","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2025-08-11T22:28:59.417Z","originalFileLocation":"api-reference/ledgers/update-a-ledger.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=\"light\";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=\"light\"}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=\"Updates a Ledger.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Teal\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/tealplatforms/79RJ17q02NVlfCK3/_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/tealplatforms/79RJ17q02NVlfCK3/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/tealplatforms/79RJ17q02NVlfCK3/_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/tealplatforms/79RJ17q02NVlfCK3/_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/tealplatforms/79RJ17q02NVlfCK3/_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/tealplatforms/79RJ17q02NVlfCK3/_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/tealplatforms/79RJ17q02NVlfCK3/_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/tealplatforms/79RJ17q02NVlfCK3/_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/tealplatforms/79RJ17q02NVlfCK3/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Update a Ledger - Teal\">\u003cmeta data-mint-head property=\"og:description\" content=\"Updates a Ledger.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Teal\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.teal.dev/api-reference/ledgers/update-a-ledger\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://tealplatforms.mintlify.app/_mintlify/api/og/v2?division=Ledgers\u0026amp;title=Update+a+Ledger\u0026amp;description=Updates+a+Ledger.\u0026amp;theme=8de3a09bd6716d6473382dd4\u0026amp;signature=cb4851bf97a4332b50c0f35e1f050f6798937039f19c11e6916826bc9c2e79a1\">\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=\"Update a Ledger - Teal\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Updates a Ledger.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://tealplatforms.mintlify.app/_mintlify/api/og/v2?division=Ledgers\u0026amp;title=Update+a+Ledger\u0026amp;description=Updates+a+Ledger.\u0026amp;theme=8de3a09bd6716d6473382dd4\u0026amp;signature=cb4851bf97a4332b50c0f35e1f050f6798937039f19c11e6916826bc9c2e79a1\">\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/tealplatforms/79RJ17q02NVlfCK3/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Teal\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#1E293B\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.teal.dev/api-reference/ledgers/update-a-ledger\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/ledgers/update-a-ledger.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.teal.dev/#organization\",\"name\":\"Teal\",\"url\":\"https://docs.teal.dev\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/tealplatforms/ufhJUlAWlrZ-dzAl/logo/dark.svg?fit=max\u0026auto=format\u0026n=ufhJUlAWlrZ-dzAl\u0026q=85\u0026s=f2864cdeef7a8e45083ea99a1454bdf4\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.teal.dev#website\",\"name\":\"Teal\",\"url\":\"https://docs.teal.dev\",\"publisher\":{\"@id\":\"https://docs.teal.dev/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.teal.dev/api-reference/ledgers/update-a-ledger#webpage\",\"url\":\"https://docs.teal.dev/api-reference/ledgers/update-a-ledger\",\"name\":\"Update a Ledger\",\"description\":\"Updates a Ledger.\",\"dateModified\":\"2025-08-11T22:28:59.417Z\",\"isPartOf\":{\"@id\":\"https://docs.teal.dev#website\"},\"breadcrumb\":{\"@id\":\"https://docs.teal.dev/api-reference/ledgers/update-a-ledger#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.teal.dev/api-reference/ledgers/update-a-ledger#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Teal API Endpoints\",\"item\":\"https://docs.teal.dev/api-reference/chart-of-accounts-templates/create-a-chart-of-accounts-template\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Ledgers\",\"item\":\"https://docs.teal.dev/api-reference/ledgers/list-all-ledgers\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Update a Ledger\",\"item\":\"https://docs.teal.dev/api-reference/ledgers/update-a-ledger\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.teal.dev/api-reference/ledgers/update-a-ledger#apireference\",\"headline\":\"Update a Ledger\",\"name\":\"Update a Ledger\",\"description\":\"Updates a Ledger.\",\"url\":\"https://docs.teal.dev/api-reference/ledgers/update-a-ledger\",\"mainEntityOfPage\":{\"@id\":\"https://docs.teal.dev/api-reference/ledgers/update-a-ledger#webpage\"},\"dateModified\":\"2025-08-11T22:28:59.417Z\",\"publisher\":{\"@id\":\"https://docs.teal.dev/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.teal.dev#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Teal\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Teal","nav":{"global":null,"anchors":[{"anchor":"Guides","icon":"compass","pages":[{"title":"Guides","href":"/guides/introduction/overview"}]},{"anchor":"API Reference","icon":"code","color":{"light":"#1E293B","dark":"#1E293B"},"groups":[{"group":"API overview","pages":[{"title":"Authentication","icon":null,"href":"/api-reference/api-design/authentication"},{"title":"Pagination","icon":null,"href":"/api-reference/api-design/pagination"},{"title":"Expanding responses","href":"/api-reference/api-design/expanding_responses"},{"title":"Instances","icon":null,"href":"/api-reference/api-design/instances"},{"title":"Rate Limits","href":"/api-reference/api-design/rate_limits"}]},{"group":"Teal API Endpoints","pages":[{"group":"Chart of Accounts Templates","pages":[{"title":"Create a Chart of Accounts Template","openapi":"POST /v0/platform-gl/coa-templates","href":"/api-reference/chart-of-accounts-templates/create-a-chart-of-accounts-template"},{"title":"List all Chart of Accounts Templates","openapi":"GET /v0/platform-gl/coa-templates","href":"/api-reference/chart-of-accounts-templates/list-all-chart-of-accounts-templates"},{"title":"Retrieve a Chart of Accounts Template","openapi":"GET /v0/platform-gl/coa-templates/{coa_template_id}","href":"/api-reference/chart-of-accounts-templates/retrieve-a-chart-of-accounts-template"},{"title":"Delete a Chart of Accounts Template","openapi":"DELETE /v0/platform-gl/coa-templates/{coa_template_id}","href":"/api-reference/chart-of-accounts-templates/delete-a-chart-of-accounts-template"},{"title":"Clone a Chart of Accounts Template","openapi":"POST /v0/platform-gl/coa-templates/{coa_template_id}/clone","href":"/api-reference/chart-of-accounts-templates/clone-a-chart-of-accounts-template"},{"title":"Create a Ledger Template","openapi":"POST /v0/platform-gl/coa-templates/{coa_template_id}/ledgers","href":"/api-reference/chart-of-accounts-templates/create-a-ledger-template"},{"title":"Update a Ledger Template","openapi":"PUT /v0/platform-gl/coa-templates/ledgers/{ledger_template_id}","href":"/api-reference/chart-of-accounts-templates/update-a-ledger-template"},{"title":"Delete a Ledger Template","openapi":"DELETE /v0/platform-gl/coa-templates/ledgers/{ledger_template_id}","href":"/api-reference/chart-of-accounts-templates/delete-a-ledger-template"}]},{"group":"Instances","pages":[{"title":"Create an Instance","openapi":"POST /v0/instance","href":"/api-reference/instances/create-an-instance"},{"title":"Retrieve the current Instance","openapi":"GET /v0/instance","href":"/api-reference/instances/retrieve-the-current-instance"},{"title":"Update the current Instance","openapi":"PUT /v0/instance","href":"/api-reference/instances/update-the-current-instance"}]},{"group":"Journal Entries","pages":[{"title":"Retrieve a Journal Entry","openapi":"GET /v0/journal-entries/{journal_entry_id}","href":"/api-reference/journal-entries/retrieve-a-journal-entry"},{"title":"Update a Journal Entry","openapi":"PUT /v0/journal-entries/{journal_entry_id}","href":"/api-reference/journal-entries/update-a-journal-entry"},{"title":"Update multiple Journal Entries","openapi":"PUT /v0/journal-entries","href":"/api-reference/journal-entries/update-multiple-journal-entries"},{"title":"Delete a Journal Entry","openapi":"DELETE /v0/journal-entries/{journal_entry_id}","href":"/api-reference/journal-entries/delete-a-journal-entry"},{"title":"Delete multiple Journal Entries","openapi":"DELETE /v0/journal-entries","href":"/api-reference/journal-entries/delete-multiple-journal-entries"},{"title":"List all Journal Entries","openapi":"GET /v0/journal-entries","href":"/api-reference/journal-entries/list-all-journal-entries"},{"title":"Create a Journal Entry","openapi":"POST /v0/journal-entries","href":"/api-reference/journal-entries/create-a-journal-entry"},{"title":"Create multiple Journal Entries","openapi":"POST /v0/bulk/journal-entries","href":"/api-reference/journal-entries/create-multiple-journal-entries"}]},{"group":"Ledgers","pages":[{"title":"List all Ledgers","openapi":"GET /v0/ledgers","href":"/api-reference/ledgers/list-all-ledgers"},{"title":"Get a Ledger","openapi":"GET /v0/ledgers/{ledger_id}","href":"/api-reference/ledgers/get-a-ledger"},{"title":"Create a Ledger","openapi":"POST /v0/ledgers","description":"Creates a Ledger.","href":"/api-reference/ledgers/create-a-ledger"},{"title":"Update a Ledger","openapi":"PUT /v0/ledgers/{ledger_id}","href":"/api-reference/ledgers/update-a-ledger"},{"title":"Delete a Ledger","openapi":"DELETE /v0/ledgers/{ledger_id}","description":"Deletes a Ledger and optionally its associated journal entries. By default, ledgers with line entries cannot be deleted. Set delete_journal_entries=true to delete the ledger along with: - All journal entries that have line entries on this ledger - All line entries in those journal entries - All reconciliations for this ledger - The source account (if not linked to Plaid) - Historical ledger balances Note: This operation is irreversible. Special ledgers (e.g., uncategorized inflow/outflow) cannot be deleted.","href":"/api-reference/ledgers/delete-a-ledger"},{"title":"Delete multiple ledgers in bulk","openapi":"DELETE /v0/bulk/ledgers","href":"/api-reference/ledgers/delete-multiple-ledgers-in-bulk"},{"title":"Set a Ledger's opening balance","openapi":"POST /v0/ledgers/{ledger_id}/opening-balance","href":"/api-reference/ledgers/set-a-ledger's-opening-balance"},{"title":"Get all ledgers opening balances","openapi":"GET /v0/ledgers/opening-balances","href":"/api-reference/ledgers/get-all-ledgers-opening-balances"}]},{"group":"Line Entries","pages":[{"title":"List all Line Entries in a Journal Entry","openapi":"GET /v0/journal-entries/{journal_entry_id}/line-entries","href":"/api-reference/line-entries/list-all-line-entries-in-a-journal-entry"},{"title":"List all Line Entries in a Ledger","openapi":"GET /v0/ledgers/{ledger_id}/line-entries","href":"/api-reference/line-entries/list-all-line-entries-in-a-ledger"}]},{"group":"Platform","pages":[{"title":"Retrieve Platform","openapi":"GET /v0/platform","href":"/api-reference/platform/retrieve-platform"},{"title":"Retrieve an Instance","openapi":"GET /v0/platform/instances/{instance_id}","href":"/api-reference/platform/retrieve-an-instance"},{"title":"Create an Instance","openapi":"POST /v0/platform/instances","href":"/api-reference/platform/create-an-instance"},{"title":"Update an Instance","openapi":"PUT /v0/platform/instances/{instance_id}","href":"/api-reference/platform/update-an-instance"},{"title":"Update an Instance's subscription","openapi":"PUT /v0/platform/instances/{instance_id}/subscription","href":"/api-reference/platform/update-an-instance's-subscription"},{"title":"Delete an Instance","openapi":"DELETE /v0/platform/instances/{instance_id}","href":"/api-reference/platform/delete-an-instance"},{"title":"List all Instances","openapi":"GET /v0/platform/instances","href":"/api-reference/platform/list-all-instances"}]},{"group":"Reconciliations","pages":[{"title":"List Reconciliations","openapi":"GET /v0/reconciliations","href":"/api-reference/reconciliation/list-reconciliations"},{"title":"Create a Reconciliation","openapi":"POST /v0/reconciliations","href":"/api-reference/reconciliation/create-a-reconciliation"},{"title":"Fetch a Reconciliation","openapi":"GET /v0/reconciliations/{reconciliation_id}","href":"/api-reference/reconciliation/fetch-a-reconciliation"},{"title":"Update a Reconciliation","openapi":"PUT /v0/reconciliations/{reconciliation_id}","href":"/api-reference/reconciliation/update-a-reconciliation"},{"title":"Delete a Reconciliation and all later reconciliations on the same ledger","openapi":"DELETE /v0/reconciliations/{reconciliation_id}","href":"/api-reference/reconciliation/delete-a-reconciliation-and-all-later-reconciliations-on-the-same-ledger"},{"title":"Fetch Journal Entries for a given reconciliation","openapi":"GET /v0/reconciliations/{reconciliation_id}/journal-entries","href":"/api-reference/reconciliation/fetch-journal-entries-for-a-given-reconciliation"},{"title":"Fetch Journal Entries for the next reconciliation in a given ledger","openapi":"GET /v0/ledgers/{ledger_id}/reconciliations/unreconciled/journal-entries","href":"/api-reference/reconciliation/fetch-journal-entries-for-the-next-reconciliation-in-a-given-ledger"},{"title":"Get the last completed reconciliation for each ledger","openapi":"GET /v0/reconciliations/last-completed","href":"/api-reference/reconciliation/get-the-last-completed-reconciliation-for-each-ledger"},{"title":"Bulk update reconciliation journal entry status","openapi":"PUT /v0/bulk/reconciliations/{reconciliation_id}/journal-entries","href":"/api-reference/reconciliation/bulk-update-reconciliation-journal-entry-status"}]},{"group":"Reports","pages":[{"title":"Retrieve the Income Statement","openapi":"GET /v0/reports/income-statement","href":"/api-reference/reports/retrieve-the-income-statement"},{"title":"Retrieve the Balance Sheet","openapi":"GET /v0/reports/balance-sheet","href":"/api-reference/reports/retrieve-the-balance-sheet"},{"title":"Retrieve a ledger statement","openapi":"GET /v0/reports/ledger-statement","href":"/api-reference/reports/retrieve-a-ledger-statement"},{"title":"Retrieve the Cash Flow Report","openapi":"GET /v0/reports/cash-flow","href":"/api-reference/reports/retrieve-the-cash-flow-report"},{"title":"List cash flow totals by period","openapi":"GET /v0/reports/cash-flow-totals","href":"/api-reference/reports/list-cash-flow-totals-by-period"},{"title":"List top expenses","openapi":"GET /v0/reports/top-expenses","href":"/api-reference/reports/list-top-expenses"},{"title":"List net profit by period","openapi":"GET /v0/reports/net-profit-by-period","href":"/api-reference/reports/list-net-profit-by-period"},{"title":"List gross profit by period","openapi":"GET /v0/reports/gross-profit-by-period","href":"/api-reference/reports/list-gross-profit-by-period"},{"title":"List financial summaries by period","openapi":"GET /v0/reports/financial-summaries-by-period","href":"/api-reference/reports/list-financial-summaries-by-period"},{"title":"Retrieve multiple cash flow reports for a given range","openapi":"GET /v0/reports/cash-flow/range","href":"/api-reference/reports/retrieve-multiple-cash-flow-reports-for-a-given-range"},{"title":"Retrieve the balance sheets for a given range","openapi":"GET /v0/reports/balance-sheet/range","href":"/api-reference/reports/retrieve-the-balance-sheets-for-a-given-range"},{"title":"Retrieve the income statements periods for a given range","openapi":"GET /v0/reports/income-statement/range","href":"/api-reference/reports/retrieve-the-income-statements-periods-for-a-given-range"},{"title":"Retrieve the General Ledger Report","openapi":"GET /v0/reports/general-ledger","href":"/api-reference/reports/retrieve-the-general-ledger-report"}]},{"group":"Tags","pages":[{"title":"Delete a tag group","openapi":"DELETE /v0/platform/tag-groups/{tag_group_id}","href":"/api-reference/tags/delete-a-tag-group"},{"title":"Update a tag group","openapi":"PUT /v0/platform/tag-groups/{tag_group_id}","href":"/api-reference/tags/update-a-tag-group"},{"title":"List all tag groups","openapi":"GET /v0/platform/tag-groups","href":"/api-reference/tags/list-all-tag-groups"},{"title":"Create a tag group","openapi":"POST /v0/platform/tag-groups","href":"/api-reference/tags/create-a-tag-group"},{"title":"List all tag rules","openapi":"GET /v0/tags/rules","href":"/api-reference/tags/list-all-tag-rules"},{"title":"Create a tag rule","openapi":"POST /v0/tags/rules","href":"/api-reference/tags/create-a-tag-rule"},{"title":"Delete a tag rule","openapi":"DELETE /v0/tags/rules/{tag_rule_id}","href":"/api-reference/tags/delete-a-tag-rule"},{"title":"Retrieve a tag","openapi":"GET /v0/tags/{tag_id}","href":"/api-reference/tags/retrieve-a-tag"},{"title":"Delete a tag","openapi":"DELETE /v0/tags/{tag_id}","href":"/api-reference/tags/delete-a-tag"},{"title":"List all tags","openapi":"GET /v0/tags","href":"/api-reference/tags/list-all-tags"},{"title":"Create a tag","openapi":"POST /v0/tags","href":"/api-reference/tags/create-a-tag"}]},{"group":"Transaction Sources","pages":[{"title":"Delete Ledger Transaction Source","openapi":"DELETE /v0/sources/ledgers/{ledger_id}","href":"/api-reference/transaction-sources/delete-ledger-transaction-source"},{"title":"Update Ledger Transaction Source","openapi":"PUT /v0/sources/ledgers/{ledger_id}","href":"/api-reference/transaction-sources/update-ledger-transaction-source"},{"title":"Link Plaid Account","openapi":"POST /v0/sources/plaid","href":"/api-reference/transaction-sources/link-plaid-account"},{"title":"Get Plaid Link Statuses","openapi":"GET /v0/sources/plaid/links/status","href":"/api-reference/transaction-sources/get-plaid-link-statuses"},{"title":"Create a Transaction Source Account","openapi":"POST /v0/source-accounts","href":"/api-reference/transaction-sources/create-a-transaction-source-account"},{"title":"Update a Transaction Source Account","openapi":"PUT /v0/source-accounts/{source_account_id}","href":"/api-reference/transaction-sources/update-a-transaction-source-account"},{"title":"Delete a Transaction Source Account","openapi":"DELETE /v0/source-accounts/{source_account_id}","href":"/api-reference/transaction-sources/delete-a-transaction-source-account"},{"title":"Get Transaction Source Accounts","openapi":"GET /v0/source-accounts","href":"/api-reference/transaction-sources/get-transaction-source-accounts"}]},{"group":"Transactions","pages":[{"title":"Create Transactions","openapi":"POST /v0/source-accounts/{source_account_id}/transactions","href":"/api-reference/transactions/create-transactions"},{"title":"Delete all Transactions in a Source Account","openapi":"DELETE /v0/source-accounts/{source_account_id}/transactions","href":"/api-reference/transactions/delete-all-transactions-in-a-source-account"},{"title":"List a Source Account's Transactions","openapi":"GET /v0/source-accounts/{source_account_id}/transactions","href":"/api-reference/transactions/list-a-source-account's-transactions"},{"title":"List Transaction Processing Tasks","openapi":"GET /v0/transactions/tasks","href":"/api-reference/transactions/list-transaction-processing-tasks"},{"title":"Retrieve a Transaction Processing Task","openapi":"GET /v0/transactions/tasks/{task_id}","href":"/api-reference/transactions/retrieve-a-transaction-processing-task"},{"title":"Delete a Transaction","openapi":"DELETE /v0/source-accounts/{source_account_id}/transactions/{transaction_id}","href":"/api-reference/transactions/delete-a-transaction"},{"title":"Update a Transaction","openapi":"PUT /v0/source-accounts/{source_account_id}/transactions/{transaction_id}","href":"/api-reference/transactions/update-a-transaction"},{"title":"Retrieve a Transaction","openapi":"GET /v0/source-accounts/{source_account_id}/transactions/{transaction_id}","href":"/api-reference/transactions/retrieve-a-transaction"},{"title":"Bulk Update Multiple Transactions","openapi":"PUT /v0/source-accounts/{source_account_id}/transactions","href":"/api-reference/transactions/bulk-update-multiple-transactions"}]}]},{"group":"API Migration","pages":[{"group":"Migration Guides","pages":[{"title":"Transaction Source Account","href":"/api-reference/migrations/transaction-source-accounts"}]},{"group":"Deprecated Endpoints","pages":[{"group":"Categorization Rules","pages":[{"title":"List all Platform rules","openapi":"GET /v0/platform/categorization/rules","href":"/api-reference/categorization/list-all-platform-rules"},{"title":"Create a Platform rule","openapi":"POST /v0/platform/categorization/rules","href":"/api-reference/categorization/create-a-platform-rule"},{"title":"Delete a Platform rule","openapi":"DELETE /v0/platform/categorization/rules/{rule_id}","href":"/api-reference/categorization/delete-a-platform-rule"},{"title":"List all Instance rules","openapi":"GET /v0/categorization/rules","href":"/api-reference/categorization/list-all-instance-rules"},{"title":"Create an Instance rule","openapi":"POST /v0/categorization/rules","href":"/api-reference/categorization/create-an-instance-rule"},{"title":"Delete an Instance rule","openapi":"DELETE /v0/categorization/rules/{rule_id}","href":"/api-reference/categorization/delete-an-instance-rule"}]}]}]}]},{"anchor":"Changelog","href":"https://teal.dev/changelog","icon":"bullhorn"}]},"basePath":"","title":"Update a Ledger - Teal","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"]}