A comma separated list of Categorization Rule IDs. Only return Rules with the specified IDs. Returns 404 if an ID is not found, 403 if any ID is not authorized.
{"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.3964","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":{},"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":"editor-v7-file-tree","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":"pause-universal-search-reconcile","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":"per-site-search-delta","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":"editor-private-page-search","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":"editor-nav-generations","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":"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":"editor-agent-model-picker","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":"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}],"isAtlas":false,"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/categorization/list-all-platform-rules","slug":"/api-reference/categorization/list-all-platform-rules","pageMetadata":{"title":"List all Platform rules","openapi":"GET /v0/platform/categorization/rules","description":"Lists all the Platform categorization rules.","href":"/api-reference/categorization/list-all-platform-rules"},"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: \"Lists all the Platform categorization rules.\"\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":"List all Platform rules","openapi":"GET /v0/platform/categorization/rules","description":"Lists all the Platform categorization rules.","href":"/api-reference/categorization/list-all-platform-rules"}}},"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":["Categorization"],"summary":"List all Platform rules","description":"Lists all the Platform categorization rules.","operationId":"get_platform_rules_v0_platform_categorization_rules_get","security":["d101dc22-8dc5-4a9d-9add-0e67152e2e21"],"parameters":["3ba6ee4c-65f8-40bb-9036-38b5a41ed66a","0763368f-84c8-40c8-9493-15b460d22e03","5f120523-54b7-4253-883b-8b45d5d6d26f","f49625cc-a1d2-42bf-8071-36ad020ce796","ec98708f-73d7-4f31-ac5f-7e2325713f7b","e34cb637-935f-44b9-a028-6ec277011134"],"responses":{"200":"cc8afb22-129e-431e-961e-d0fe2d2aa833","403":"a497c41e-40a2-4788-9dec-0ca38ea86832","404":"72258892-00dd-4b30-81c8-08c5ab3a78ba","422":"8a0c3bb2-5987-4fda-9cc8-59dcc6dac8ce","503":"5d2fbce8-8e6b-4a71-abbd-b455b724052d"},"method":"get","type":"path","servers":["d77a5682-df6d-4b53-9e28-211e969535f0","3bfc594c-f680-4779-9599-36cbc72e78ff"],"path":"/v0/platform/categorization/rules","baseUrlOptions":["https://api.sandbox.teal.dev","https://api.teal.dev"],"title":"List all Platform rules","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"3ba6ee4c-65f8-40bb-9036-38b5a41ed66a":{"name":"name","in":"query","required":false,"schema":{"oneOf":[{"type":"string","title":"Name","description":"The name of the rule for filtering.","uniqueKey":"oneOf.0","typeLabel":"string"},{"type":"null","title":"Name","description":"The name of the rule for filtering.","uniqueKey":"oneOf.1","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"string | null"},"description":"The name of the rule for filtering."},"0763368f-84c8-40c8-9493-15b460d22e03":{"name":"ledger_name","in":"query","required":false,"schema":{"oneOf":[{"type":"string","title":"Ledger Name","description":"The ledger name for filtering.","uniqueKey":"oneOf.0","typeLabel":"string"},{"type":"null","title":"Ledger Name","description":"The ledger name for filtering.","uniqueKey":"oneOf.1","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"string | null"},"description":"The ledger name for filtering."},"5f120523-54b7-4253-883b-8b45d5d6d26f":{"name":"sort","in":"query","required":false,"schema":{"oneOf":[{"type":"array","items":{"type":"string","enum":["name","-name","ledger_name","-ledger_name"],"title":"CategorizationRuleSort","uniqueKey":"oneOf.0.items.[INDEX]","typeLabel":"enum\u003cstring>"},"title":"Sort","description":"A comma separated list of sort orders for the results.","uniqueKey":"oneOf.0","typeLabel":"enum\u003cstring>[]"},{"type":"null","title":"Sort","description":"A comma separated list of sort orders for the results.","uniqueKey":"oneOf.1","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"enum\u003cstring>[] | null"},"description":"A comma separated list of sort orders for the results."},"f49625cc-a1d2-42bf-8071-36ad020ce796":{"name":"ids","in":"query","required":false,"schema":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"oneOf.0.items.[INDEX]","typeLabel":"string"},"title":"Ids","description":"A comma separated list of Categorization Rule IDs. Only return Rules with the specified IDs. Returns 404 if an ID is not found, 403 if any ID is not authorized.","uniqueKey":"oneOf.0","typeLabel":"string[]"},{"type":"null","title":"Ids","description":"A comma separated list of Categorization Rule IDs. Only return Rules with the specified IDs. Returns 404 if an ID is not found, 403 if any ID is not authorized.","uniqueKey":"oneOf.1","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"string[] | null"},"description":"A comma separated list of Categorization Rule IDs. Only return Rules with the specified IDs. Returns 404 if an ID is not found, 403 if any ID is not authorized."},"ec98708f-73d7-4f31-ac5f-7e2325713f7b":{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"exclusiveMaximum":1001,"description":"The number of records to return. Max limit is 1000.","default":50,"title":"Limit","isRequired":false,"uniqueKey":"","typeLabel":"integer"},"description":"The number of records to return. Max limit is 1000."},"e34cb637-935f-44b9-a028-6ec277011134":{"name":"page_token","in":"query","required":false,"schema":{"oneOf":[{"type":"string","title":"Page Token","description":"Opaque page token","uniqueKey":"oneOf.0","typeLabel":"string"},{"type":"null","title":"Page Token","description":"Opaque page token","uniqueKey":"oneOf.1","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"string | null"},"description":"Opaque page token"}},"responses":{"cc8afb22-129e-431e-961e-d0fe2d2aa833":{"description":"Successful Response","content":{"application/json":{"schema":{"properties":{"next_page_token":{"oneOf":[{"type":"string","description":"The token to use to request the next page","example":"ikal0NEVfMhF8dJf4yQ6KQZmGD","isRequired":true,"uniqueKey":"next_page_token.oneOf.0","typeLabel":"string"},{"type":"null","description":"The token to use to request the next page","example":"ikal0NEVfMhF8dJf4yQ6KQZmGD","isRequired":true,"uniqueKey":"next_page_token.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"next_page_token","typeLabel":"string | null"},"prev_page_token":{"oneOf":[{"type":"string","description":"The token to use to request the previous page","example":"vuA7JeKI5c6FLnPt5JfRcZcJxW","isRequired":true,"uniqueKey":"prev_page_token.oneOf.0","typeLabel":"string"},{"type":"null","description":"The token to use to request the previous page","example":"vuA7JeKI5c6FLnPt5JfRcZcJxW","isRequired":true,"uniqueKey":"prev_page_token.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"prev_page_token","typeLabel":"string | null"},"records":{"items":{"properties":{"id":{"type":"string","title":"Id","description":"The unique ID of the object.","examples":["N6ntpvTtiA4L31vVyVat5n"],"isRequired":true,"uniqueKey":"records.items.[INDEX].id","typeLabel":"string"},"expression":{"type":"string","title":"Expression","description":"A pattern matching expression using the\n match(pattern, field) function. Use `t` to access the Transaction\n object. The pattern supports regular expression syntax.\n \n \n Read more: [Categorization guide](https://docs.teal.dev/guides/platform/categorization/rules#expressions)","examples":["match(\".*(?i)SHELL GAS\", t.description)"],"isRequired":true,"uniqueKey":"records.items.[INDEX].expression","typeLabel":"string"},"ledger_name":{"type":"string","title":"Ledger Name","description":"The name of the destination ledger.","examples":["Fuel Expenses"],"isRequired":true,"uniqueKey":"records.items.[INDEX].ledger_name","typeLabel":"string"},"name":{"type":"string","title":"Name","description":"An arbitrary string to name the rule.","examples":["Shell to Fuel Expenses"],"isRequired":true,"uniqueKey":"records.items.[INDEX].name","typeLabel":"string"},"priority":{"type":"integer","title":"Priority","description":"The priority of the rule.","examples":["100"],"isRequired":true,"uniqueKey":"records.items.[INDEX].priority","typeLabel":"integer"}},"type":"object","required":["id","expression","ledger_name","name","priority"],"title":"CategorizationRule","uniqueKey":"records.items.[INDEX]","typeLabel":"CategorizationRule · object"},"type":"array","title":"Records","description":"The categorization rule objects","isRequired":true,"uniqueKey":"records","typeLabel":"CategorizationRule · object[]"}},"type":"object","required":["next_page_token","prev_page_token","records"],"title":"CategorizationRulePage","uniqueKey":"","typeLabel":"CategorizationRulePage · object"},"examples":{"Example":{"title":"Example","value":{"next_page_token":"ikal0NEVfMhF8dJf4yQ6KQZmGD","prev_page_token":"vuA7JeKI5c6FLnPt5JfRcZcJxW","records":[{"id":"N6ntpvTtiA4L31vVyVat5n","expression":"match(\".*(?i)SHELL GAS\", t.description)","ledger_name":"Fuel Expenses","name":"Shell to Fuel Expenses","priority":"100"}]}}},"exampleType":"generated"}},"exampleType":"generated"},"a497c41e-40a2-4788-9dec-0ca38ea86832":{"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"},"72258892-00dd-4b30-81c8-08c5ab3a78ba":{"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"},"8a0c3bb2-5987-4fda-9cc8-59dcc6dac8ce":{"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"},"5d2fbce8-8e6b-4a71-abbd-b455b724052d":{"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":{"d101dc22-8dc5-4a9d-9add-0e67152e2e21":{"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":"List all Platform rules - Teal","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2025-08-11T22:28:59.350Z","originalFileLocation":"api-reference/categorization/list-all-platform-rules.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=\"Lists all the Platform categorization rules.\">\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=\"List all Platform rules - Teal\">\u003cmeta data-mint-head property=\"og:description\" content=\"Lists all the Platform categorization rules.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Teal\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.teal.dev/api-reference/categorization/list-all-platform-rules\">\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=Categorization+Rules\u0026amp;title=List+all+Platform+rules\u0026amp;description=Lists+all+the+Platform+categorization+rules.\u0026amp;theme=8de3a09bd6716d6473382dd4\u0026amp;signature=ea8c1fb63930c3b61d8e20557e46e5fb8d5604e8c513c7604d0408dc07f2bf8a\">\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=\"List all Platform rules - Teal\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Lists all the Platform categorization rules.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://tealplatforms.mintlify.app/_mintlify/api/og/v2?division=Categorization+Rules\u0026amp;title=List+all+Platform+rules\u0026amp;description=Lists+all+the+Platform+categorization+rules.\u0026amp;theme=8de3a09bd6716d6473382dd4\u0026amp;signature=ea8c1fb63930c3b61d8e20557e46e5fb8d5604e8c513c7604d0408dc07f2bf8a\">\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/categorization/list-all-platform-rules\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/categorization/list-all-platform-rules.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/categorization/list-all-platform-rules#webpage\",\"url\":\"https://docs.teal.dev/api-reference/categorization/list-all-platform-rules\",\"name\":\"List all Platform rules\",\"description\":\"Lists all the Platform categorization rules.\",\"dateModified\":\"2025-08-11T22:28:59.350Z\",\"isPartOf\":{\"@id\":\"https://docs.teal.dev#website\"},\"breadcrumb\":{\"@id\":\"https://docs.teal.dev/api-reference/categorization/list-all-platform-rules#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.teal.dev/api-reference/categorization/list-all-platform-rules#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"API Migration\",\"item\":\"https://docs.teal.dev/api-reference/migrations/transaction-source-accounts\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"List all Platform rules\",\"item\":\"https://docs.teal.dev/api-reference/categorization/list-all-platform-rules\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.teal.dev/api-reference/categorization/list-all-platform-rules#apireference\",\"headline\":\"List all Platform rules\",\"name\":\"List all Platform rules\",\"description\":\"Lists all the Platform categorization rules.\",\"url\":\"https://docs.teal.dev/api-reference/categorization/list-all-platform-rules\",\"mainEntityOfPage\":{\"@id\":\"https://docs.teal.dev/api-reference/categorization/list-all-platform-rules#webpage\"},\"dateModified\":\"2025-08-11T22:28:59.350Z\",\"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","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}","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","description":"This is a migration guide to switch from ledger transaction endpoints to transaction source account endpoints.","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","description":"Creates a new Platform categorization rule.","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"}]},"title":"List all Platform rules - Teal","buildId":"dpl_HcHmUS6i3UwswnTHJUEdcTtwfdTQ","deploymentId":"dpl_HcHmUS6i3UwswnTHJUEdcTtwfdTQ","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-BRm_l__d.js","utils-f1l1Oc-G.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-BlhqDhJO.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-DHCB7rsC.js","snippetPresets-CYXLx6Hv.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-B78P2dEq.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-C4YLPVAh.js","shallow-vlLnTDkQ.js","getApiPlaygroundDisplay-D_98hhvf.js","CodeSnippet-DtnZHGqq.js","CodeSnippets-CLFb8KJt.js","Page-kQh739Uz.js","getPastedJson-Cq-zlbnU.js","icon-sN3t983t.js","MethodPill-P_YQ2s09.js","DuplicateIcon-BVzyNsGJ.js","createIcon-B3jqgqC6.js","DynamicMarkdown-Crwq6WG_.js","SectionHeading-C7pGS2Bb.js","axios-vUo_bRtp.js","Markdown-BuPH8yuW.js","clsx-CCOYKgaU.js","lib--scc4DXi.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-BnkC_6oA.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-BM4S31-f.js"]}