Availability: Automated and Assisted providersEmployer Match capabilities are currently in Beta. Please reach out if you are interested in gaining early access.If the same request is made more than once with the same type, frequency and description, a new item will not be created. Finch will instead return the benefit_id of the existing item.Latencies may vary depending on whether the provider is Automated or Assisted - new items will be created within minutes for Automated providers and within the 2 business day SLA for Assisted providers.
The entity IDs to specify which entities' data to access. Provide exactly one entity ID per request; a maximum of one is accepted. Required when the connection has more than one entity — omitting it returns a 400invalid_request_error. Optional for single-entity connections.
Name of the benefit as it appears in the provider and pay statements. Recommend limiting this to <30 characters due to limitations in specific providers (e.g. Justworks).
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Finch","colors":{"primary":"#161616","light":"#FAFAFA","dark":"#3E4AE7"},"logo":{"light":"https://mintcdn.com/finch/ejF2Kw2CeeMQKCJw/logo/logo-black.svg?fit=max\u0026auto=format\u0026n=ejF2Kw2CeeMQKCJw\u0026q=85\u0026s=e490dba98fb7b16e8f9f5ab4a9a58a5c","dark":"https://mintcdn.com/finch/ejF2Kw2CeeMQKCJw/logo/logo-white.svg?fit=max\u0026auto=format\u0026n=ejF2Kw2CeeMQKCJw\u0026q=85\u0026s=9132a1fde9ad8880fbf81ac32e53e6b2"},"favicon":"https://mintcdn.com/finch/8U6M212KK5wde_yD/favicon.png?fit=max\u0026auto=format\u0026n=8U6M212KK5wde_yD\u0026q=85\u0026s=c54c63bf4768a5eb32ea7e306f52ed1e","navbar":{"links":[{"href":"https://dashboard.tryfinch.com/signup","label":"Sign Up"}],"primary":{"type":"button","label":"Sign In","href":"https://login.tryfinch.com/u/login?state=hKFo2SBmakdGQlE4STYwYzhmRkYzc0ZOTVV3c1VkX2F4UGhuTKFur3VuaXZlcnNhbC1sb2dpbqN0aWTZIENuZ0NHU283dXV5YzlzczQtZFZxUmJQRElJUmt6UGpmo2NpZNkgTlZsT1hZN3N2R25xSlNHYkFSdE1Ga2tnMGJqMkJmbEk"}},"footer":{"socials":{"twitter":"https://twitter.com/tryfinch?lang=en","linkedin":"https://www.linkedin.com/company/finchapi","website":"https://tryfinch.com/"}},"integrations":{"amplitude":{"apiKey":"684ff58ac8711b102376cfd6ded7f199"}},"styling":{"latex":false},"navigation":{"global":{"anchors":[{"anchor":"Changelog","icon":{"style":"sharp-solid","name":"megaphone"},"color":{"light":"#3E4AE7","dark":"#3E4AE7"},"href":"https://developer.tryfinch.com/changelog"},{"anchor":"API Status","icon":{"style":"sharp-solid","name":"signal-bars"},"color":{"light":"#3E4AE7","dark":"#3E4AE7"},"href":"https://status.tryfinch.com"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"finch","hasAudioNarration":false,"actualSubdomain":"finch","customDomains":["developer.tryfinch.com"],"gitSource":{"type":"github","owner":"finch-api","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ae3c260360e41575642d873","collectionId":"0645db48-9b0e-4cce-a244-07ad6d75d500","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ae3c260360e41575642d873"},"feedback":{"thumbs":true,"issues":false,"edits":false},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"REMOVE_BRANDING":{"status":"ENABLED"},"CONTEXTUAL_FEEDBACK":{"status":"ENABLED"},"CODE_SNIPPET_FEEDBACK":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6ae4dedb3bef708e2abea4fe","clientVersion":"0.0.4043","searchFilterCounts":[{"language":"default","tag":"API Reference","count":61},{"language":"default","tag":"Documentation","count":55},{"language":"default","tag":"Implementation Guide","count":23},{"language":"default","tag":"Developer Resources","count":17},{"language":"default","tag":"Sandbox","count":11},{"language":"default","tag":"Management","count":10},{"language":"default","tag":"Payroll","count":10},{"language":"default","tag":"Deductions","count":9},{"language":"default","tag":"Development Guides","count":7},{"language":"default","tag":"Build Backend Application","count":7}]},"assistantConfig":{"deflection":{"enabled":true,"email":"developers@tryfinch.com","showHelpButton":true}},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[],"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":":root{--finch-purple:#3E4AE7;--finch-purple-dark:#7A84FF}.update-container [class*=bg-primary]{background-color:rgba(62,74,231,.08)!important;color:var(--finch-purple)!important}.dark .update-container [class*=bg-primary]{background-color:rgba(122,132,255,.15)!important;color:var(--finch-purple-dark)!important}#content-side-layout:empty,#table-of-contents-layout:empty{position:absolute}:is(.prose a):not(.dark .prose a):not(:where([aria-label=\"Navigate to header\"])){color:var(--finch-purple);border-bottom:1px solid var(--finch-purple)}:is(.dark .prose a):not(:where([aria-label=\"Navigate to header\"])){color:var(--finch-purple-dark);border-bottom:1px solid var(--finch-purple-dark)}.automated-badge{background-color:#ecfdf3;color:#027a48}.assisted-badge{background-color:#fffaeb;color:#b54708}.dark .automated-badge{background-color:#0c2119!important;color:#12b76a!important}.dark .assisted-badge{background-color:#21140f!important;color:#f79009!important}.pn-container{margin-top:1rem}.pn-search{width:100%;padding:10px 14px;font-size:15px;border:1px solid #d0d5dd;border-radius:8px;outline:0;background:#fff;color:#101828;transition:border-color .15s,box-shadow .15s}.pn-search:focus{border-color:var(--finch-purple);box-shadow:0 0 0 3px rgba(62,74,231,.12)}.pn-search::placeholder{color:#98a2b3}.dark .pn-search{background:#1d2939;border-color:#344054;color:#f2f4f7}.dark .pn-search:focus{border-color:var(--finch-purple-dark);box-shadow:0 0 0 3px rgba(122,132,255,.15)}.pn-filters{display:flex;flex-wrap:wrap;gap:16px;margin:16px 0;align-items:flex-start}.pn-filter-group{display:flex;align-items:center;gap:6px;flex-wrap:wrap}.pn-filter-label,.pn-table thead th{font-weight:600;color:#475467;white-space:nowrap}.pn-filter-label{font-size:13px;margin-right:2px}.dark .pn-filter-label{color:#98a2b3}.pn-checkbox-label,.pn-export-btn,.pn-filter-btn{align-items:center;font-size:13px;font-weight:500;cursor:pointer}.pn-checkbox-label{display:flex;gap:6px;color:#344054}.dark .pn-checkbox-label{color:#d0d5dd}.pn-export-btn,.pn-filter-btn{display:inline-flex;padding:4px 12px;border:1px solid #d0d5dd}.pn-export-btn{gap:6px;border-radius:6px;background:0 0;color:#475467;margin-left:auto}.pn-export-btn:hover{background:#f2f4f7;border-color:#98a2b3}.dark .pn-export-btn{color:#d0d5dd;border-color:#475467}.dark .pn-export-btn:hover{background:#1d2939;border-color:#667085}.pn-filter-btn{border-radius:999px;background:#fff;color:#344054;transition:all .15s;line-height:1.5}.pn-filter-btn:hover{background:#f2f4f7;border-color:#98a2b3}.pn-filter-btn-active{background:var(--finch-purple)!important;color:#fff!important;border-color:var(--finch-purple)!important}.dark .pn-filter-btn{background:#1d2939;border-color:#344054;color:#d0d5dd}.dark .pn-filter-btn:hover{background:#344054;border-color:#475467}.dark .pn-filter-btn-active{background:var(--finch-purple-dark)!important;color:#101828!important;border-color:var(--finch-purple-dark)!important}.pn-results-count{font-size:14px;color:#475467;margin-bottom:12px;font-weight:500}.dark .pn-results-count{color:#98a2b3}.pn-table{width:100%;border-collapse:collapse;font-size:14px;table-layout:auto;margin-left:0!important;margin-right:0!important}#fsm-table-scroll table td,#fsm-table-scroll table th,.pn-table td,.pn-table th{min-width:0!important}.pn-col-narrow{width:1%!important}.pn-td-center,.pn-th-center{text-align:center!important;white-space:nowrap!important;padding-left:6px!important;padding-right:6px!important;width:1%!important;min-width:0!important;max-width:fit-content!important}.pn-th-link,.pn-th-link:link,.pn-th-link:visited,.prose .pn-th-link,.prose a.pn-th-link{color:inherit!important;text-decoration:none!important;border-bottom:none!important;box-shadow:none!important}.pn-th-link:hover,.prose .pn-th-link:hover,.prose a.pn-th-link:hover{text-decoration:underline!important}.pn-table thead th{text-align:left;padding:8px 4px;font-size:12px;text-transform:uppercase;letter-spacing:.04em;border-bottom:2px solid #e4e7ec}.dark .pn-table thead th{color:#98a2b3;border-bottom-color:#344054}.pn-table tbody tr{border-bottom:1px solid #f2f4f7;transition:background .1s}.pn-table tbody tr:hover{background:#f9fafb}.dark .pn-table tbody tr{border-bottom-color:#1d2939}.dark .pn-table tbody tr:hover{background:#1d2939}.pn-table td{padding:8px 4px;vertical-align:middle;overflow:hidden;text-overflow:ellipsis}.pn-table td:first-child,.pn-table th:first-child{padding-left:0!important}.pn-pill{display:inline-block;padding:2px 8px;border-radius:999px;font-size:13px;font-weight:500}.pn-product-pills{display:flex;flex-wrap:wrap;gap:4px}.pn-pill-automated{background:#ecfdf3;color:#027a48}.pn-pill-assisted{background:#fffaeb;color:#b54708}.dark .pn-pill-automated{background:#0c2119;color:#12b76a}.dark .pn-pill-assisted{background:#21140f;color:#f79009}.pn-name-row{display:flex;align-items:center;gap:8px}.pn-name-id{gap:6px}.pn-copy-btn,.pn-id-cell,.pn-name-id{display:inline-flex;align-items:center}.pn-id-cell{gap:4px}.pn-id-cell code{font-size:12px}.pn-copy-btn{justify-content:center;background:0 0;border:0;cursor:pointer;color:#98a2b3;padding:2px;border-radius:4px;transition:color .15s,background .15s}.pn-copy-btn:hover{color:var(--finch-purple);background:#f2f4f7}.dark .pn-copy-btn:hover{color:var(--finch-purple-dark);background:#344054}.assisted-fast-badge,.pn-badge-assisted,.pn-badge-assisted-fast,.pn-badge-automated{display:inline-block;padding:1px 6px;border-radius:999px;font-size:11px;font-weight:500;white-space:nowrap}.assisted-fast-badge,.pn-badge-assisted-fast{background-color:#fffaeb;color:#b54708}.dark .assisted-fast-badge{background-color:#21140f!important;color:#f79009!important}.pn-badge-none{color:#98a2b3;font-size:11px}.pn-badge-request,.prose .pn-badge-request,.prose a.pn-badge-request{font-size:11px;color:#667085!important;text-decoration:none!important;border-bottom:none!important}.pn-badge-request:hover,.prose .pn-badge-request:hover,.prose a.pn-badge-request:hover{text-decoration:underline!important}.dark .pn-badge-request,.dark .prose .pn-badge-request,.dark .prose a.pn-badge-request{color:#667085!important}.pn-status-beta,.pn-status-ga{display:inline-block;padding:1px 6px;border-radius:999px;font-size:10px;font-weight:600;letter-spacing:.03em}.pn-status-ga{background:#eff8ff;color:#175cd3;text-transform:uppercase}.pn-status-beta{background:#f4f3ff;color:#5925dc}.dark .pn-status-ga{background:#0c1f3d;color:#84adff}.dark .pn-status-beta{background:#1d1547;color:#bdb4fe}@media (max-width:768px){.pn-filters{flex-direction:column;gap:10px}.pn-table{font-size:12px}.pn-table td,.pn-table th{padding:8px 6px}}.fsm-auth-api_token,.fsm-auth-assisted,.fsm-auth-credential,.fsm-auth-oauth{font-size:11px;font-weight:500;padding:2px 8px;border-radius:9999px;display:inline-block}.fsm-auth-oauth{background:#f0fdf4;color:#15803d}.fsm-auth-credential{background:#eff6ff;color:#1d4ed8}.fsm-auth-api_token{background:#faf5ff;color:#7e22ce}.fsm-auth-assisted{background:#fefce8;color:#a16207}.dark .fsm-auth-oauth{background:#0a2618;color:#6ee7a0}.dark .fsm-auth-credential{background:#0c1a2e;color:#7db8f5}.dark .fsm-auth-api_token{background:#1a0e2e;color:#c4a5f5}.dark .fsm-auth-assisted{background:#231a0a;color:#e5b85c}.fsm-beta-callout{border-radius:8px;border:1px solid #bfdbfe;background:#eff6ff;padding:12px 16px;margin-bottom:16px;font-size:14px;color:#1e40af;display:flex;align-items:center;gap:10px}.fsm-beta-callout svg,.fsm-method{flex-shrink:0}.dark .fsm-beta-callout{border-color:#1e3a5f;background:#0c1a2e;color:#93c5fd}.dark .fsm-beta-callout circle{stroke:#60a5fa}.dark .fsm-beta-callout text{fill:#60a5fa}.fsm-method{font-size:9px;font-weight:700;line-height:1;padding:2px 5px;border-radius:3px;letter-spacing:.02em}.fsm-method-get{color:#16a34a;background:#f0fdf4}.fsm-method-post{color:#2563eb;background:#eff6ff}.fsm-method-del{color:#dc2626;background:#fef2f2}.dark .fsm-method-get{color:#6ee7a0;background:#0a2618}.dark .fsm-method-post{color:#7db8f5;background:#0c1a2e}.dark .fsm-method-del{color:#f87171;background:#2a0a0a}.fsm-csv-btn,.fsm-drop-item{align-items:center;font-size:13px;cursor:pointer;background:0 0}.fsm-csv-btn{display:inline-flex;gap:6px;padding:7px 12px;border:1px solid #e2e8f0;border-radius:8px;font-weight:500;color:#64748b}.fsm-csv-btn:hover{border-color:#94a3b8;color:#475569}.dark .fsm-csv-btn{border-color:#374151;color:#9ca3af}.dark .fsm-csv-btn:hover{border-color:#4b5563;color:#d1d5db}.fsm-drop-item{display:flex;gap:8px;width:100%;padding:5px 10px;border:0;border-radius:6px;text-align:left;color:#4b5563}.fsm-drop-item:hover{background:#f8fafc}.fsm-drop-item-selected{background:#f0f1ff;color:#3e4ae7}.dark .fsm-drop-item{color:#e5e7eb}.dark .fsm-drop-item:hover{background:rgba(255,255,255,.08)}.dark .fsm-drop-item-selected{background:rgba(122,132,255,.15);color:#7a84ff}.fsm-tooltip-wrap{position:relative;display:inline-flex}.fsm-tooltip{display:none;position:absolute;bottom:calc(100% + 6px);left:50%;transform:translateX(-50%);background:#1e293b;color:#f1f5f9;font-size:12px;line-height:1.4;padding:8px 12px;border-radius:8px;width:220px;white-space:normal;text-align:left;box-shadow:0 4px 12px rgba(0,0,0,.15);z-index:100;pointer-events:none}.fsm-btn-tooltip-wrap:hover .fsm-btn-tooltip,.fsm-tip:hover .fsm-tip-text,.fsm-tooltip-wrap:hover .fsm-tooltip{display:block}.fsm-btn-tooltip-wrap{position:relative;display:inline-flex}.fsm-btn-tooltip{display:none;position:absolute;bottom:calc(100% + 6px);left:50%;transform:translateX(-50%);background:#1e293b;color:#f1f5f9;font-size:11px;padding:4px 8px;border-radius:4px;white-space:nowrap;z-index:100;pointer-events:none}.fsm-tip{color:#9ca3af}.dark .fsm-tip{color:#6b7280}.fsm-tip-text{display:none;position:absolute;bottom:calc(100% + 6px);right:-8px;background:#1e293b;color:#f1f5f9;font-size:11px;line-height:1.4;padding:6px 10px;border-radius:6px;text-align:left;width:max-content;max-width:320px;z-index:9999;pointer-events:none}#fsm-table-scroll,#fsm-top-scroll{margin-left:0!important;margin-right:0!important;max-width:100%!important}#fsm-table-scroll::-webkit-scrollbar,#fsm-top-scroll::-webkit-scrollbar{height:8px}#fsm-table-scroll::-webkit-scrollbar-track,#fsm-top-scroll::-webkit-scrollbar-track{background:0 0}#fsm-table-scroll::-webkit-scrollbar-thumb,#fsm-top-scroll::-webkit-scrollbar-thumb{background:#d1d5db;border-radius:4px}#fsm-table-scroll::-webkit-scrollbar-thumb:hover,#fsm-top-scroll::-webkit-scrollbar-thumb:hover{background:#9ca3af}.dark #fsm-table-scroll::-webkit-scrollbar-thumb,.dark #fsm-top-scroll::-webkit-scrollbar-thumb{background:#4b5563}.dark #fsm-table-scroll::-webkit-scrollbar-thumb:hover,.dark #fsm-top-scroll::-webkit-scrollbar-thumb:hover{background:#6b7280}"}],"page":{"pagePath":"api-reference/deductions/create-deduction","slug":"/api-reference/deductions/create-deduction","pageMetadata":{"openapi":"post /employer/benefits","title":"Create Deduction","description":"Creates a new company-wide deduction or contribution. Please use the `/providers` endpoint to view available types for each provider.","href":"/api-reference/deductions/create-deduction"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_components.p, {\n children: [\"Creates a new company-wide deduction or contribution. Please use the \", _jsx(_components.code, {\n children: \"/providers\"\n }), \" endpoint to view available types for each provider.\"]\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,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={code:`code`,p:`p`,strong:`strong`,..._provideComponents(),...props.components};return _jsxs(_Fragment,{children:[_jsx(_components.p,{children:_jsx(_components.strong,{children:`Availability: Automated and Assisted providers`})}),`\n`,_jsx(_components.p,{children:`Employer Match capabilities are currently in Beta. Please reach out if you are interested in gaining early access.`}),`\n`,_jsxs(_components.p,{children:[`If the same request is made more than once with the same `,_jsx(_components.code,{children:`type`}),`, `,_jsx(_components.code,{children:`frequency`}),` and `,_jsx(_components.code,{children:`description`}),`, a new item will not be created. Finch will instead return the `,_jsx(_components.code,{children:`benefit_id`}),` of the existing item.`]}),`\n`,_jsx(_components.p,{children:`Latencies may vary depending on whether the provider is Automated or Assisted - new items will be created within minutes for Automated providers and within the 2 business day SLA for Assisted providers.`})]})}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":{"openapi":"post /employer/benefits","title":"Create Deduction","description":"Creates a new company-wide deduction or contribution. Please use the `/providers` endpoint to view available types for each provider.","href":"/api-reference/deductions/create-deduction"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"summary":"Create Deduction","description":"Creates a new company-wide deduction or contribution. Please use the `/providers` endpoint to view available types for each provider.","operationId":"create-company-benefits","parameters":["164a789b-b5ae-40d4-b767-8c357dae9ae7","e5a64e44-12bd-4cb1-9487-16c19bf3dbec","551a27c3-7449-4105-8fe6-9d3f63d5c40c"],"tags":["Deductions"],"requestBody":"141939ac-9e84-487d-8c32-1c31d38ac6a3","security":["c4786cc4-28ba-4656-b243-25337383163a"],"responses":{"201":"3ac0b301-4349-425a-9f70-705f259c5082","202":"70eea74a-6041-4902-b7de-e201697bd958","400":"fc44a5e2-0f96-44f6-af62-c8420427e822","422":"41b28817-805a-497f-bfb4-c6b7de76a377"},"x-codeSamples":[{"lang":"JavaScript","source":"import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\nconst createCompanyBenefitsResponse = await client.hris.benefits.create();\n\nconsole.log(createCompanyBenefitsResponse.benefit_id);"},{"lang":"Python","source":"from finch import Finch\n\nclient = Finch(\n access_token=\"My Access Token\",\n)\ncreate_company_benefits_response = client.hris.benefits.create()\nprint(create_company_benefits_response.benefit_id)"},{"lang":"Go","source":"package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/Finch-API/finch-api-go/v2\"\n\t\"github.com/Finch-API/finch-api-go/v2/option\"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken(\"My Access Token\"),\n\t)\n\tcreateCompanyBenefitsResponse, err := client.HRIS.Benefits.New(context.TODO(), finchgo.HRISBenefitNewParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", createCompanyBenefitsResponse.BenefitID)\n}\n"},{"lang":"Java","source":"package com.tryfinch.api.example;\n\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\nimport com.tryfinch.api.models.CreateCompanyBenefitsResponse;\nimport com.tryfinch.api.models.HrisBenefitCreateParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n FinchClient client = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken(\"My Access Token\")\n .build();\n\n CreateCompanyBenefitsResponse createCompanyBenefitsResponse = client.hris().benefits().create();\n }\n}"},{"lang":"Kotlin","source":"package com.tryfinch.api.example\n\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.models.CreateCompanyBenefitsResponse\nimport com.tryfinch.api.models.HrisBenefitCreateParams\n\nfun main() {\n val client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken(\"My Access Token\")\n .build()\n\n val createCompanyBenefitsResponse: CreateCompanyBenefitsResponse = client.hris().benefits().create()\n}"},{"lang":"Ruby","source":"require \"finch_api\"\n\nfinch = FinchAPI::Client.new(access_token: \"My Access Token\")\n\ncreate_company_benefits_response = finch.hris.benefits.create\n\nputs(create_company_benefits_response)"}],"method":"post","type":"path","servers":["c751b629-e47c-48d2-9131-f14412d7ead8"],"path":"/employer/benefits","baseUrlOptions":["https://api.tryfinch.com"],"title":"Create Deduction","codeSamples":[{"lang":"JavaScript","source":"import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\nconst createCompanyBenefitsResponse = await client.hris.benefits.create();\n\nconsole.log(createCompanyBenefitsResponse.benefit_id);"},{"lang":"Python","source":"from finch import Finch\n\nclient = Finch(\n access_token=\"My Access Token\",\n)\ncreate_company_benefits_response = client.hris.benefits.create()\nprint(create_company_benefits_response.benefit_id)"},{"lang":"Go","source":"package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/Finch-API/finch-api-go/v2\"\n\t\"github.com/Finch-API/finch-api-go/v2/option\"\n)\n\nfunc main() {\n\tclient := finchgo.NewClient(\n\t\toption.WithAccessToken(\"My Access Token\"),\n\t)\n\tcreateCompanyBenefitsResponse, err := client.HRIS.Benefits.New(context.TODO(), finchgo.HRISBenefitNewParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", createCompanyBenefitsResponse.BenefitID)\n}\n"},{"lang":"Java","source":"package com.tryfinch.api.example;\n\nimport com.tryfinch.api.client.FinchClient;\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient;\nimport com.tryfinch.api.models.CreateCompanyBenefitsResponse;\nimport com.tryfinch.api.models.HrisBenefitCreateParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n FinchClient client = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken(\"My Access Token\")\n .build();\n\n CreateCompanyBenefitsResponse createCompanyBenefitsResponse = client.hris().benefits().create();\n }\n}"},{"lang":"Kotlin","source":"package com.tryfinch.api.example\n\nimport com.tryfinch.api.client.FinchClient\nimport com.tryfinch.api.client.okhttp.FinchOkHttpClient\nimport com.tryfinch.api.models.CreateCompanyBenefitsResponse\nimport com.tryfinch.api.models.HrisBenefitCreateParams\n\nfun main() {\n val client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken(\"My Access Token\")\n .build()\n\n val createCompanyBenefitsResponse: CreateCompanyBenefitsResponse = client.hris().benefits().create()\n}"},{"lang":"Ruby","source":"require \"finch_api\"\n\nfinch = FinchAPI::Client.new(access_token: \"My Access Token\")\n\ncreate_company_benefits_response = finch.hris.benefits.create\n\nputs(create_company_benefits_response)"}],"requiredOnlyExamples":false,"requestExampleType":"codeSamples","responseExampleType":"generated"},"dependencies":{"parameters":{"164a789b-b5ae-40d4-b767-8c357dae9ae7":{"name":"entity_ids","in":"query","required":false,"description":"The entity IDs to specify which entities' data to access. Provide exactly one entity ID per request; a maximum of one is accepted. Required when the connection has more than one entity — omitting it returns a `400` `invalid_request_error`. Optional for single-entity connections.","schema":{"type":"array","items":{"type":"string","format":"uuid","uniqueKey":"items.[INDEX]","typeLabel":"string\u003cuuid>"},"minItems":1,"maxItems":1,"example":["550e8400-e29b-41d4-a716-446655440000"],"isRequired":false,"description":"The entity IDs to specify which entities' data to access. Provide exactly one entity ID per request; a maximum of one is accepted. Required when the connection has more than one entity — omitting it returns a `400` `invalid_request_error`. Optional for single-entity connections.","uniqueKey":"","typeLabel":"string\u003cuuid>[]"},"style":"form","explode":true},"e5a64e44-12bd-4cb1-9487-16c19bf3dbec":{"name":"Finch-API-Version","in":"header","required":true,"schema":{"type":"string","default":"2020-09-17","format":"date","isRequired":true,"description":"Header used to specify the version for a given API request. Current version is 2020-09-17.","uniqueKey":"","typeLabel":"string\u003cdate>"},"description":"Header used to specify the version for a given API request. Current version is 2020-09-17.","x-stainless-param":false},"551a27c3-7449-4105-8fe6-9d3f63d5c40c":{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string","default":"application/json","isRequired":true,"description":"Used to indicate the original media type of the resource ","uniqueKey":"","typeLabel":"string"},"description":"Used to indicate the original media type of the resource ","x-stainless-param":false}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"type":{"oneOf":[{"type":"string","enum":["457","401k","401k_roth","401k_loan","403b","403b_roth","457_roth","commuter","custom_post_tax","custom_pre_tax","fsa_dependent_care","fsa_medical","hsa_post","hsa_pre","s125_dental","s125_medical","s125_vision","simple","simple_ira",null],"description":"Type of benefit.","title":"BenefitType","x-tags":["Models"],"x-stainless-renameMap":{"_401k_loan":"401k_loan","_401k_roth":"401k_roth","_401k":"401k","_403b_roth":"403b_roth","_403b":"403b","_457_roth":"457_roth","_457":"457"},"uniqueKey":"type.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["457","401k","401k_roth","401k_loan","403b","403b_roth","457_roth","commuter","custom_post_tax","custom_pre_tax","fsa_dependent_care","fsa_medical","hsa_post","hsa_pre","s125_dental","s125_medical","s125_vision","simple","simple_ira",null],"description":"Type of benefit.","title":"BenefitType","x-tags":["Models"],"x-stainless-renameMap":{"_401k_loan":"401k_loan","_401k_roth":"401k_roth","_401k":"401k","_403b_roth":"403b_roth","_403b":"403b","_457_roth":"457_roth","_457":"457"},"uniqueKey":"type.oneOf.1","typeLabel":"null"}],"uniqueKey":"type","typeLabel":"enum\u003cstring> | null"},"description":{"type":"string","title":"BenefitDescription","description":"Name of the benefit as it appears in the provider and pay statements. Recommend limiting this to \u003c30 characters due to limitations in specific providers (e.g. Justworks).","x-tags":["Models"],"uniqueKey":"description","typeLabel":"string"},"frequency":{"oneOf":[{"type":"string","enum":["every_paycheck","monthly","one_time",null],"description":"The frequency of the benefit deduction/contribution.","title":"BenefitFrequency","x-tags":["Models"],"uniqueKey":"frequency.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["every_paycheck","monthly","one_time",null],"description":"The frequency of the benefit deduction/contribution.","title":"BenefitFrequency","x-tags":["Models"],"uniqueKey":"frequency.oneOf.1","typeLabel":"null"}],"uniqueKey":"frequency","typeLabel":"enum\u003cstring> | null"},"company_contribution":{"oneOf":[{"type":"object","properties":{"type":{"type":"string","enum":["match"],"isRequired":true,"uniqueKey":"company_contribution.oneOf.0.type","typeLabel":"enum\u003cstring>"},"tiers":{"type":"array","items":{"type":"object","properties":{"match":{"type":"integer","minimum":1,"maximum":10000,"isRequired":true,"uniqueKey":"company_contribution.oneOf.0.tiers.items.[INDEX].match","typeLabel":"integer"},"threshold":{"type":"integer","minimum":1,"maximum":10000,"isRequired":true,"uniqueKey":"company_contribution.oneOf.0.tiers.items.[INDEX].threshold","typeLabel":"integer"}},"required":["match","threshold"],"uniqueKey":"company_contribution.oneOf.0.tiers.items.[INDEX]","typeLabel":"object"},"minItems":1,"maxItems":3,"isRequired":true,"uniqueKey":"company_contribution.oneOf.0.tiers","typeLabel":"object[]"}},"required":["type","tiers"],"description":"The company match for this benefit.","title":"BenefitCompanyMatchContribution","x-tags":["Models"],"uniqueKey":"company_contribution.oneOf.0","typeLabel":"BenefitCompanyMatchContribution · object"},{"type":"null","properties":{"type":{"type":"string","enum":["match"]},"tiers":{"type":"array","items":{"type":"object","properties":{"match":{"type":"integer","minimum":1,"maximum":10000},"threshold":{"type":"integer","minimum":1,"maximum":10000}},"required":["match","threshold"]},"minItems":1,"maxItems":3}},"required":["type","tiers"],"description":"The company match for this benefit.","title":"BenefitCompanyMatchContribution","x-tags":["Models"],"uniqueKey":"company_contribution.oneOf.1","typeLabel":"null"}],"uniqueKey":"company_contribution","typeLabel":"BenefitCompanyMatchContribution · object | null"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"description":"\u003cstring>","company_contribution":{"type":"match","tiers":[{"match":5000,"threshold":5000}]}}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"3ac0b301-4349-425a-9f70-705f259c5082":{"description":"Successfully Created","content":{"application/json":{"schema":{"type":"object","properties":{"benefit_id":{"type":"string","format":"uuid","description":"The id of the benefit.","isRequired":true,"uniqueKey":"benefit_id","typeLabel":"string\u003cuuid>"},"job_id":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"job_id","typeLabel":"string\u003cuuid>"}},"required":["benefit_id","job_id"],"uniqueKey":"","typeLabel":"object"},"examples":{"Success":{"title":"Success","value":{"benefit_id":"e8b90071-0c11-471c-86e8-e303ef2f6782","job_id":"be1b3351-a88e-46c2-96e4-c2cf38e529a7"}}},"exampleType":"examples"}},"exampleType":"examples"},"70eea74a-6041-4902-b7de-e201697bd958":{"description":"The request has been accepted for processing, but data is not yet available","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","isRequired":true,"uniqueKey":"name","typeLabel":"string"},"finch_code":{"type":"string","isRequired":true,"uniqueKey":"finch_code","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"code":{"type":"number","default":202,"uniqueKey":"code","typeLabel":"number"}},"required":["name","finch_code","message"],"uniqueKey":"","typeLabel":"object"},"examples":{"DataSyncInProgress":{"title":"DataSyncInProgress","value":{"code":202,"name":"sync_in_progress","finch_code":"data_sync_in_progress","message":"The data being requested is being fetched. Please check back later."}},"AuthorizationPending":{"title":"AuthorizationPending","value":{"code":202,"name":"authorization_pending","finch_code":"pending","message":"Authorization to this company's data is pending"}},"AccountantSetupPending":{"title":"AccountantSetupPending","value":{"code":202,"name":"authorization_pending","finch_code":"accountant_setup_pending","message":"Finch is still setting up the accountant user for this connection. Please try again later."}}},"exampleType":"examples"}},"exampleType":"examples"},"fc44a5e2-0f96-44f6-af62-c8420427e822":{"description":"Malformed Request","content":{"application/json":{"schema":{"title":"Error","type":"object","description":"Generic error response structure","properties":{"code":{"type":"integer","description":"The status code of the request.","isRequired":true,"uniqueKey":"code","typeLabel":"integer"},"name":{"type":"string","description":"Identifier describing the error.","isRequired":true,"uniqueKey":"name","typeLabel":"string"},"finch_code":{"type":"string","description":"A descriptive identifier for the error.","isRequired":true,"uniqueKey":"finch_code","typeLabel":"string"},"message":{"type":"string","description":"A short English description that provides more information about the error.","isRequired":true,"uniqueKey":"message","typeLabel":"string"}},"required":["code","name","finch_code","message"],"uniqueKey":"","typeLabel":"Error · object"},"examples":{"MissingEntityIds":{"title":"MissingEntityIds","value":{"code":400,"name":"invalid_request_error","finch_code":"invalid_request","message":"Multi-entity connection requires entity_ids query parameter when multiple entities exist"}},"UnknownEntityId":{"title":"UnknownEntityId","value":{"code":400,"name":"invalid_request_error","finch_code":"invalid_request","message":"Provided entity_id 550e8400-e29b-41d4-a716-446655440000 does not match any connected entities"}},"InvalidEntityIds":{"title":"InvalidEntityIds","value":{"code":400,"name":"invalid_request_error","finch_code":"invalid_request","message":"Invalid query parameters for entity_ids"}},"Bad Request":{"title":"Bad Request","value":{"code":400,"name":"invalid_request_error","finch_code":"invalid_request","message":"[body:description]: Not a valid string"}}},"exampleType":"examples"}},"exampleType":"examples"},"41b28817-805a-497f-bfb4-c6b7de76a377":{"description":"Request provided with unsupported parameters","content":{"application/json":{"schema":{"title":"Error","type":"object","description":"Generic error response structure","properties":{"code":{"type":"integer","description":"The status code of the request.","isRequired":true,"uniqueKey":"code","typeLabel":"integer"},"name":{"type":"string","description":"Identifier describing the error.","isRequired":true,"uniqueKey":"name","typeLabel":"string"},"finch_code":{"type":"string","description":"A descriptive identifier for the error.","isRequired":true,"uniqueKey":"finch_code","typeLabel":"string"},"message":{"type":"string","description":"A short English description that provides more information about the error.","isRequired":true,"uniqueKey":"message","typeLabel":"string"}},"required":["code","name","finch_code","message"],"uniqueKey":"","typeLabel":"Error · object"},"examples":{"Invalid Benefit":{"title":"Invalid Benefit","value":{"code":422,"name":"unprocessable_request_error","finch_code":"unsupported_paramters","message":"Provider does not support benefit type '401k'"}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"c4786cc4-28ba-4656-b243-25337383163a":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Please use your Access Token","scopes":[],"schemeName":"bearerAuth"}}},"servers":{"c751b629-e47c-48d2-9131-f14412d7ead8":{"url":"https://api.tryfinch.com","description":""}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","description":"Please use your Access Token","scopes":[],"schemeName":"bearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Please use your Access Token","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"}]},"originalFileLocation":"openapi.json"},"subdomain":"finch","siteName":"Finch","title":"Create Deduction - Finch","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2025-09-15T15:44:25.847Z","originalFileLocation":"api-reference/deductions/create-deduction.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Creates a new company-wide deduction or contribution. Please use the /providers endpoint to view available types for each provider.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Finch\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/finch/uhsSWlAJd6T26wSS/_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/finch/uhsSWlAJd6T26wSS/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/finch/uhsSWlAJd6T26wSS/_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/finch/uhsSWlAJd6T26wSS/_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/finch/uhsSWlAJd6T26wSS/_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/finch/uhsSWlAJd6T26wSS/_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/finch/uhsSWlAJd6T26wSS/_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/finch/uhsSWlAJd6T26wSS/_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/finch/uhsSWlAJd6T26wSS/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Create Deduction - Finch\">\u003cmeta data-mint-head property=\"og:description\" content=\"Creates a new company-wide deduction or contribution. Please use the /providers endpoint to view available types for each provider.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Finch\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://developer.tryfinch.com/api-reference/deductions/create-deduction\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://finch.mintlify.app/_mintlify/api/og/v2?division=Deductions\u0026amp;title=Create+Deduction\u0026amp;description=Creates+a+new+company-wide+deduction+or+contribution.+Please+use+the+%60%2Fproviders%60+endpoint+to+view+available+types+for+each+provider.\u0026amp;theme=833c5e58755e897492517fe7\u0026amp;signature=abe8239d313e3f7b546fbcc6901ca4151c5e1eb471b42ca64d8bbd3704e7682b\">\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=\"Create Deduction - Finch\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Creates a new company-wide deduction or contribution. Please use the /providers endpoint to view available types for each provider.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://finch.mintlify.app/_mintlify/api/og/v2?division=Deductions\u0026amp;title=Create+Deduction\u0026amp;description=Creates+a+new+company-wide+deduction+or+contribution.+Please+use+the+%60%2Fproviders%60+endpoint+to+view+available+types+for+each+provider.\u0026amp;theme=833c5e58755e897492517fe7\u0026amp;signature=abe8239d313e3f7b546fbcc6901ca4151c5e1eb471b42ca64d8bbd3704e7682b\">\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/finch/uhsSWlAJd6T26wSS/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Finch\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#161616\">\u003clink data-mint-head rel=\"canonical\" href=\"https://developer.tryfinch.com/api-reference/deductions/create-deduction\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/deductions/create-deduction.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://developer.tryfinch.com/#organization\",\"name\":\"Finch\",\"url\":\"https://developer.tryfinch.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/finch/ejF2Kw2CeeMQKCJw/logo/logo-black.svg?fit=max\u0026auto=format\u0026n=ejF2Kw2CeeMQKCJw\u0026q=85\u0026s=e490dba98fb7b16e8f9f5ab4a9a58a5c\"}},{\"@type\":\"WebSite\",\"@id\":\"https://developer.tryfinch.com#website\",\"name\":\"Finch\",\"url\":\"https://developer.tryfinch.com\",\"publisher\":{\"@id\":\"https://developer.tryfinch.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://developer.tryfinch.com/api-reference/deductions/create-deduction#webpage\",\"url\":\"https://developer.tryfinch.com/api-reference/deductions/create-deduction\",\"name\":\"Create Deduction\",\"description\":\"Creates a new company-wide deduction or contribution. Please use the /providers endpoint to view available types for each provider.\",\"dateModified\":\"2025-09-15T15:44:25.847Z\",\"isPartOf\":{\"@id\":\"https://developer.tryfinch.com#website\"},\"breadcrumb\":{\"@id\":\"https://developer.tryfinch.com/api-reference/deductions/create-deduction#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://developer.tryfinch.com/api-reference/deductions/create-deduction#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Deductions\",\"item\":\"https://developer.tryfinch.com/api-reference/deductions/get-all-deductions\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Create Deduction\",\"item\":\"https://developer.tryfinch.com/api-reference/deductions/create-deduction\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://developer.tryfinch.com/api-reference/deductions/create-deduction#apireference\",\"headline\":\"Create Deduction\",\"name\":\"Create Deduction\",\"description\":\"Creates a new company-wide deduction or contribution. Please use the /providers endpoint to view available types for each provider.\",\"url\":\"https://developer.tryfinch.com/api-reference/deductions/create-deduction\",\"mainEntityOfPage\":{\"@id\":\"https://developer.tryfinch.com/api-reference/deductions/create-deduction#webpage\"},\"dateModified\":\"2025-09-15T15:44:25.847Z\",\"publisher\":{\"@id\":\"https://developer.tryfinch.com/#organization\"},\"isPartOf\":{\"@id\":\"https://developer.tryfinch.com#website\"}}]}\u003c/script>","siteName":"Finch","nav":{"global":{"anchors":[{"anchor":"Changelog","icon":{"style":"sharp-solid","name":"megaphone"},"color":{"light":"#3E4AE7","dark":"#3E4AE7"},"href":"https://developer.tryfinch.com/changelog"},{"anchor":"API Status","icon":{"style":"sharp-solid","name":"signal-bars"},"color":{"light":"#3E4AE7","dark":"#3E4AE7"},"href":"https://status.tryfinch.com"}]},"tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":"/how-finch-works/quickstart"}]},{"tab":"API Reference","groups":[{"group":"Organization","pages":[{"openapi":"get /employer/company","title":"Company","href":"/api-reference/organization/company"},{"openapi":"get /employer/directory","title":"Directory","href":"/api-reference/organization/directory"},{"openapi":"post /employer/individual","title":"Individual","href":"/api-reference/organization/individual"},{"openapi":"post /employer/employment","title":"Employment","href":"/api-reference/organization/employment"}]},{"group":"Payroll","pages":[{"openapi":"get /employer/payment","title":"Payment","href":"/api-reference/payroll/payment"},{"openapi":"post /employer/pay-statement","title":"Pay Statement","href":"/api-reference/payroll/pay-statement"},{"openapi":"get /employer/pay-statement-item","title":"Pay Statement Item","href":"/api-reference/payroll/get-pay-statement-items"},{"group":"Rules","pages":[{"openapi":"post /employer/pay-statement-item/rule","title":"Create Rule","href":"/api-reference/payroll/create-rule"},{"openapi":"get /employer/pay-statement-item/rule","title":"Get Rules","href":"/api-reference/payroll/get-rules"},{"openapi":"put /employer/pay-statement-item/rule/{rule_id}","title":"Update Rule","href":"/api-reference/payroll/update-rule"},{"openapi":"delete /employer/pay-statement-item/rule/{rule_id}","title":"Delete Rule","href":"/api-reference/payroll/delete-rule"}]},{"openapi":"get /employer/pay-groups","title":"Get All Pay Groups","href":"/api-reference/payroll/get-pay-groups"},{"openapi":"get /employer/pay-groups/{pay_group_id}","title":"Get Pay Group","href":"/api-reference/payroll/get-pay-group"},{"openapi":"post /employer/ledger-items","title":"Ledger Items","href":"/api-reference/payroll/get-ledger-items"}]},{"group":"Deductions","pages":[{"openapi":"get /employer/benefits","title":"Get All Deductions","href":"/api-reference/deductions/get-all-deductions"},{"openapi":"post /employer/benefits/register","title":"Register Deduction","description":"Register existing benefits from the customer on the provider, on Finch's end. Please use the `/provider` endpoint to view available types for each provider.","href":"/api-reference/deductions/register-deduction"},{"openapi":"post /employer/benefits","title":"Create Deduction","href":"/api-reference/deductions/create-deduction"},{"openapi":"get /employer/benefits/{benefit_id}","title":"Get Deduction","description":"Lists deductions and contributions information for a given item","href":"/api-reference/deductions/get-deduction"},{"openapi":"post /employer/benefits/{benefit_id}","title":"Update Deduction","href":"/api-reference/deductions/update-deduction"},{"openapi":"get /employer/benefits/{benefit_id}/enrolled","title":"Get Enrolled Individuals","href":"/api-reference/deductions/get-enrolled-individuals"},{"openapi":"get /employer/benefits/{benefit_id}/individuals","title":"Get Deductions for Individuals","href":"/api-reference/deductions/get-deductions-for-individuals"},{"openapi":"post /employer/benefits/{benefit_id}/individuals","title":"Enroll Individuals in Deductions","href":"/api-reference/deductions/enroll-individuals-in-deductions"},{"openapi":"delete /employer/benefits/{benefit_id}/individuals","title":"Unenroll Individuals from Deductions","href":"/api-reference/deductions/unenroll-individuals-from-deductions"}]},{"group":"Benefits","pages":[{"openapi":"get /employer/plans","title":"List Plans","href":"/api-reference/benefits/list-plans"},{"openapi":"get /employer/plans/{plan_id}","title":"Get Plan","href":"/api-reference/benefits/get-plan"},{"openapi":"get /employer/plans-enrollments","title":"List Enrollments","href":"/api-reference/benefits/list-plan-enrollments"},{"openapi":"post /employer/plans-enrollments","title":"Get Enrollments","href":"/api-reference/benefits/get-plan-enrollments"},{"openapi":"get /employer/plans-dependents","title":"List Dependents","href":"/api-reference/benefits/list-plan-dependents"},{"openapi":"post /employer/plans-dependents","title":"Get Dependents","href":"/api-reference/benefits/get-plan-dependents"}]},{"group":"Documents","pages":[{"openapi":"get /employer/documents","title":"List Documents","href":"/api-reference/documents/get-documents"},{"openapi":"get /employer/documents/{document_id}","title":"Get Document","href":"/api-reference/documents/get-document"}]},{"group":"Connect","pages":[{"openapi":"post /connect/sessions","title":"Create a new connect session","href":"/api-reference/connect/new-session"},{"openapi":"post /connect/sessions/reauthenticate","title":"Create a new Connect session for reauthentication","href":"/api-reference/connect/reauthenticate-session"}]},{"group":"Management","pages":[{"openapi":"post /auth/token","title":"Create Access Token","href":"/api-reference/management/create-access-token"},{"openapi":"get /providers","title":"Providers","href":"/api-reference/management/providers"},{"openapi":"get /introspect","title":"Introspect","href":"/api-reference/management/introspect"},{"openapi":"post /disconnect","title":"Disconnect","href":"/api-reference/management/disconnect"},{"openapi":"post /disconnect-entity","title":"Disconnect Entity","href":"/api-reference/management/disconnect-entity"},{"openapi":"post /forward","title":"Request Forwarding","href":"/api-reference/management/request-forwarding"},{"openapi":"get /jobs/automated","title":"List All Automated Jobs","href":"/api-reference/management/list-all-automated-jobs"},{"openapi":"post /jobs/automated","title":"Enqueue a New Automated Job","href":"/api-reference/management/enqueue-a-new-automated-job"},{"openapi":"get /jobs/automated/{job_id}","title":"Retrieve an Automated Job","href":"/api-reference/management/retrieve-an-automated-job"},{"openapi":"get /jobs/manual/{job_id}","title":"Retrieve a Manual Job","href":"/api-reference/management/retrieve-a-manual-job"}]},{"group":"Sandbox","pages":[{"openapi":"post /sandbox/connections","title":"Create a new Sandbox Connection","href":"/api-reference/sandbox/create-sandbox-connection"},{"openapi":"post /sandbox/connections/accounts","title":"Create a new sandbox account","href":"/api-reference/sandbox/create-sandbox-account"},{"openapi":"put /sandbox/connections/accounts","title":"Update a sandbox account","href":"/api-reference/sandbox/update-sandbox-account"},{"openapi":"get /sandbox/jobs/configuration","title":"Get configurations for sandbox jobs","href":"/api-reference/sandbox/get-sandbox-jobs-configuration"},{"openapi":"put /sandbox/jobs/configuration","title":"Update configurations for sandbox jobs","href":"/api-reference/sandbox/update-sandbox-jobs-configuration"},{"openapi":"post /sandbox/payment","title":"Add a new sandbox payment","href":"/api-reference/sandbox/create-sandbox-payment"},{"openapi":"put /sandbox/individual/{individual_id}","title":"Update sandbox individual","href":"/api-reference/sandbox/update-sandbox-individual"},{"openapi":"put /sandbox/employment/{individual_id}","title":"Update sandbox employment","href":"/api-reference/sandbox/update-sandbox-employment"},{"openapi":"post /sandbox/directory","title":"Add new individuals to a sandbox company","href":"/api-reference/sandbox/create-sandbox-employee"},{"openapi":"put /sandbox/company","title":"Update a sandbox company's data","href":"/api-reference/sandbox/update-sandbox-company"},{"openapi":"post /sandbox/jobs","title":"Enqueue a new sandbox job","href":"/api-reference/sandbox/refresh-job"}]},{"group":"Development Guides","pages":[{"title":"Permissions","href":"/api-reference/development-guides/Permissions"},{"title":"Headers","href":"/api-reference/development-guides/Headers"},{"title":"API Versioning","href":"/api-reference/development-guides/Versioning"},{"title":"Rate Limits","href":"/api-reference/development-guides/Rate-Limits"},{"title":"Handling API Responses","href":"/api-reference/development-guides/Handling-API-Responses"},{"group":"Errors","pages":[{"title":"Error Handling","href":"/api-reference/development-guides/errors/Error-Handling"},{"title":"Error Types","href":"/api-reference/development-guides/errors/Error-Types"}]}]}]}]},"basePath":"","title":"Create Deduction - Finch","buildId":"dpl_G9nrg4qeJSZtah1Ziwbc2n6WkLch","deploymentId":"dpl_G9nrg4qeJSZtah1Ziwbc2n6WkLch","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-B7XKH4J3.js","utils-lOYzL7z-.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-DF6jUUIM.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-Dpsj5f7C.js","snippetPresets-CYeiDe8v.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-CUFz1YZ_.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-D8H_iLS4.js","shallow-DdluZBHX.js","getApiPlaygroundDisplay-B9922vev.js","CodeSnippet-CMoRNGYs.js","CodeSnippets-DwyrPHuw.js","Page-DSVu9Ucl.js","getPastedJson-G-zIvlHh.js","icon-B03fnEy0.js","MethodPill-CW7teklc.js","DuplicateIcon-CtO8eekd.js","createIcon-DZTKdM_A.js","DynamicMarkdown-D5M2At0B.js","SectionHeading-C_2NaA2U.js","axios-vUo_bRtp.js","Markdown-D7QRHV3m.js","clsx-D1Z-ELXV.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-lvhuD9Du.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-CKfC4ywL.js"]}