The employee's income as reported by the provider. This may not always be annualized income, but may be in units of bi-weekly, semi-monthly, daily, etc, depending on what information the provider returns.
The employee's income as reported by the provider. This may not always be annualized income, but may be in units of bi-weekly, semi-monthly, daily, etc, depending on what information the provider returns.
Custom fields for the individual. These are fields which are defined by the employer in the system. Custom fields are not currently supported for assisted connections.
The employer defined benefit eligibility class that groups an employee into a set of eligible benefit plans, as stored by the provider. Null when not configured.
IRS flag indicating whether the employee is classified as a Highly Compensated Employee for nondiscrimination testing purposes (ADP/ACP tests). US-only.
The employee's income as reported by the provider. This may not always be annualized income, but may be in units of bi-weekly, semi-monthly, daily, etc, depending on what information the provider returns.
The employee's income as reported by the provider. This may not always be annualized income, but may be in units of bi-weekly, semi-monthly, daily, etc, depending on what information the provider returns.
Custom fields for the individual. These are fields which are defined by the employer in the system. Custom fields are not currently supported for assisted connections.
The employer defined benefit eligibility class that groups an employee into a set of eligible benefit plans, as stored by the provider. Null when not configured.
IRS flag indicating whether the employee is classified as a Highly Compensated Employee for nondiscrimination testing purposes (ADP/ACP tests). US-only.
A stable Finch id (UUID v4) for an individual in the company.
Was this page helpful?
{"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":"6aeb5f87e84fb046db8c951b","collectionId":"64d351ca-beac-4c90-9889-7b8583980a63","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6aeb5f87e84fb046db8c951b"},"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":"6aeb5f87e84fb046db8c951b","clientVersion":"0.0.4067","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":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"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":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":":root{--finch-purple: #3E4AE7;--finch-purple-dark: #7A84FF}.update-container [class*=\"bg-primary\"]{background-color:rgba(62, 74, 231, 0.08)!important;color:var(--finch-purple)!important}.dark .update-container [class*=\"bg-primary\"]{background-color:rgba(122, 132, 255, 0.15)!important;color:var(--finch-purple-dark)!important}#content-side-layout:empty{position:absolute}#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:none;background:#fff;color:#101828;transition:border-color 0.15s, box-shadow 0.15s}.pn-search:focus{border-color:var(--finch-purple);box-shadow:0 0 0 3px rgba(62, 74, 231, 0.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, 0.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{font-size:13px;font-weight:600;color:#475467;margin-right:2px;white-space:nowrap}.dark .pn-filter-label{color:#98A2B3}.pn-checkbox-label{display:flex;align-items:center;gap:6px;font-size:13px;font-weight:500;color:#344054;cursor:pointer}.dark .pn-checkbox-label{color:#D0D5DD}.pn-export-btn{display:inline-flex;align-items:center;gap:6px;padding:4px 12px;border:1px solid #D0D5DD;border-radius:6px;background:transparent;font-size:13px;font-weight:500;color:#475467;cursor:pointer;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{display:inline-flex;align-items:center;padding:4px 12px;font-size:13px;font-weight:500;border:1px solid #D0D5DD;border-radius:999px;background:#fff;color:#344054;cursor:pointer;transition:all 0.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}.pn-table td,.pn-table th{min-width:0!important}.pn-col-narrow{width:1%!important}.pn-th-center,.pn-td-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-weight:600;font-size:12px;text-transform:uppercase;letter-spacing:0.04em;color:#475467;border-bottom:2px solid #E4E7EC;white-space:nowrap}.dark .pn-table thead th{color:#98A2B3;border-bottom-color:#344054}.pn-table tbody tr{border-bottom:1px solid #F2F4F7;transition:background 0.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 th:first-child,.pn-table td: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{display:inline-flex;align-items:center;gap:6px}.pn-id-cell{display:inline-flex;align-items:center;gap:4px}.pn-id-cell code{font-size:12px}.pn-copy-btn{display:inline-flex;align-items:center;justify-content:center;background:none;border:none;cursor:pointer;color:#98A2B3;padding:2px;border-radius:4px;transition:color 0.15s, background 0.15s}.pn-copy-btn:hover{color:var(--finch-purple);background:#F2F4F7}.dark .pn-copy-btn:hover{color:var(--finch-purple-dark);background:#344054}.pn-badge-assisted-fast,.assisted-fast-badge,.pn-badge-automated,.pn-badge-assisted{display:inline-block;padding:1px 6px;border-radius:999px;font-size:11px;font-weight:500;white-space:nowrap}.pn-badge-assisted-fast,.assisted-fast-badge{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-ga,.pn-status-beta{display:inline-block;padding:1px 6px;border-radius:999px;font-size:10px;font-weight:600;letter-spacing:0.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-oauth,.fsm-auth-credential,.fsm-auth-api_token,.fsm-auth-assisted{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{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:0.02em;flex-shrink:0}.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{display:inline-flex;align-items:center;gap:6px;padding:7px 12px;border:1px solid #e2e8f0;border-radius:8px;background:transparent;font-size:13px;font-weight:500;color:#64748b;cursor:pointer}.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;align-items:center;gap:8px;width:100%;padding:5px 10px;border:none;font-size:13px;border-radius:6px;cursor:pointer;text-align:left;background:transparent;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,0.08)}.dark .fsm-drop-item-selected{background:rgba(122,132,255,0.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,0.15);z-index:100;pointer-events:none}.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-btn-tooltip-wrap:hover .fsm-btn-tooltip{display:block}.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-tip:hover .fsm-tip-text{display:block}#fsm-table-scroll,#fsm-top-scroll{margin-left:0!important;margin-right:0!important;max-width:100%!important}#fsm-table-scroll table td,#fsm-table-scroll table th{min-width:0!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:transparent}#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/sandbox/update-sandbox-employment","slug":"/api-reference/sandbox/update-sandbox-employment","pageMetadata":{"openapi":"put /sandbox/employment/{individual_id}","title":"Update sandbox employment","description":null,"href":"/api-reference/sandbox/update-sandbox-employment"},"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":{"openapi":"put /sandbox/employment/{individual_id}","title":"Update sandbox employment","description":null,"href":"/api-reference/sandbox/update-sandbox-employment"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"summary":"Update sandbox employment","operationId":"put-sandbox-employment-individual_id","tags":["Sandbox"],"requestBody":"c87d2126-f33e-4e3a-812a-c81b94f4ab74","security":["fc528a6c-c52a-4056-a904-7808c513af1c"],"responses":{"200":"e4728103-b79f-48cd-88b9-f716e571037c"},"x-codeSamples":[{"lang":"JavaScript","source":"import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\nconst employment = await client.sandbox.employment.update('individual_id', {\n start_date: '3/4/2020',\n});\n\nconsole.log(employment.id);"},{"lang":"Python","source":"from finch import Finch\n\nclient = Finch(\n access_token=\"My Access Token\",\n)\nemployment = client.sandbox.employment.update(\n individual_id=\"individual_id\",\n start_date=\"3/4/2020\",\n)\nprint(employment.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\temployment, err := client.Sandbox.Employment.Update(\n\t\tcontext.TODO(),\n\t\t\"individual_id\",\n\t\tfinchgo.SandboxEmploymentUpdateParams{\n\t\t\tStartDate: finchgo.F(\"3/4/2020\"),\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", employment.ID)\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.EmploymentUpdateResponse;\nimport com.tryfinch.api.models.SandboxEmploymentUpdateParams;\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 EmploymentUpdateResponse employment = client.sandbox().employment().update(\"individual_id\");\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.EmploymentUpdateResponse\nimport com.tryfinch.api.models.SandboxEmploymentUpdateParams\n\nfun main() {\n val client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken(\"My Access Token\")\n .build()\n\n val employment: EmploymentUpdateResponse = client.sandbox().employment().update(\"individual_id\")\n}"},{"lang":"Ruby","source":"require \"finch_api\"\n\nfinch = FinchAPI::Client.new(access_token: \"My Access Token\")\n\nemployment = finch.sandbox.employment.update(\"individual_id\")\n\nputs(employment)"}],"method":"put","type":"path","servers":["e36ac43a-0e97-452c-aef7-f8b3c2e6e57e"],"path":"/sandbox/employment/{individual_id}","baseUrlOptions":["https://api.tryfinch.com"],"title":"Update sandbox employment","description":"","codeSamples":[{"lang":"JavaScript","source":"import Finch from '@tryfinch/finch-api';\n\nconst client = new Finch({\n accessToken: 'My Access Token',\n});\n\nconst employment = await client.sandbox.employment.update('individual_id', {\n start_date: '3/4/2020',\n});\n\nconsole.log(employment.id);"},{"lang":"Python","source":"from finch import Finch\n\nclient = Finch(\n access_token=\"My Access Token\",\n)\nemployment = client.sandbox.employment.update(\n individual_id=\"individual_id\",\n start_date=\"3/4/2020\",\n)\nprint(employment.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\temployment, err := client.Sandbox.Employment.Update(\n\t\tcontext.TODO(),\n\t\t\"individual_id\",\n\t\tfinchgo.SandboxEmploymentUpdateParams{\n\t\t\tStartDate: finchgo.F(\"3/4/2020\"),\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", employment.ID)\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.EmploymentUpdateResponse;\nimport com.tryfinch.api.models.SandboxEmploymentUpdateParams;\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 EmploymentUpdateResponse employment = client.sandbox().employment().update(\"individual_id\");\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.EmploymentUpdateResponse\nimport com.tryfinch.api.models.SandboxEmploymentUpdateParams\n\nfun main() {\n val client: FinchClient = FinchOkHttpClient.builder()\n .fromEnv()\n .accessToken(\"My Access Token\")\n .build()\n\n val employment: EmploymentUpdateResponse = client.sandbox().employment().update(\"individual_id\")\n}"},{"lang":"Ruby","source":"require \"finch_api\"\n\nfinch = FinchAPI::Client.new(access_token: \"My Access Token\")\n\nemployment = finch.sandbox.employment.update(\"individual_id\")\n\nputs(employment)"}],"requiredOnlyExamples":false,"requestExampleType":"codeSamples","responseExampleType":"generated"},"dependencies":{"parameters":{"766433c5-79c5-4ff9-a170-8df3af399e33":{"schema":{"type":"string","isRequired":true,"uniqueKey":"","typeLabel":"string"},"name":"individual_id","in":"path","required":true}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"first_name":{"oneOf":[{"type":"string","description":"The legal first name of the individual.","uniqueKey":"first_name.oneOf.0","typeLabel":"string"},{"type":"null","description":"The legal first name of the individual.","uniqueKey":"first_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"first_name","typeLabel":"string | null"},"middle_name":{"oneOf":[{"type":"string","description":"The legal middle name of the individual.","uniqueKey":"middle_name.oneOf.0","typeLabel":"string"},{"type":"null","description":"The legal middle name of the individual.","uniqueKey":"middle_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"middle_name","typeLabel":"string | null"},"last_name":{"oneOf":[{"type":"string","description":"The legal last name of the individual.","uniqueKey":"last_name.oneOf.0","typeLabel":"string"},{"type":"null","description":"The legal last name of the individual.","uniqueKey":"last_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"last_name","typeLabel":"string | null"},"title":{"oneOf":[{"type":"string","description":"The current title of the individual.","uniqueKey":"title.oneOf.0","typeLabel":"string"},{"type":"null","description":"The current title of the individual.","uniqueKey":"title.oneOf.1","typeLabel":"null"}],"uniqueKey":"title","typeLabel":"string | null"},"manager":{"oneOf":[{"type":"object","description":"The manager object representing the manager of the individual within the org.","properties":{"id":{"type":"string","description":"A stable Finch `id` (UUID v4) for an individual in the company.","format":"uuid","uniqueKey":"manager.oneOf.0.id","typeLabel":"string\u003cuuid>"}},"uniqueKey":"manager.oneOf.0","typeLabel":"object"},{"type":"null","description":"The manager object representing the manager of the individual within the org.","properties":{"id":{"type":"string","description":"A stable Finch `id` (UUID v4) for an individual in the company.","format":"uuid"}},"uniqueKey":"manager.oneOf.1","typeLabel":"null"}],"uniqueKey":"manager","typeLabel":"object | null"},"department":{"oneOf":[{"type":"object","description":"The department object.","properties":{"name":{"oneOf":[{"type":"string","description":"The name of the department associated with the individual.","uniqueKey":"department.oneOf.0.name.oneOf.0","typeLabel":"string"},{"type":"null","description":"The name of the department associated with the individual.","uniqueKey":"department.oneOf.0.name.oneOf.1","typeLabel":"null"}],"uniqueKey":"department.oneOf.0.name","typeLabel":"string | null"}},"uniqueKey":"department.oneOf.0","typeLabel":"object"},{"type":"null","description":"The department object.","properties":{"name":{"oneOf":[{"type":"string","description":"The name of the department associated with the individual."},{"type":"null","description":"The name of the department associated with the individual."}]}},"uniqueKey":"department.oneOf.1","typeLabel":"null"}],"uniqueKey":"department","typeLabel":"object | null"},"employment":{"oneOf":[{"type":"object","description":"The employment object.","properties":{"type":{"oneOf":[{"type":"string","description":"The main employment type of the individual.","enum":["employee","contractor",null],"uniqueKey":"employment.oneOf.0.type.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","description":"The main employment type of the individual.","enum":["employee","contractor",null],"uniqueKey":"employment.oneOf.0.type.oneOf.1","typeLabel":"null"}],"uniqueKey":"employment.oneOf.0.type","typeLabel":"enum\u003cstring> | null"},"subtype":{"oneOf":[{"type":"string","description":"The secondary employment type of the individual. Options: `full_time`, `part_time`, `intern`, `temp`, `seasonal` and `individual_contractor`.","enum":["full_time","intern","part_time","temp","seasonal","individual_contractor",null],"uniqueKey":"employment.oneOf.0.subtype.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","description":"The secondary employment type of the individual. Options: `full_time`, `part_time`, `intern`, `temp`, `seasonal` and `individual_contractor`.","enum":["full_time","intern","part_time","temp","seasonal","individual_contractor",null],"uniqueKey":"employment.oneOf.0.subtype.oneOf.1","typeLabel":"null"}],"uniqueKey":"employment.oneOf.0.subtype","typeLabel":"enum\u003cstring> | null"}},"uniqueKey":"employment.oneOf.0","typeLabel":"object"},{"type":"null","description":"The employment object.","properties":{"type":{"oneOf":[{"type":"string","description":"The main employment type of the individual.","enum":["employee","contractor",null]},{"type":"null","description":"The main employment type of the individual.","enum":["employee","contractor",null]}]},"subtype":{"oneOf":[{"type":"string","description":"The secondary employment type of the individual. Options: `full_time`, `part_time`, `intern`, `temp`, `seasonal` and `individual_contractor`.","enum":["full_time","intern","part_time","temp","seasonal","individual_contractor",null]},{"type":"null","description":"The secondary employment type of the individual. Options: `full_time`, `part_time`, `intern`, `temp`, `seasonal` and `individual_contractor`.","enum":["full_time","intern","part_time","temp","seasonal","individual_contractor",null]}]}},"uniqueKey":"employment.oneOf.1","typeLabel":"null"}],"uniqueKey":"employment","typeLabel":"object | null"},"start_date":{"oneOf":[{"type":"string","title":"Date","uniqueKey":"start_date.oneOf.0","typeLabel":"string"},{"type":"null","title":"Date","uniqueKey":"start_date.oneOf.1","typeLabel":"null"}],"uniqueKey":"start_date","typeLabel":"string | null"},"end_date":{"oneOf":[{"type":"string","title":"Date","uniqueKey":"end_date.oneOf.0","typeLabel":"string"},{"type":"null","title":"Date","uniqueKey":"end_date.oneOf.1","typeLabel":"null"}],"uniqueKey":"end_date","typeLabel":"string | null"},"latest_rehire_date":{"oneOf":[{"type":"string","title":"Date","uniqueKey":"latest_rehire_date.oneOf.0","typeLabel":"string"},{"type":"null","title":"Date","uniqueKey":"latest_rehire_date.oneOf.1","typeLabel":"null"}],"uniqueKey":"latest_rehire_date","typeLabel":"string | null"},"is_active":{"oneOf":[{"type":"boolean","description":"`true` if the individual an an active employee or contractor at the company.","uniqueKey":"is_active.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"`true` if the individual an an active employee or contractor at the company.","uniqueKey":"is_active.oneOf.1","typeLabel":"null"}],"uniqueKey":"is_active","typeLabel":"boolean | null"},"employment_status":{"oneOf":[{"type":"string","description":"The detailed employment status of the individual.","enum":["active","deceased","leave","onboarding","prehire","retired","terminated",null],"uniqueKey":"employment_status.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","description":"The detailed employment status of the individual.","enum":["active","deceased","leave","onboarding","prehire","retired","terminated",null],"uniqueKey":"employment_status.oneOf.1","typeLabel":"null"}],"uniqueKey":"employment_status","typeLabel":"enum\u003cstring> | null"},"flsa_status":{"oneOf":[{"type":"string","description":"The FLSA status of the individual. Available options: `exempt`, `non_exempt`, `unknown`.","enum":["exempt","non_exempt","unknown",null],"uniqueKey":"flsa_status.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","description":"The FLSA status of the individual. Available options: `exempt`, `non_exempt`, `unknown`.","enum":["exempt","non_exempt","unknown",null],"uniqueKey":"flsa_status.oneOf.1","typeLabel":"null"}],"uniqueKey":"flsa_status","typeLabel":"enum\u003cstring> | null"},"class_code":{"oneOf":[{"type":"string","description":"Worker's compensation classification code for this employee","uniqueKey":"class_code.oneOf.0","typeLabel":"string"},{"type":"null","description":"Worker's compensation classification code for this employee","uniqueKey":"class_code.oneOf.1","typeLabel":"null"}],"uniqueKey":"class_code","typeLabel":"string | null"},"location":{"oneOf":[{"type":"object","properties":{"line1":{"oneOf":[{"type":"string","description":"Street address or PO box.","isRequired":true,"uniqueKey":"location.oneOf.0.line1.oneOf.0","typeLabel":"string"},{"type":"null","description":"Street address or PO box.","isRequired":true,"uniqueKey":"location.oneOf.0.line1.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"location.oneOf.0.line1","typeLabel":"string | null"},"line2":{"oneOf":[{"type":"string","description":"Apartment, suite, unit, or building.","isRequired":true,"uniqueKey":"location.oneOf.0.line2.oneOf.0","typeLabel":"string"},{"type":"null","description":"Apartment, suite, unit, or building.","isRequired":true,"uniqueKey":"location.oneOf.0.line2.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"location.oneOf.0.line2","typeLabel":"string | null"},"city":{"oneOf":[{"type":"string","description":"City, district, suburb, town, or village.","isRequired":true,"uniqueKey":"location.oneOf.0.city.oneOf.0","typeLabel":"string"},{"type":"null","description":"City, district, suburb, town, or village.","isRequired":true,"uniqueKey":"location.oneOf.0.city.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"location.oneOf.0.city","typeLabel":"string | null"},"state":{"oneOf":[{"type":"string","description":"The state code.","isRequired":true,"uniqueKey":"location.oneOf.0.state.oneOf.0","typeLabel":"string"},{"type":"null","description":"The state code.","isRequired":true,"uniqueKey":"location.oneOf.0.state.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"location.oneOf.0.state","typeLabel":"string | null"},"postal_code":{"oneOf":[{"type":"string","description":"The postal code or zip code.","isRequired":true,"uniqueKey":"location.oneOf.0.postal_code.oneOf.0","typeLabel":"string"},{"type":"null","description":"The postal code or zip code.","isRequired":true,"uniqueKey":"location.oneOf.0.postal_code.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"location.oneOf.0.postal_code","typeLabel":"string | null"},"country":{"oneOf":[{"type":"string","description":"The 2-letter ISO 3166 country code.","isRequired":true,"uniqueKey":"location.oneOf.0.country.oneOf.0","typeLabel":"string"},{"type":"null","description":"The 2-letter ISO 3166 country code.","isRequired":true,"uniqueKey":"location.oneOf.0.country.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"location.oneOf.0.country","typeLabel":"string | null"},"name":{"oneOf":[{"type":"string","uniqueKey":"location.oneOf.0.name.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"location.oneOf.0.name.oneOf.1","typeLabel":"null"}],"uniqueKey":"location.oneOf.0.name","typeLabel":"string | null"},"source_id":{"oneOf":[{"type":"string","uniqueKey":"location.oneOf.0.source_id.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"location.oneOf.0.source_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"location.oneOf.0.source_id","typeLabel":"string | null"}},"required":["line1","line2","city","state","postal_code","country"],"description":"","title":"Location","x-tags":["Models"],"uniqueKey":"location.oneOf.0","typeLabel":"Location · object"},{"type":"null","properties":{"line1":{"oneOf":[{"type":"string","description":"Street address or PO box."},{"type":"null","description":"Street address or PO box."}]},"line2":{"oneOf":[{"type":"string","description":"Apartment, suite, unit, or building."},{"type":"null","description":"Apartment, suite, unit, or building."}]},"city":{"oneOf":[{"type":"string","description":"City, district, suburb, town, or village."},{"type":"null","description":"City, district, suburb, town, or village."}]},"state":{"oneOf":[{"type":"string","description":"The state code."},{"type":"null","description":"The state code."}]},"postal_code":{"oneOf":[{"type":"string","description":"The postal code or zip code."},{"type":"null","description":"The postal code or zip code."}]},"country":{"oneOf":[{"type":"string","description":"The 2-letter ISO 3166 country code."},{"type":"null","description":"The 2-letter ISO 3166 country code."}]},"name":{"oneOf":[{"type":"string"},{"type":"null"}]},"source_id":{"oneOf":[{"type":"string"},{"type":"null"}]}},"required":["line1","line2","city","state","postal_code","country"],"description":"","title":"Location","x-tags":["Models"],"uniqueKey":"location.oneOf.1","typeLabel":"null"}],"uniqueKey":"location","typeLabel":"Location · object | null"},"income":{"oneOf":[{"type":"object","properties":{"unit":{"oneOf":[{"type":"string","enum":["yearly","quarterly","monthly","semi_monthly","bi_weekly","weekly","daily","hourly","fixed",null],"description":"The income unit of payment. Options: `yearly`, `quarterly`, `monthly`, `semi_monthly`, `bi_weekly`, `weekly`, `daily`, `hourly`, and `fixed`.","isRequired":true,"uniqueKey":"income.oneOf.0.unit.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["yearly","quarterly","monthly","semi_monthly","bi_weekly","weekly","daily","hourly","fixed",null],"description":"The income unit of payment. Options: `yearly`, `quarterly`, `monthly`, `semi_monthly`, `bi_weekly`, `weekly`, `daily`, `hourly`, and `fixed`.","isRequired":true,"uniqueKey":"income.oneOf.0.unit.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"income.oneOf.0.unit","typeLabel":"enum\u003cstring> | null"},"amount":{"oneOf":[{"type":"integer","description":"The income amount in cents.","isRequired":true,"uniqueKey":"income.oneOf.0.amount.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The income amount in cents.","isRequired":true,"uniqueKey":"income.oneOf.0.amount.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"income.oneOf.0.amount","typeLabel":"integer | null"},"currency":{"oneOf":[{"type":"string","description":"The currency code.","isRequired":true,"uniqueKey":"income.oneOf.0.currency.oneOf.0","typeLabel":"string"},{"type":"null","description":"The currency code.","isRequired":true,"uniqueKey":"income.oneOf.0.currency.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"income.oneOf.0.currency","typeLabel":"string | null"},"effective_date":{"oneOf":[{"type":"string","format":"date","description":"The date the income amount went into effect.","isRequired":true,"uniqueKey":"income.oneOf.0.effective_date.oneOf.0","typeLabel":"string\u003cdate>"},{"type":"null","format":"date","description":"The date the income amount went into effect.","isRequired":true,"uniqueKey":"income.oneOf.0.effective_date.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"income.oneOf.0.effective_date","typeLabel":"string\u003cdate> | null"}},"required":["unit","amount","currency","effective_date"],"description":"The employee's income as reported by the provider. This may not always be annualized income, but may be in units of bi-weekly, semi-monthly, daily, etc, depending on what information the provider returns.","title":"Income","x-tags":["Models"],"uniqueKey":"income.oneOf.0","typeLabel":"Income · object"},{"type":"null","properties":{"unit":{"oneOf":[{"type":"string","enum":["yearly","quarterly","monthly","semi_monthly","bi_weekly","weekly","daily","hourly","fixed",null],"description":"The income unit of payment. Options: `yearly`, `quarterly`, `monthly`, `semi_monthly`, `bi_weekly`, `weekly`, `daily`, `hourly`, and `fixed`."},{"type":"null","enum":["yearly","quarterly","monthly","semi_monthly","bi_weekly","weekly","daily","hourly","fixed",null],"description":"The income unit of payment. Options: `yearly`, `quarterly`, `monthly`, `semi_monthly`, `bi_weekly`, `weekly`, `daily`, `hourly`, and `fixed`."}]},"amount":{"oneOf":[{"type":"integer","description":"The income amount in cents."},{"type":"null","description":"The income amount in cents."}]},"currency":{"oneOf":[{"type":"string","description":"The currency code."},{"type":"null","description":"The currency code."}]},"effective_date":{"oneOf":[{"type":"string","format":"date","description":"The date the income amount went into effect."},{"type":"null","format":"date","description":"The date the income amount went into effect."}]}},"required":["unit","amount","currency","effective_date"],"description":"The employee's income as reported by the provider. This may not always be annualized income, but may be in units of bi-weekly, semi-monthly, daily, etc, depending on what information the provider returns.","title":"Income","x-tags":["Models"],"uniqueKey":"income.oneOf.1","typeLabel":"null"}],"uniqueKey":"income","typeLabel":"Income · object | null"},"income_history":{"oneOf":[{"type":"array","description":"The array of income history.","items":{"oneOf":[{"type":"object","properties":{"unit":{"oneOf":[{"type":"string","enum":["yearly","quarterly","monthly","semi_monthly","bi_weekly","weekly","daily","hourly","fixed",null],"description":"The income unit of payment. Options: `yearly`, `quarterly`, `monthly`, `semi_monthly`, `bi_weekly`, `weekly`, `daily`, `hourly`, and `fixed`.","isRequired":true,"uniqueKey":"income_history.oneOf.0.items.[INDEX].oneOf.0.unit.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["yearly","quarterly","monthly","semi_monthly","bi_weekly","weekly","daily","hourly","fixed",null],"description":"The income unit of payment. Options: `yearly`, `quarterly`, `monthly`, `semi_monthly`, `bi_weekly`, `weekly`, `daily`, `hourly`, and `fixed`.","isRequired":true,"uniqueKey":"income_history.oneOf.0.items.[INDEX].oneOf.0.unit.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"income_history.oneOf.0.items.[INDEX].oneOf.0.unit","typeLabel":"enum\u003cstring> | null"},"amount":{"oneOf":[{"type":"integer","description":"The income amount in cents.","isRequired":true,"uniqueKey":"income_history.oneOf.0.items.[INDEX].oneOf.0.amount.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The income amount in cents.","isRequired":true,"uniqueKey":"income_history.oneOf.0.items.[INDEX].oneOf.0.amount.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"income_history.oneOf.0.items.[INDEX].oneOf.0.amount","typeLabel":"integer | null"},"currency":{"oneOf":[{"type":"string","description":"The currency code.","isRequired":true,"uniqueKey":"income_history.oneOf.0.items.[INDEX].oneOf.0.currency.oneOf.0","typeLabel":"string"},{"type":"null","description":"The currency code.","isRequired":true,"uniqueKey":"income_history.oneOf.0.items.[INDEX].oneOf.0.currency.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"income_history.oneOf.0.items.[INDEX].oneOf.0.currency","typeLabel":"string | null"},"effective_date":{"oneOf":[{"type":"string","format":"date","description":"The date the income amount went into effect.","isRequired":true,"uniqueKey":"income_history.oneOf.0.items.[INDEX].oneOf.0.effective_date.oneOf.0","typeLabel":"string\u003cdate>"},{"type":"null","format":"date","description":"The date the income amount went into effect.","isRequired":true,"uniqueKey":"income_history.oneOf.0.items.[INDEX].oneOf.0.effective_date.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"income_history.oneOf.0.items.[INDEX].oneOf.0.effective_date","typeLabel":"string\u003cdate> | null"}},"required":["unit","amount","currency","effective_date"],"description":"The employee's income as reported by the provider. This may not always be annualized income, but may be in units of bi-weekly, semi-monthly, daily, etc, depending on what information the provider returns.","title":"Income","x-tags":["Models"],"uniqueKey":"income_history.oneOf.0.items.[INDEX].oneOf.0","typeLabel":"Income · object"},{"type":"null","properties":{"unit":{"oneOf":[{"type":"string","enum":["yearly","quarterly","monthly","semi_monthly","bi_weekly","weekly","daily","hourly","fixed",null],"description":"The income unit of payment. Options: `yearly`, `quarterly`, `monthly`, `semi_monthly`, `bi_weekly`, `weekly`, `daily`, `hourly`, and `fixed`."},{"type":"null","enum":["yearly","quarterly","monthly","semi_monthly","bi_weekly","weekly","daily","hourly","fixed",null],"description":"The income unit of payment. Options: `yearly`, `quarterly`, `monthly`, `semi_monthly`, `bi_weekly`, `weekly`, `daily`, `hourly`, and `fixed`."}]},"amount":{"oneOf":[{"type":"integer","description":"The income amount in cents."},{"type":"null","description":"The income amount in cents."}]},"currency":{"oneOf":[{"type":"string","description":"The currency code."},{"type":"null","description":"The currency code."}]},"effective_date":{"oneOf":[{"type":"string","format":"date","description":"The date the income amount went into effect."},{"type":"null","format":"date","description":"The date the income amount went into effect."}]}},"required":["unit","amount","currency","effective_date"],"description":"The employee's income as reported by the provider. This may not always be annualized income, but may be in units of bi-weekly, semi-monthly, daily, etc, depending on what information the provider returns.","title":"Income","x-tags":["Models"],"uniqueKey":"income_history.oneOf.0.items.[INDEX].oneOf.1","typeLabel":"null"}],"uniqueKey":"income_history.oneOf.0.items.[INDEX]","typeLabel":"Income · object | null"},"uniqueKey":"income_history.oneOf.0","typeLabel":"(Income · object | null)[]"},{"type":"null","description":"The array of income history.","items":{"oneOf":[{"type":"object","properties":{"unit":{"oneOf":[{"type":"string","enum":["yearly","quarterly","monthly","semi_monthly","bi_weekly","weekly","daily","hourly","fixed",null],"description":"The income unit of payment. Options: `yearly`, `quarterly`, `monthly`, `semi_monthly`, `bi_weekly`, `weekly`, `daily`, `hourly`, and `fixed`."},{"type":"null","enum":["yearly","quarterly","monthly","semi_monthly","bi_weekly","weekly","daily","hourly","fixed",null],"description":"The income unit of payment. Options: `yearly`, `quarterly`, `monthly`, `semi_monthly`, `bi_weekly`, `weekly`, `daily`, `hourly`, and `fixed`."}]},"amount":{"oneOf":[{"type":"integer","description":"The income amount in cents."},{"type":"null","description":"The income amount in cents."}]},"currency":{"oneOf":[{"type":"string","description":"The currency code."},{"type":"null","description":"The currency code."}]},"effective_date":{"oneOf":[{"type":"string","format":"date","description":"The date the income amount went into effect."},{"type":"null","format":"date","description":"The date the income amount went into effect."}]}},"required":["unit","amount","currency","effective_date"],"description":"The employee's income as reported by the provider. This may not always be annualized income, but may be in units of bi-weekly, semi-monthly, daily, etc, depending on what information the provider returns.","title":"Income","x-tags":["Models"]},{"type":"null","properties":{"unit":{"oneOf":[{"type":"string","enum":["yearly","quarterly","monthly","semi_monthly","bi_weekly","weekly","daily","hourly","fixed",null],"description":"The income unit of payment. Options: `yearly`, `quarterly`, `monthly`, `semi_monthly`, `bi_weekly`, `weekly`, `daily`, `hourly`, and `fixed`."},{"type":"null","enum":["yearly","quarterly","monthly","semi_monthly","bi_weekly","weekly","daily","hourly","fixed",null],"description":"The income unit of payment. Options: `yearly`, `quarterly`, `monthly`, `semi_monthly`, `bi_weekly`, `weekly`, `daily`, `hourly`, and `fixed`."}]},"amount":{"oneOf":[{"type":"integer","description":"The income amount in cents."},{"type":"null","description":"The income amount in cents."}]},"currency":{"oneOf":[{"type":"string","description":"The currency code."},{"type":"null","description":"The currency code."}]},"effective_date":{"oneOf":[{"type":"string","format":"date","description":"The date the income amount went into effect."},{"type":"null","format":"date","description":"The date the income amount went into effect."}]}},"required":["unit","amount","currency","effective_date"],"description":"The employee's income as reported by the provider. This may not always be annualized income, but may be in units of bi-weekly, semi-monthly, daily, etc, depending on what information the provider returns.","title":"Income","x-tags":["Models"]}]},"uniqueKey":"income_history.oneOf.1","typeLabel":"null"}],"uniqueKey":"income_history","typeLabel":"(Income · object | null)[] | null"},"custom_fields":{"oneOf":[{"type":"array","description":"Custom fields for the individual. These are fields which are defined by the employer in the system. Custom fields are not currently supported for assisted connections.","items":{"type":"object","properties":{"name":{"oneOf":[{"type":"string","uniqueKey":"custom_fields.oneOf.0.items.[INDEX].name.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"custom_fields.oneOf.0.items.[INDEX].name.oneOf.1","typeLabel":"null"}],"uniqueKey":"custom_fields.oneOf.0.items.[INDEX].name","typeLabel":"string | null"},"value":{"oneOf":[{"type":["string","array","object","number","boolean","null"],"items":{"oneOf":[{}]},"uniqueKey":"custom_fields.oneOf.0.items.[INDEX].value.oneOf.0","typeLabel":"string"},{"type":"null","items":{"oneOf":[{}]},"uniqueKey":"custom_fields.oneOf.0.items.[INDEX].value.oneOf.1","typeLabel":"null"}],"uniqueKey":"custom_fields.oneOf.0.items.[INDEX].value","typeLabel":"string | null"}},"uniqueKey":"custom_fields.oneOf.0.items.[INDEX]","typeLabel":"object"},"uniqueKey":"custom_fields.oneOf.0","typeLabel":"object[]"},{"type":"null","description":"Custom fields for the individual. These are fields which are defined by the employer in the system. Custom fields are not currently supported for assisted connections.","items":{"type":"object","properties":{"name":{"oneOf":[{"type":"string"},{"type":"null"}]},"value":{"oneOf":[{"type":["string","array","object","number","boolean","null"],"items":{"oneOf":[{}]}},{"type":"null","items":{"oneOf":[{}]}}]}}},"uniqueKey":"custom_fields.oneOf.1","typeLabel":"null"}],"uniqueKey":"custom_fields","typeLabel":"object[] | null"},"union_code":{"oneOf":[{"type":"string","description":"The code identifying the union the employee is a member of, as configured in the payroll system.","uniqueKey":"union_code.oneOf.0","typeLabel":"string"},{"type":"null","description":"The code identifying the union the employee is a member of, as configured in the payroll system.","uniqueKey":"union_code.oneOf.1","typeLabel":"null"}],"uniqueKey":"union_code","typeLabel":"string | null"},"union_local":{"oneOf":[{"type":"string","description":"The local chapter or local number within the employee's union.","uniqueKey":"union_local.oneOf.0","typeLabel":"string"},{"type":"null","description":"The local chapter or local number within the employee's union.","uniqueKey":"union_local.oneOf.1","typeLabel":"null"}],"uniqueKey":"union_local","typeLabel":"string | null"},"benefit_eligibility_class":{"oneOf":[{"type":"string","description":"The employer defined benefit eligibility class that groups an employee into a set of eligible benefit plans, as stored by the provider. Null when not configured.","uniqueKey":"benefit_eligibility_class.oneOf.0","typeLabel":"string"},{"type":"null","description":"The employer defined benefit eligibility class that groups an employee into a set of eligible benefit plans, as stored by the provider. Null when not configured.","uniqueKey":"benefit_eligibility_class.oneOf.1","typeLabel":"null"}],"uniqueKey":"benefit_eligibility_class","typeLabel":"string | null"},"highly_compensated_employee":{"oneOf":[{"type":"boolean","description":"IRS flag indicating whether the employee is classified as a Highly Compensated Employee for nondiscrimination testing purposes (ADP/ACP tests). US-only.","uniqueKey":"highly_compensated_employee.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"IRS flag indicating whether the employee is classified as a Highly Compensated Employee for nondiscrimination testing purposes (ADP/ACP tests). US-only.","uniqueKey":"highly_compensated_employee.oneOf.1","typeLabel":"null"}],"uniqueKey":"highly_compensated_employee","typeLabel":"boolean | null"},"key_employee":{"oneOf":[{"type":"boolean","description":"IRS flag indicating whether the employee is classified as a Key Employee for top-heavy testing purposes. US-only.","uniqueKey":"key_employee.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"IRS flag indicating whether the employee is classified as a Key Employee for top-heavy testing purposes. US-only.","uniqueKey":"key_employee.oneOf.1","typeLabel":"null"}],"uniqueKey":"key_employee","typeLabel":"boolean | null"},"source_id":{"oneOf":[{"type":"string","description":"The source system's unique employment identifier for this individual","uniqueKey":"source_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"The source system's unique employment identifier for this individual","uniqueKey":"source_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"source_id","typeLabel":"string | null"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example 1":{"title":"Example 1","value":{"start_date":"3/4/2020"}}},"exampleType":"examples"}},"exampleType":"examples"},"responses":{"e4728103-b79f-48cd-88b9-f716e571037c":{"description":"OK","content":{"application/json":{"schema":{"type":"object","title":"Employment","properties":{"first_name":{"oneOf":[{"type":"string","description":"The legal first name of the individual.","uniqueKey":"first_name.oneOf.0","typeLabel":"string"},{"type":"null","description":"The legal first name of the individual.","uniqueKey":"first_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"first_name","typeLabel":"string | null"},"middle_name":{"oneOf":[{"type":"string","description":"The legal middle name of the individual.","uniqueKey":"middle_name.oneOf.0","typeLabel":"string"},{"type":"null","description":"The legal middle name of the individual.","uniqueKey":"middle_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"middle_name","typeLabel":"string | null"},"last_name":{"oneOf":[{"type":"string","description":"The legal last name of the individual.","uniqueKey":"last_name.oneOf.0","typeLabel":"string"},{"type":"null","description":"The legal last name of the individual.","uniqueKey":"last_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"last_name","typeLabel":"string | null"},"title":{"oneOf":[{"type":"string","description":"The current title of the individual.","uniqueKey":"title.oneOf.0","typeLabel":"string"},{"type":"null","description":"The current title of the individual.","uniqueKey":"title.oneOf.1","typeLabel":"null"}],"uniqueKey":"title","typeLabel":"string | null"},"manager":{"oneOf":[{"type":"object","description":"The manager object representing the manager of the individual within the org.","properties":{"id":{"type":"string","description":"A stable Finch `id` (UUID v4) for an individual in the company.","format":"uuid","uniqueKey":"manager.oneOf.0.id","typeLabel":"string\u003cuuid>"}},"uniqueKey":"manager.oneOf.0","typeLabel":"object"},{"type":"null","description":"The manager object representing the manager of the individual within the org.","properties":{"id":{"type":"string","description":"A stable Finch `id` (UUID v4) for an individual in the company.","format":"uuid"}},"uniqueKey":"manager.oneOf.1","typeLabel":"null"}],"uniqueKey":"manager","typeLabel":"object | null"},"department":{"oneOf":[{"type":"object","description":"The department object.","properties":{"name":{"oneOf":[{"type":"string","description":"The name of the department associated with the individual.","uniqueKey":"department.oneOf.0.name.oneOf.0","typeLabel":"string"},{"type":"null","description":"The name of the department associated with the individual.","uniqueKey":"department.oneOf.0.name.oneOf.1","typeLabel":"null"}],"uniqueKey":"department.oneOf.0.name","typeLabel":"string | null"}},"uniqueKey":"department.oneOf.0","typeLabel":"object"},{"type":"null","description":"The department object.","properties":{"name":{"oneOf":[{"type":"string","description":"The name of the department associated with the individual."},{"type":"null","description":"The name of the department associated with the individual."}]}},"uniqueKey":"department.oneOf.1","typeLabel":"null"}],"uniqueKey":"department","typeLabel":"object | null"},"employment":{"oneOf":[{"type":"object","description":"The employment object.","properties":{"type":{"oneOf":[{"type":"string","description":"The main employment type of the individual.","enum":["employee","contractor",null],"uniqueKey":"employment.oneOf.0.type.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","description":"The main employment type of the individual.","enum":["employee","contractor",null],"uniqueKey":"employment.oneOf.0.type.oneOf.1","typeLabel":"null"}],"uniqueKey":"employment.oneOf.0.type","typeLabel":"enum\u003cstring> | null"},"subtype":{"oneOf":[{"type":"string","description":"The secondary employment type of the individual. Options: `full_time`, `part_time`, `intern`, `temp`, `seasonal` and `individual_contractor`.","enum":["full_time","intern","part_time","temp","seasonal","individual_contractor",null],"uniqueKey":"employment.oneOf.0.subtype.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","description":"The secondary employment type of the individual. Options: `full_time`, `part_time`, `intern`, `temp`, `seasonal` and `individual_contractor`.","enum":["full_time","intern","part_time","temp","seasonal","individual_contractor",null],"uniqueKey":"employment.oneOf.0.subtype.oneOf.1","typeLabel":"null"}],"uniqueKey":"employment.oneOf.0.subtype","typeLabel":"enum\u003cstring> | null"}},"uniqueKey":"employment.oneOf.0","typeLabel":"object"},{"type":"null","description":"The employment object.","properties":{"type":{"oneOf":[{"type":"string","description":"The main employment type of the individual.","enum":["employee","contractor",null]},{"type":"null","description":"The main employment type of the individual.","enum":["employee","contractor",null]}]},"subtype":{"oneOf":[{"type":"string","description":"The secondary employment type of the individual. Options: `full_time`, `part_time`, `intern`, `temp`, `seasonal` and `individual_contractor`.","enum":["full_time","intern","part_time","temp","seasonal","individual_contractor",null]},{"type":"null","description":"The secondary employment type of the individual. Options: `full_time`, `part_time`, `intern`, `temp`, `seasonal` and `individual_contractor`.","enum":["full_time","intern","part_time","temp","seasonal","individual_contractor",null]}]}},"uniqueKey":"employment.oneOf.1","typeLabel":"null"}],"uniqueKey":"employment","typeLabel":"object | null"},"start_date":{"oneOf":[{"type":"string","title":"Date","uniqueKey":"start_date.oneOf.0","typeLabel":"string"},{"type":"null","title":"Date","uniqueKey":"start_date.oneOf.1","typeLabel":"null"}],"uniqueKey":"start_date","typeLabel":"string | null"},"end_date":{"oneOf":[{"type":"string","title":"Date","uniqueKey":"end_date.oneOf.0","typeLabel":"string"},{"type":"null","title":"Date","uniqueKey":"end_date.oneOf.1","typeLabel":"null"}],"uniqueKey":"end_date","typeLabel":"string | null"},"latest_rehire_date":{"oneOf":[{"type":"string","title":"Date","uniqueKey":"latest_rehire_date.oneOf.0","typeLabel":"string"},{"type":"null","title":"Date","uniqueKey":"latest_rehire_date.oneOf.1","typeLabel":"null"}],"uniqueKey":"latest_rehire_date","typeLabel":"string | null"},"is_active":{"oneOf":[{"type":"boolean","description":"`true` if the individual an an active employee or contractor at the company.","uniqueKey":"is_active.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"`true` if the individual an an active employee or contractor at the company.","uniqueKey":"is_active.oneOf.1","typeLabel":"null"}],"uniqueKey":"is_active","typeLabel":"boolean | null"},"employment_status":{"oneOf":[{"type":"string","description":"The detailed employment status of the individual.","enum":["active","deceased","leave","onboarding","prehire","retired","terminated",null],"uniqueKey":"employment_status.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","description":"The detailed employment status of the individual.","enum":["active","deceased","leave","onboarding","prehire","retired","terminated",null],"uniqueKey":"employment_status.oneOf.1","typeLabel":"null"}],"uniqueKey":"employment_status","typeLabel":"enum\u003cstring> | null"},"flsa_status":{"oneOf":[{"type":"string","description":"The FLSA status of the individual. Available options: `exempt`, `non_exempt`, `unknown`.","enum":["exempt","non_exempt","unknown",null],"uniqueKey":"flsa_status.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","description":"The FLSA status of the individual. Available options: `exempt`, `non_exempt`, `unknown`.","enum":["exempt","non_exempt","unknown",null],"uniqueKey":"flsa_status.oneOf.1","typeLabel":"null"}],"uniqueKey":"flsa_status","typeLabel":"enum\u003cstring> | null"},"class_code":{"oneOf":[{"type":"string","description":"Worker's compensation classification code for this employee","uniqueKey":"class_code.oneOf.0","typeLabel":"string"},{"type":"null","description":"Worker's compensation classification code for this employee","uniqueKey":"class_code.oneOf.1","typeLabel":"null"}],"uniqueKey":"class_code","typeLabel":"string | null"},"location":{"oneOf":[{"type":"object","properties":{"line1":{"oneOf":[{"type":"string","description":"Street address or PO box.","isRequired":true,"uniqueKey":"location.oneOf.0.line1.oneOf.0","typeLabel":"string"},{"type":"null","description":"Street address or PO box.","isRequired":true,"uniqueKey":"location.oneOf.0.line1.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"location.oneOf.0.line1","typeLabel":"string | null"},"line2":{"oneOf":[{"type":"string","description":"Apartment, suite, unit, or building.","isRequired":true,"uniqueKey":"location.oneOf.0.line2.oneOf.0","typeLabel":"string"},{"type":"null","description":"Apartment, suite, unit, or building.","isRequired":true,"uniqueKey":"location.oneOf.0.line2.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"location.oneOf.0.line2","typeLabel":"string | null"},"city":{"oneOf":[{"type":"string","description":"City, district, suburb, town, or village.","isRequired":true,"uniqueKey":"location.oneOf.0.city.oneOf.0","typeLabel":"string"},{"type":"null","description":"City, district, suburb, town, or village.","isRequired":true,"uniqueKey":"location.oneOf.0.city.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"location.oneOf.0.city","typeLabel":"string | null"},"state":{"oneOf":[{"type":"string","description":"The state code.","isRequired":true,"uniqueKey":"location.oneOf.0.state.oneOf.0","typeLabel":"string"},{"type":"null","description":"The state code.","isRequired":true,"uniqueKey":"location.oneOf.0.state.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"location.oneOf.0.state","typeLabel":"string | null"},"postal_code":{"oneOf":[{"type":"string","description":"The postal code or zip code.","isRequired":true,"uniqueKey":"location.oneOf.0.postal_code.oneOf.0","typeLabel":"string"},{"type":"null","description":"The postal code or zip code.","isRequired":true,"uniqueKey":"location.oneOf.0.postal_code.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"location.oneOf.0.postal_code","typeLabel":"string | null"},"country":{"oneOf":[{"type":"string","description":"The 2-letter ISO 3166 country code.","isRequired":true,"uniqueKey":"location.oneOf.0.country.oneOf.0","typeLabel":"string"},{"type":"null","description":"The 2-letter ISO 3166 country code.","isRequired":true,"uniqueKey":"location.oneOf.0.country.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"location.oneOf.0.country","typeLabel":"string | null"},"name":{"oneOf":[{"type":"string","uniqueKey":"location.oneOf.0.name.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"location.oneOf.0.name.oneOf.1","typeLabel":"null"}],"uniqueKey":"location.oneOf.0.name","typeLabel":"string | null"},"source_id":{"oneOf":[{"type":"string","uniqueKey":"location.oneOf.0.source_id.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"location.oneOf.0.source_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"location.oneOf.0.source_id","typeLabel":"string | null"}},"required":["line1","line2","city","state","postal_code","country"],"description":"","title":"Location","x-tags":["Models"],"uniqueKey":"location.oneOf.0","typeLabel":"Location · object"},{"type":"null","properties":{"line1":{"oneOf":[{"type":"string","description":"Street address or PO box."},{"type":"null","description":"Street address or PO box."}]},"line2":{"oneOf":[{"type":"string","description":"Apartment, suite, unit, or building."},{"type":"null","description":"Apartment, suite, unit, or building."}]},"city":{"oneOf":[{"type":"string","description":"City, district, suburb, town, or village."},{"type":"null","description":"City, district, suburb, town, or village."}]},"state":{"oneOf":[{"type":"string","description":"The state code."},{"type":"null","description":"The state code."}]},"postal_code":{"oneOf":[{"type":"string","description":"The postal code or zip code."},{"type":"null","description":"The postal code or zip code."}]},"country":{"oneOf":[{"type":"string","description":"The 2-letter ISO 3166 country code."},{"type":"null","description":"The 2-letter ISO 3166 country code."}]},"name":{"oneOf":[{"type":"string"},{"type":"null"}]},"source_id":{"oneOf":[{"type":"string"},{"type":"null"}]}},"required":["line1","line2","city","state","postal_code","country"],"description":"","title":"Location","x-tags":["Models"],"uniqueKey":"location.oneOf.1","typeLabel":"null"}],"uniqueKey":"location","typeLabel":"Location · object | null"},"income":{"oneOf":[{"type":"object","properties":{"unit":{"oneOf":[{"type":"string","enum":["yearly","quarterly","monthly","semi_monthly","bi_weekly","weekly","daily","hourly","fixed",null],"description":"The income unit of payment. Options: `yearly`, `quarterly`, `monthly`, `semi_monthly`, `bi_weekly`, `weekly`, `daily`, `hourly`, and `fixed`.","isRequired":true,"uniqueKey":"income.oneOf.0.unit.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["yearly","quarterly","monthly","semi_monthly","bi_weekly","weekly","daily","hourly","fixed",null],"description":"The income unit of payment. Options: `yearly`, `quarterly`, `monthly`, `semi_monthly`, `bi_weekly`, `weekly`, `daily`, `hourly`, and `fixed`.","isRequired":true,"uniqueKey":"income.oneOf.0.unit.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"income.oneOf.0.unit","typeLabel":"enum\u003cstring> | null"},"amount":{"oneOf":[{"type":"integer","description":"The income amount in cents.","isRequired":true,"uniqueKey":"income.oneOf.0.amount.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The income amount in cents.","isRequired":true,"uniqueKey":"income.oneOf.0.amount.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"income.oneOf.0.amount","typeLabel":"integer | null"},"currency":{"oneOf":[{"type":"string","description":"The currency code.","isRequired":true,"uniqueKey":"income.oneOf.0.currency.oneOf.0","typeLabel":"string"},{"type":"null","description":"The currency code.","isRequired":true,"uniqueKey":"income.oneOf.0.currency.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"income.oneOf.0.currency","typeLabel":"string | null"},"effective_date":{"oneOf":[{"type":"string","format":"date","description":"The date the income amount went into effect.","isRequired":true,"uniqueKey":"income.oneOf.0.effective_date.oneOf.0","typeLabel":"string\u003cdate>"},{"type":"null","format":"date","description":"The date the income amount went into effect.","isRequired":true,"uniqueKey":"income.oneOf.0.effective_date.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"income.oneOf.0.effective_date","typeLabel":"string\u003cdate> | null"}},"required":["unit","amount","currency","effective_date"],"description":"The employee's income as reported by the provider. This may not always be annualized income, but may be in units of bi-weekly, semi-monthly, daily, etc, depending on what information the provider returns.","title":"Income","x-tags":["Models"],"uniqueKey":"income.oneOf.0","typeLabel":"Income · object"},{"type":"null","properties":{"unit":{"oneOf":[{"type":"string","enum":["yearly","quarterly","monthly","semi_monthly","bi_weekly","weekly","daily","hourly","fixed",null],"description":"The income unit of payment. Options: `yearly`, `quarterly`, `monthly`, `semi_monthly`, `bi_weekly`, `weekly`, `daily`, `hourly`, and `fixed`."},{"type":"null","enum":["yearly","quarterly","monthly","semi_monthly","bi_weekly","weekly","daily","hourly","fixed",null],"description":"The income unit of payment. Options: `yearly`, `quarterly`, `monthly`, `semi_monthly`, `bi_weekly`, `weekly`, `daily`, `hourly`, and `fixed`."}]},"amount":{"oneOf":[{"type":"integer","description":"The income amount in cents."},{"type":"null","description":"The income amount in cents."}]},"currency":{"oneOf":[{"type":"string","description":"The currency code."},{"type":"null","description":"The currency code."}]},"effective_date":{"oneOf":[{"type":"string","format":"date","description":"The date the income amount went into effect."},{"type":"null","format":"date","description":"The date the income amount went into effect."}]}},"required":["unit","amount","currency","effective_date"],"description":"The employee's income as reported by the provider. This may not always be annualized income, but may be in units of bi-weekly, semi-monthly, daily, etc, depending on what information the provider returns.","title":"Income","x-tags":["Models"],"uniqueKey":"income.oneOf.1","typeLabel":"null"}],"uniqueKey":"income","typeLabel":"Income · object | null"},"income_history":{"oneOf":[{"type":"array","description":"The array of income history.","items":{"oneOf":[{"type":"object","properties":{"unit":{"oneOf":[{"type":"string","enum":["yearly","quarterly","monthly","semi_monthly","bi_weekly","weekly","daily","hourly","fixed",null],"description":"The income unit of payment. Options: `yearly`, `quarterly`, `monthly`, `semi_monthly`, `bi_weekly`, `weekly`, `daily`, `hourly`, and `fixed`.","isRequired":true,"uniqueKey":"income_history.oneOf.0.items.[INDEX].oneOf.0.unit.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["yearly","quarterly","monthly","semi_monthly","bi_weekly","weekly","daily","hourly","fixed",null],"description":"The income unit of payment. Options: `yearly`, `quarterly`, `monthly`, `semi_monthly`, `bi_weekly`, `weekly`, `daily`, `hourly`, and `fixed`.","isRequired":true,"uniqueKey":"income_history.oneOf.0.items.[INDEX].oneOf.0.unit.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"income_history.oneOf.0.items.[INDEX].oneOf.0.unit","typeLabel":"enum\u003cstring> | null"},"amount":{"oneOf":[{"type":"integer","description":"The income amount in cents.","isRequired":true,"uniqueKey":"income_history.oneOf.0.items.[INDEX].oneOf.0.amount.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The income amount in cents.","isRequired":true,"uniqueKey":"income_history.oneOf.0.items.[INDEX].oneOf.0.amount.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"income_history.oneOf.0.items.[INDEX].oneOf.0.amount","typeLabel":"integer | null"},"currency":{"oneOf":[{"type":"string","description":"The currency code.","isRequired":true,"uniqueKey":"income_history.oneOf.0.items.[INDEX].oneOf.0.currency.oneOf.0","typeLabel":"string"},{"type":"null","description":"The currency code.","isRequired":true,"uniqueKey":"income_history.oneOf.0.items.[INDEX].oneOf.0.currency.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"income_history.oneOf.0.items.[INDEX].oneOf.0.currency","typeLabel":"string | null"},"effective_date":{"oneOf":[{"type":"string","format":"date","description":"The date the income amount went into effect.","isRequired":true,"uniqueKey":"income_history.oneOf.0.items.[INDEX].oneOf.0.effective_date.oneOf.0","typeLabel":"string\u003cdate>"},{"type":"null","format":"date","description":"The date the income amount went into effect.","isRequired":true,"uniqueKey":"income_history.oneOf.0.items.[INDEX].oneOf.0.effective_date.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"income_history.oneOf.0.items.[INDEX].oneOf.0.effective_date","typeLabel":"string\u003cdate> | null"}},"required":["unit","amount","currency","effective_date"],"description":"The employee's income as reported by the provider. This may not always be annualized income, but may be in units of bi-weekly, semi-monthly, daily, etc, depending on what information the provider returns.","title":"Income","x-tags":["Models"],"uniqueKey":"income_history.oneOf.0.items.[INDEX].oneOf.0","typeLabel":"Income · object"},{"type":"null","properties":{"unit":{"oneOf":[{"type":"string","enum":["yearly","quarterly","monthly","semi_monthly","bi_weekly","weekly","daily","hourly","fixed",null],"description":"The income unit of payment. Options: `yearly`, `quarterly`, `monthly`, `semi_monthly`, `bi_weekly`, `weekly`, `daily`, `hourly`, and `fixed`."},{"type":"null","enum":["yearly","quarterly","monthly","semi_monthly","bi_weekly","weekly","daily","hourly","fixed",null],"description":"The income unit of payment. Options: `yearly`, `quarterly`, `monthly`, `semi_monthly`, `bi_weekly`, `weekly`, `daily`, `hourly`, and `fixed`."}]},"amount":{"oneOf":[{"type":"integer","description":"The income amount in cents."},{"type":"null","description":"The income amount in cents."}]},"currency":{"oneOf":[{"type":"string","description":"The currency code."},{"type":"null","description":"The currency code."}]},"effective_date":{"oneOf":[{"type":"string","format":"date","description":"The date the income amount went into effect."},{"type":"null","format":"date","description":"The date the income amount went into effect."}]}},"required":["unit","amount","currency","effective_date"],"description":"The employee's income as reported by the provider. This may not always be annualized income, but may be in units of bi-weekly, semi-monthly, daily, etc, depending on what information the provider returns.","title":"Income","x-tags":["Models"],"uniqueKey":"income_history.oneOf.0.items.[INDEX].oneOf.1","typeLabel":"null"}],"uniqueKey":"income_history.oneOf.0.items.[INDEX]","typeLabel":"Income · object | null"},"uniqueKey":"income_history.oneOf.0","typeLabel":"(Income · object | null)[]"},{"type":"null","description":"The array of income history.","items":{"oneOf":[{"type":"object","properties":{"unit":{"oneOf":[{"type":"string","enum":["yearly","quarterly","monthly","semi_monthly","bi_weekly","weekly","daily","hourly","fixed",null],"description":"The income unit of payment. Options: `yearly`, `quarterly`, `monthly`, `semi_monthly`, `bi_weekly`, `weekly`, `daily`, `hourly`, and `fixed`."},{"type":"null","enum":["yearly","quarterly","monthly","semi_monthly","bi_weekly","weekly","daily","hourly","fixed",null],"description":"The income unit of payment. Options: `yearly`, `quarterly`, `monthly`, `semi_monthly`, `bi_weekly`, `weekly`, `daily`, `hourly`, and `fixed`."}]},"amount":{"oneOf":[{"type":"integer","description":"The income amount in cents."},{"type":"null","description":"The income amount in cents."}]},"currency":{"oneOf":[{"type":"string","description":"The currency code."},{"type":"null","description":"The currency code."}]},"effective_date":{"oneOf":[{"type":"string","format":"date","description":"The date the income amount went into effect."},{"type":"null","format":"date","description":"The date the income amount went into effect."}]}},"required":["unit","amount","currency","effective_date"],"description":"The employee's income as reported by the provider. This may not always be annualized income, but may be in units of bi-weekly, semi-monthly, daily, etc, depending on what information the provider returns.","title":"Income","x-tags":["Models"]},{"type":"null","properties":{"unit":{"oneOf":[{"type":"string","enum":["yearly","quarterly","monthly","semi_monthly","bi_weekly","weekly","daily","hourly","fixed",null],"description":"The income unit of payment. Options: `yearly`, `quarterly`, `monthly`, `semi_monthly`, `bi_weekly`, `weekly`, `daily`, `hourly`, and `fixed`."},{"type":"null","enum":["yearly","quarterly","monthly","semi_monthly","bi_weekly","weekly","daily","hourly","fixed",null],"description":"The income unit of payment. Options: `yearly`, `quarterly`, `monthly`, `semi_monthly`, `bi_weekly`, `weekly`, `daily`, `hourly`, and `fixed`."}]},"amount":{"oneOf":[{"type":"integer","description":"The income amount in cents."},{"type":"null","description":"The income amount in cents."}]},"currency":{"oneOf":[{"type":"string","description":"The currency code."},{"type":"null","description":"The currency code."}]},"effective_date":{"oneOf":[{"type":"string","format":"date","description":"The date the income amount went into effect."},{"type":"null","format":"date","description":"The date the income amount went into effect."}]}},"required":["unit","amount","currency","effective_date"],"description":"The employee's income as reported by the provider. This may not always be annualized income, but may be in units of bi-weekly, semi-monthly, daily, etc, depending on what information the provider returns.","title":"Income","x-tags":["Models"]}]},"uniqueKey":"income_history.oneOf.1","typeLabel":"null"}],"uniqueKey":"income_history","typeLabel":"(Income · object | null)[] | null"},"custom_fields":{"oneOf":[{"type":"array","description":"Custom fields for the individual. These are fields which are defined by the employer in the system. Custom fields are not currently supported for assisted connections.","items":{"type":"object","properties":{"name":{"oneOf":[{"type":"string","uniqueKey":"custom_fields.oneOf.0.items.[INDEX].name.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"custom_fields.oneOf.0.items.[INDEX].name.oneOf.1","typeLabel":"null"}],"uniqueKey":"custom_fields.oneOf.0.items.[INDEX].name","typeLabel":"string | null"},"value":{"oneOf":[{"type":["string","array","object","number","boolean","null"],"items":{"oneOf":[{}]},"uniqueKey":"custom_fields.oneOf.0.items.[INDEX].value.oneOf.0","typeLabel":"string"},{"type":"null","items":{"oneOf":[{}]},"uniqueKey":"custom_fields.oneOf.0.items.[INDEX].value.oneOf.1","typeLabel":"null"}],"uniqueKey":"custom_fields.oneOf.0.items.[INDEX].value","typeLabel":"string | null"}},"uniqueKey":"custom_fields.oneOf.0.items.[INDEX]","typeLabel":"object"},"uniqueKey":"custom_fields.oneOf.0","typeLabel":"object[]"},{"type":"null","description":"Custom fields for the individual. These are fields which are defined by the employer in the system. Custom fields are not currently supported for assisted connections.","items":{"type":"object","properties":{"name":{"oneOf":[{"type":"string"},{"type":"null"}]},"value":{"oneOf":[{"type":["string","array","object","number","boolean","null"],"items":{"oneOf":[{}]}},{"type":"null","items":{"oneOf":[{}]}}]}}},"uniqueKey":"custom_fields.oneOf.1","typeLabel":"null"}],"uniqueKey":"custom_fields","typeLabel":"object[] | null"},"union_code":{"oneOf":[{"type":"string","description":"The code identifying the union the employee is a member of, as configured in the payroll system.","uniqueKey":"union_code.oneOf.0","typeLabel":"string"},{"type":"null","description":"The code identifying the union the employee is a member of, as configured in the payroll system.","uniqueKey":"union_code.oneOf.1","typeLabel":"null"}],"uniqueKey":"union_code","typeLabel":"string | null"},"union_local":{"oneOf":[{"type":"string","description":"The local chapter or local number within the employee's union.","uniqueKey":"union_local.oneOf.0","typeLabel":"string"},{"type":"null","description":"The local chapter or local number within the employee's union.","uniqueKey":"union_local.oneOf.1","typeLabel":"null"}],"uniqueKey":"union_local","typeLabel":"string | null"},"benefit_eligibility_class":{"oneOf":[{"type":"string","description":"The employer defined benefit eligibility class that groups an employee into a set of eligible benefit plans, as stored by the provider. Null when not configured.","uniqueKey":"benefit_eligibility_class.oneOf.0","typeLabel":"string"},{"type":"null","description":"The employer defined benefit eligibility class that groups an employee into a set of eligible benefit plans, as stored by the provider. Null when not configured.","uniqueKey":"benefit_eligibility_class.oneOf.1","typeLabel":"null"}],"uniqueKey":"benefit_eligibility_class","typeLabel":"string | null"},"highly_compensated_employee":{"oneOf":[{"type":"boolean","description":"IRS flag indicating whether the employee is classified as a Highly Compensated Employee for nondiscrimination testing purposes (ADP/ACP tests). US-only.","uniqueKey":"highly_compensated_employee.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"IRS flag indicating whether the employee is classified as a Highly Compensated Employee for nondiscrimination testing purposes (ADP/ACP tests). US-only.","uniqueKey":"highly_compensated_employee.oneOf.1","typeLabel":"null"}],"uniqueKey":"highly_compensated_employee","typeLabel":"boolean | null"},"key_employee":{"oneOf":[{"type":"boolean","description":"IRS flag indicating whether the employee is classified as a Key Employee for top-heavy testing purposes. US-only.","uniqueKey":"key_employee.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"IRS flag indicating whether the employee is classified as a Key Employee for top-heavy testing purposes. US-only.","uniqueKey":"key_employee.oneOf.1","typeLabel":"null"}],"uniqueKey":"key_employee","typeLabel":"boolean | null"},"source_id":{"oneOf":[{"type":"string","description":"The source system's unique employment identifier for this individual","uniqueKey":"source_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"The source system's unique employment identifier for this individual","uniqueKey":"source_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"source_id","typeLabel":"string | null"},"id":{"type":"string","description":"A stable Finch `id` (UUID v4) for an individual in the company.","format":"uuid","uniqueKey":"id","typeLabel":"string\u003cuuid>"}},"uniqueKey":"","typeLabel":"Employment · object"},"examples":{"Example":{"title":"Example","value":{"first_name":"\u003cstring>","middle_name":"\u003cstring>","last_name":"\u003cstring>","title":"\u003cstring>","manager":{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a"},"department":{"name":"\u003cstring>"},"employment":{"type":"employee","subtype":"full_time"},"start_date":"\u003cstring>","end_date":"\u003cstring>","latest_rehire_date":"\u003cstring>","is_active":true,"employment_status":"active","flsa_status":"exempt","class_code":"\u003cstring>","location":{"line1":"\u003cstring>","line2":"\u003cstring>","city":"\u003cstring>","state":"\u003cstring>","postal_code":"\u003cstring>","country":"\u003cstring>","name":"\u003cstring>","source_id":"\u003cstring>"},"income":{"unit":"yearly","amount":123,"currency":"\u003cstring>","effective_date":"2023-12-25"},"income_history":[{"unit":"yearly","amount":123,"currency":"\u003cstring>","effective_date":"2023-12-25"}],"custom_fields":[{"name":"\u003cstring>","value":"\u003cunknown>"}],"union_code":"\u003cstring>","union_local":"\u003cstring>","benefit_eligibility_class":"\u003cstring>","highly_compensated_employee":true,"key_employee":true,"source_id":"\u003cstring>","id":"3c90c3cc-0d44-4b50-8888-8dd25736052a"}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"fc528a6c-c52a-4056-a904-7808c513af1c":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Please use your Access Token","scopes":[],"schemeName":"bearerAuth"}}},"servers":{"e36ac43a-0e97-452c-aef7-f8b3c2e6e57e":{"url":"https://api.tryfinch.com","description":"Finch production environment"}},"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":"Update sandbox employment - Finch","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-04T16:38:52.305Z","originalFileLocation":"api-reference/sandbox/update-sandbox-employment.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=\"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=\"Update sandbox employment - Finch\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Finch\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://developer.tryfinch.com/api-reference/sandbox/update-sandbox-employment\">\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=Sandbox\u0026amp;title=Update+sandbox+employment\u0026amp;theme=833c5e58755e897492517fe7\u0026amp;signature=2cc1fa3d34c8a7d35bcff1ed34ea7e94b9128e30deaf739ad68b6280eb6a740b\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Update sandbox employment - Finch\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://finch.mintlify.app/_mintlify/api/og/v2?division=Sandbox\u0026amp;title=Update+sandbox+employment\u0026amp;theme=833c5e58755e897492517fe7\u0026amp;signature=2cc1fa3d34c8a7d35bcff1ed34ea7e94b9128e30deaf739ad68b6280eb6a740b\">\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/sandbox/update-sandbox-employment\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/sandbox/update-sandbox-employment.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/sandbox/update-sandbox-employment#webpage\",\"url\":\"https://developer.tryfinch.com/api-reference/sandbox/update-sandbox-employment\",\"name\":\"Update sandbox employment\",\"dateModified\":\"2026-11-04T16:38:52.305Z\",\"isPartOf\":{\"@id\":\"https://developer.tryfinch.com#website\"},\"breadcrumb\":{\"@id\":\"https://developer.tryfinch.com/api-reference/sandbox/update-sandbox-employment#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://developer.tryfinch.com/api-reference/sandbox/update-sandbox-employment#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Sandbox\",\"item\":\"https://developer.tryfinch.com/api-reference/sandbox/create-sandbox-connection\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Update sandbox employment\",\"item\":\"https://developer.tryfinch.com/api-reference/sandbox/update-sandbox-employment\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://developer.tryfinch.com/api-reference/sandbox/update-sandbox-employment#apireference\",\"headline\":\"Update sandbox employment\",\"name\":\"Update sandbox employment\",\"url\":\"https://developer.tryfinch.com/api-reference/sandbox/update-sandbox-employment\",\"mainEntityOfPage\":{\"@id\":\"https://developer.tryfinch.com/api-reference/sandbox/update-sandbox-employment#webpage\"},\"dateModified\":\"2026-11-04T16:38:52.305Z\",\"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","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","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","description":null,"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","description":null,"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":"Update sandbox employment - Finch","buildId":"dpl_9VVk5y1P8k1ATeJguVngy9Q3cmbD","deploymentId":"dpl_9VVk5y1P8k1ATeJguVngy9Q3cmbD","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-DX1Meug0.js","utils-B_OMIQVC.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-ChxhRPMa.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-CuKvD8Iv.js","snippetPresets-C5d7p2hp.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-CfHcE8m4.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-C1zZV314.js","shallow-CmQhqCJn.js","getApiPlaygroundDisplay-YRo9s1O7.js","CodeSnippet-RN1MTdfk.js","CodeSnippets-DKLPHxJA.js","Page-BAvA99GL.js","getPastedJson-bz0M41mU.js","icon-CsmhpPrv.js","MethodPill-CNGsVE77.js","DuplicateIcon-DilfU_Z2.js","createIcon-BdsYzQck.js","DynamicMarkdown-CbqEDjbV.js","SectionHeading-O6hXpFCN.js","axios-vUo_bRtp.js","Markdown-nKm-uidQ.js","clsx-ClVdStUn.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CIQkMg3R.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-ImrFS4Fy.js"]}