Needs the Pay field group’s Write switch. Filed through andteam’s own Change pay as the key’s requester: the package is checked against the tenant’s compensation rules and the date rule, and the approval chain, the self-approval guard and the audit trail apply. With the tenant’s pay change approval chain the answer is 202 and nothing is written to pay until the last step approves; with none, 201. reason is kept as the change’s note. A person in a protected group is not found unless the key’s Pay approval includes protected groups. andteam never sends a letter for an API change.
Authorization: Bearer atk_live_… (a sandbox's keys are atk_test_…). Created in the API keys section of the Integrations settings; the secret is shown once.
Optional: the andteam user id or work email of the person this is requested by (the hiring manager in your ATS, say), instead of the key's requester. They are checked for the same permission over this employee; if the check fails the request is refused (requester-not-allowed), never put back on the key's requester.
Required string length: 1 - 320
Response
validate_only=true: what would happen. Nothing was written.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"andteam","description":"The andteam API: your people, organisation, leave, pay and records, the changes other systems ask for, and signed webhooks.","colors":{"primary":"#00827B","light":"#30B3AB","dark":"#00827B"},"logo":{"light":"https://mintcdn.com/andteam/MVfTtzphnPhhxPa9/logo/andteam.svg?fit=max\u0026auto=format\u0026n=MVfTtzphnPhhxPa9\u0026q=85\u0026s=b11d93ffad90324a82a8c0d5d1a0c404","dark":"https://mintcdn.com/andteam/MVfTtzphnPhhxPa9/logo/andteam-dark.svg?fit=max\u0026auto=format\u0026n=MVfTtzphnPhhxPa9\u0026q=85\u0026s=b68c0b25cc90ff91d060372147b91013","href":"https://andteam.com"},"favicon":"https://mintcdn.com/andteam/MVfTtzphnPhhxPa9/logo/favicon.svg?fit=max\u0026auto=format\u0026n=MVfTtzphnPhhxPa9\u0026q=85\u0026s=5e85048315185eccf77ec4a1103b6ffc","api":{"openapi":"openapi.json","playground":{"display":"interactive"},"examples":{"defaults":"required","languages":["curl","python","javascript","go"],"prefill":true}},"background":{"color":{"light":"#F7F7F8","dark":"#0F1419"}},"navbar":{"primary":{"type":"button","label":"Get an API key","href":"https://andteam.com"}},"fonts":{"family":"Inter"},"icons":{"library":"lucide"},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"andteam","hasAudioNarration":false,"actualSubdomain":"andteam","customDomains":["docs.andteam.com"],"gitSource":{"type":"github","owner":"hellocrowd","repo":"-team-v3","deployBranch":"main","contentDirectory":"docs-site","isPrivate":true,"mountPath":"","label":"","_id":"6af16e2a7af691b16ede1e0e"},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6af46cafec28eb92a90ad5d3","clientVersion":"0.0.4111","searchFilterCounts":[{"language":"default","tag":"Guides","count":59},{"language":"default","tag":"API reference","count":50},{"language":"default","tag":"Problem types","count":31},{"language":"default","tag":"Webhooks","count":16},{"language":"default","tag":"Get started","count":7},{"language":"default","tag":"Leave","count":6},{"language":"default","tag":"Concepts","count":5},{"language":"default","tag":"Job history","count":5},{"language":"default","tag":"Pay","count":5},{"language":"default","tag":"Directory","count":4}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","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":"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":"editor-metadata","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},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/pay/file-an-increase-promotion-or-adjustment-of-pay","slug":"/api-reference/pay/file-an-increase-promotion-or-adjustment-of-pay","pageMetadata":{"title":"File an increase, promotion or adjustment of pay","description":"Needs the Pay field group's Write switch. Filed through andteam's own Change pay as the key's requester: the package is checked against the tenant's compensation rules and the date rule, and the approval chain, the self-approval guard and the audit trail apply. With the tenant's pay change approval chain the answer is 202 and nothing is written to pay until the last step approves; with none, 201. `reason` is kept as the change's note. A person in a protected group is not found unless the key's Pay approval includes protected groups. andteam never sends a letter for an API change.","deprecated":null,"version":null,"openapi":"/openapi.json post /employees/{id}/pay-changes","href":"/api-reference/pay/file-an-increase-promotion-or-adjustment-of-pay","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_components.p, {\n children: [\"Needs the Pay field group’s Write switch. Filed through andteam’s own Change pay as the key’s requester: the package is checked against the tenant’s compensation rules and the date rule, and the approval chain, the self-approval guard and the audit trail apply. With the tenant’s pay change approval chain the answer is 202 and nothing is written to pay until the last step approves; with none, 201. \", _jsx(_components.code, {\n children: \"reason\"\n }), \" is kept as the change’s note. A person in a protected group is not found unless the key’s Pay approval includes protected groups. andteam never sends a letter for an API change.\"]\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"File an increase, promotion or adjustment of pay","description":"Needs the Pay field group's Write switch. Filed through andteam's own Change pay as the key's requester: the package is checked against the tenant's compensation rules and the date rule, and the approval chain, the self-approval guard and the audit trail apply. With the tenant's pay change approval chain the answer is 202 and nothing is written to pay until the last step approves; with none, 201. `reason` is kept as the change's note. A person in a protected group is not found unless the key's Pay approval includes protected groups. andteam never sends a letter for an API change.","deprecated":null,"version":null,"openapi":"/openapi.json post /employees/{id}/pay-changes","href":"/api-reference/pay/file-an-increase-promotion-or-adjustment-of-pay","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"postEmployeesIdPayChanges","summary":"File an increase, promotion or adjustment of pay","tags":["Pay"],"description":"Needs the Pay field group's Write switch. Filed through andteam's own Change pay as the key's requester: the package is checked against the tenant's compensation rules and the date rule, and the approval chain, the self-approval guard and the audit trail apply. With the tenant's pay change approval chain the answer is 202 and nothing is written to pay until the last step approves; with none, 201. `reason` is kept as the change's note. A person in a protected group is not found unless the key's Pay approval includes protected groups. andteam never sends a letter for an API change.","parameters":["7a3c0055-f141-40b9-bdc0-54e8b4b4c37a","8201c2f8-9990-4d36-9b87-c520173c91c1","a03eebd2-3632-4fdb-93f0-f30f3f493cc1","edc9a956-9e1b-41e4-8ffc-ca4a8dbbcbb7","9979783a-cfe3-43ab-b9e2-33c3b3d0929e"],"requestBody":"669d55cb-43b7-41cc-a39a-5e665c978ab2","responses":{"200":"9f2c988f-44ed-42e8-ae8d-4bb5ed37d897","201":"60b5ed77-184b-4d36-85d8-1d05dde32028","202":"3d928cfb-bae3-4a5b-ae14-23d59f1d9628","401":"abe46c79-39c4-4f6d-96bb-186a124b0262","403":"2a356892-faca-48cc-80ae-4346edb4dd96","404":"f5b1ad34-dd1c-4c57-a36b-1e9c311b0abf","409":"b0b67f8a-4b11-4962-8dcb-0a1a5086df56","412":"e39311f2-90d3-4cd4-bd56-2cb42a719b7b","415":"fe1bac67-5fcf-4bd7-ba00-b03a1577699f","422":"ba2d2542-60da-4fc3-8cc6-086c5945b254","429":"ec587d77-9008-4cf1-bd14-ff933b5d2b70","500":"0bb16ac0-d554-4045-b29f-a386d5bcaf63"},"method":"post","type":"path","servers":["53173e53-73ef-4ae2-87b8-83a71010e39d"],"security":["8176f727-c71c-46ea-9693-90364dc198f4","0c7e1611-cf8c-415a-bf94-31afa5ec5942"],"path":"/employees/{id}/pay-changes","baseUrlOptions":["https://api.v3.andteam.com/v1"],"title":"File an increase, promotion or adjustment of pay","codeSamples":[],"requestExampleLanguages":["bash","python","javascript","go"],"requiredOnlyExamples":true,"requestExampleType":"generated","responseExampleType":"generated","prefillPlaygroundWithExample":true,"prefillPlaygroundExamples":[{"body.effectiveDate":"2023-12-25","body.components.items.0.componentId":"\u003cstring>","body.reason":"\u003cstring>","body.requestedBy":"\u003cstring>"}]},"dependencies":{"parameters":{"7a3c0055-f141-40b9-bdc0-54e8b4b4c37a":{"name":"id","in":"path","required":true,"description":"The employee id.","schema":{"type":"string","isRequired":true,"description":"The employee id.","uniqueKey":"","typeLabel":"string"}},"8201c2f8-9990-4d36-9b87-c520173c91c1":{"name":"company_id","in":"query","description":"One of the key's companies.","schema":{"type":"string","description":"One of the key's companies.","uniqueKey":"","typeLabel":"string"}},"a03eebd2-3632-4fdb-93f0-f30f3f493cc1":{"name":"Idempotency-Key","in":"header","required":true,"description":"Unique per request; reuse it only to retry the same request with the same body. Remembered 24 hours.","schema":{"type":"string","maxLength":255,"isRequired":true,"description":"Unique per request; reuse it only to retry the same request with the same body. Remembered 24 hours.","uniqueKey":"","typeLabel":"string"}},"edc9a956-9e1b-41e4-8ffc-ca4a8dbbcbb7":{"name":"If-Match","in":"header","description":"Optional: the employee's `ETag`, to refuse early when the record changed since you read it.","schema":{"type":"string","description":"Optional: the employee's `ETag`, to refuse early when the record changed since you read it.","uniqueKey":"","typeLabel":"string"}},"9979783a-cfe3-43ab-b9e2-33c3b3d0929e":{"name":"validate_only","in":"query","description":"`true`: answer 200 with what would happen (the approval steps and who they resolve to, the knock-ons), and write nothing.","schema":{"type":"boolean","description":"`true`: answer 200 with what would happen (the approval steps and who they resolve to, the knock-ons), and write nothing.","uniqueKey":"","typeLabel":"boolean"}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"kind":{"type":"string","enum":["increase","promotion","adjustment"],"description":"Increase, promotion or adjustment. A correction or a removal is made in andteam (422, code `not-supported`).","isRequired":true,"uniqueKey":"kind","typeLabel":"enum\u003cstring>"},"effectiveDate":{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$","description":"The day the new pay takes effect, after their latest pay change.","isRequired":true,"uniqueKey":"effectiveDate","typeLabel":"string\u003cdate>"},"components":{"minItems":1,"maxItems":200,"type":"array","items":{"type":"object","properties":{"componentId":{"type":"string","minLength":1,"maxLength":128,"description":"A component of the tenant's compensation catalogue.","isRequired":true,"uniqueKey":"components.items.[INDEX].componentId","typeLabel":"string"},"values":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"oneOf":[{}],"uniqueKey":"components.items.[INDEX].values.additionalProperties","typeLabel":"any"},"description":"The component's values, as its catalogue entry defines them (for example `amount` and `frequency`).","isRequired":true,"uniqueKey":"components.items.[INDEX].values","typeLabel":"object"}},"required":["componentId","values"],"additionalProperties":false,"uniqueKey":"components.items.[INDEX]","typeLabel":"object"},"description":"The whole package from that date, as the tenant's compensation catalogue defines it.","isRequired":true,"uniqueKey":"components","typeLabel":"object[]"},"reason":{"description":"Why, in words. Kept as the change's note.","type":"string","maxLength":500,"uniqueKey":"reason","typeLabel":"string"},"requestedBy":{"type":"string","minLength":1,"maxLength":320,"description":"Optional: the andteam user id or work email of the person this is requested by (the hiring manager in your ATS, say), instead of the key's requester. They are checked for the same permission over this employee; if the check fails the request is refused (requester-not-allowed), never put back on the key's requester.","uniqueKey":"requestedBy","typeLabel":"string"}},"required":["kind","effectiveDate","components"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"effectiveDate":"2023-12-25","components":[{"componentId":"\u003cstring>","values":{}}],"reason":"\u003cstring>","requestedBy":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"9f2c988f-44ed-42e8-ae8d-4bb5ed37d897":{"description":"`validate_only=true`: what would happen. Nothing was written.","headers":{"RateLimit-Limit":{"description":"Requests a minute allowed for the key.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the tightest window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until that window resets.","schema":{"type":"integer"}},"Deprecation":{"description":"Present once this version is deprecated (RFC 9745).","schema":{"type":"string"}},"Sunset":{"description":"Present once this version has a shutdown date (RFC 8594).","schema":{"type":"string"}},"Idempotent-Replayed":{"description":"`true` when this is the stored answer to an earlier request with the same `Idempotency-Key`.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"wouldBe":{"type":"object","properties":{"status":{"type":"string","enum":["awaiting_approval","applied","scheduled"],"isRequired":true,"uniqueKey":"wouldBe.status","typeLabel":"enum\u003cstring>"}},"required":["status"],"additionalProperties":false,"isRequired":true,"uniqueKey":"wouldBe","typeLabel":"object"},"steps":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","isRequired":true,"uniqueKey":"steps.items.[INDEX].id","typeLabel":"string"},"label":{"type":"string","isRequired":true,"uniqueKey":"steps.items.[INDEX].label","typeLabel":"string"},"approvers":{"type":"array","items":{"type":"string","uniqueKey":"steps.items.[INDEX].approvers.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"steps.items.[INDEX].approvers","typeLabel":"string[]"},"status":{"type":"string","enum":["waiting","current","approved","declined"],"isRequired":true,"uniqueKey":"steps.items.[INDEX].status","typeLabel":"enum\u003cstring>"}},"required":["id","label","approvers","status"],"additionalProperties":false,"uniqueKey":"steps.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"steps","typeLabel":"object[]"},"changedComponentIds":{"type":"array","items":{"type":"string","uniqueKey":"changedComponentIds.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"changedComponentIds","typeLabel":"string[]"}},"required":["wouldBe","steps","changedComponentIds"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"wouldBe":{"status":"awaiting_approval"},"steps":[{"id":"\u003cstring>","label":"\u003cstring>","approvers":["\u003cstring>"],"status":"waiting"}],"changedComponentIds":["\u003cstring>"]}}},"exampleType":"generated"}},"exampleType":"generated"},"60b5ed77-184b-4d36-85d8-1d05dde32028":{"description":"No approval chain: written at once, `applied` (its date has come) or `scheduled`.","headers":{"RateLimit-Limit":{"description":"Requests a minute allowed for the key.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the tightest window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until that window resets.","schema":{"type":"integer"}},"Deprecation":{"description":"Present once this version is deprecated (RFC 9745).","schema":{"type":"string"}},"Sunset":{"description":"Present once this version has a shutdown date (RFC 8594).","schema":{"type":"string"}},"Idempotent-Replayed":{"description":"`true` when this is the stored answer to an earlier request with the same `Idempotency-Key`.","schema":{"type":"string"}},"Location":{"description":"The created resource.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","isRequired":true,"uniqueKey":"id","typeLabel":"string"},"employeeId":{"type":"string","isRequired":true,"uniqueKey":"employeeId","typeLabel":"string"},"companyId":{"type":"string","isRequired":true,"uniqueKey":"companyId","typeLabel":"string"},"kind":{"type":"string","enum":["increase","promotion","adjustment"],"isRequired":true,"uniqueKey":"kind","typeLabel":"enum\u003cstring>"},"effectiveDate":{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$","isRequired":true,"uniqueKey":"effectiveDate","typeLabel":"string\u003cdate>"},"status":{"type":"string","enum":["awaiting_approval","approved","declined","withdrawn","applied","scheduled"],"isRequired":true,"uniqueKey":"status","typeLabel":"enum\u003cstring>"},"changedComponentIds":{"type":"array","items":{"type":"string","uniqueKey":"changedComponentIds.items.[INDEX]","typeLabel":"string"},"description":"The components it changes. Never an amount.","isRequired":true,"uniqueKey":"changedComponentIds","typeLabel":"string[]"},"steps":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","isRequired":true,"uniqueKey":"steps.items.[INDEX].id","typeLabel":"string"},"label":{"type":"string","isRequired":true,"uniqueKey":"steps.items.[INDEX].label","typeLabel":"string"},"approvers":{"type":"array","items":{"type":"string","uniqueKey":"steps.items.[INDEX].approvers.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"steps.items.[INDEX].approvers","typeLabel":"string[]"},"status":{"type":"string","enum":["waiting","current","approved","declined"],"isRequired":true,"uniqueKey":"steps.items.[INDEX].status","typeLabel":"enum\u003cstring>"}},"required":["id","label","approvers","status"],"additionalProperties":false,"uniqueKey":"steps.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"steps","typeLabel":"object[]"},"requestedVia":{"oneOf":[{"type":"object","description":"The API key that filed it; null when it was made in andteam.","required":["keyId"],"properties":{"keyId":{"type":"string","isRequired":true,"uniqueKey":"requestedVia.oneOf.0.keyId","typeLabel":"string"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"requestedVia.oneOf.0","typeLabel":"object"},{"type":"null","description":"The API key that filed it; null when it was made in andteam.","isRequired":true,"uniqueKey":"requestedVia.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"requestedVia","typeLabel":"object | null"},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$","isRequired":true,"uniqueKey":"createdAt","typeLabel":"string\u003cdate-time>"},"decidedAt":{"oneOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$","isRequired":true,"uniqueKey":"decidedAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","isRequired":true,"uniqueKey":"decidedAt.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"decidedAt","typeLabel":"string\u003cdate-time> | null"}},"required":["id","employeeId","companyId","kind","effectiveDate","status","changedComponentIds","steps","requestedVia","createdAt","decidedAt"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"id":"\u003cstring>","employeeId":"\u003cstring>","companyId":"\u003cstring>","kind":"increase","effectiveDate":"2023-12-25","status":"awaiting_approval","changedComponentIds":["\u003cstring>"],"steps":[{"id":"\u003cstring>","label":"\u003cstring>","approvers":["\u003cstring>"],"status":"waiting"}],"requestedVia":{"keyId":"\u003cstring>"},"createdAt":"2023-11-07T05:31:56Z","decidedAt":"2023-11-07T05:31:56Z"}}},"exampleType":"generated"}},"exampleType":"generated"},"3d928cfb-bae3-4a5b-ae14-23d59f1d9628":{"description":"Filed for approval: `awaiting_approval`, with the steps. Nothing is written to pay until the last step approves.","headers":{"RateLimit-Limit":{"description":"Requests a minute allowed for the key.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the tightest window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until that window resets.","schema":{"type":"integer"}},"Deprecation":{"description":"Present once this version is deprecated (RFC 9745).","schema":{"type":"string"}},"Sunset":{"description":"Present once this version has a shutdown date (RFC 8594).","schema":{"type":"string"}},"Idempotent-Replayed":{"description":"`true` when this is the stored answer to an earlier request with the same `Idempotency-Key`.","schema":{"type":"string"}},"Location":{"description":"The created resource.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","isRequired":true,"uniqueKey":"id","typeLabel":"string"},"employeeId":{"type":"string","isRequired":true,"uniqueKey":"employeeId","typeLabel":"string"},"companyId":{"type":"string","isRequired":true,"uniqueKey":"companyId","typeLabel":"string"},"kind":{"type":"string","enum":["increase","promotion","adjustment"],"isRequired":true,"uniqueKey":"kind","typeLabel":"enum\u003cstring>"},"effectiveDate":{"type":"string","format":"date","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$","isRequired":true,"uniqueKey":"effectiveDate","typeLabel":"string\u003cdate>"},"status":{"type":"string","enum":["awaiting_approval","approved","declined","withdrawn","applied","scheduled"],"isRequired":true,"uniqueKey":"status","typeLabel":"enum\u003cstring>"},"changedComponentIds":{"type":"array","items":{"type":"string","uniqueKey":"changedComponentIds.items.[INDEX]","typeLabel":"string"},"description":"The components it changes. Never an amount.","isRequired":true,"uniqueKey":"changedComponentIds","typeLabel":"string[]"},"steps":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","isRequired":true,"uniqueKey":"steps.items.[INDEX].id","typeLabel":"string"},"label":{"type":"string","isRequired":true,"uniqueKey":"steps.items.[INDEX].label","typeLabel":"string"},"approvers":{"type":"array","items":{"type":"string","uniqueKey":"steps.items.[INDEX].approvers.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"steps.items.[INDEX].approvers","typeLabel":"string[]"},"status":{"type":"string","enum":["waiting","current","approved","declined"],"isRequired":true,"uniqueKey":"steps.items.[INDEX].status","typeLabel":"enum\u003cstring>"}},"required":["id","label","approvers","status"],"additionalProperties":false,"uniqueKey":"steps.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"steps","typeLabel":"object[]"},"requestedVia":{"oneOf":[{"type":"object","description":"The API key that filed it; null when it was made in andteam.","required":["keyId"],"properties":{"keyId":{"type":"string","isRequired":true,"uniqueKey":"requestedVia.oneOf.0.keyId","typeLabel":"string"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"requestedVia.oneOf.0","typeLabel":"object"},{"type":"null","description":"The API key that filed it; null when it was made in andteam.","isRequired":true,"uniqueKey":"requestedVia.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"requestedVia","typeLabel":"object | null"},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$","isRequired":true,"uniqueKey":"createdAt","typeLabel":"string\u003cdate-time>"},"decidedAt":{"oneOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$","isRequired":true,"uniqueKey":"decidedAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","isRequired":true,"uniqueKey":"decidedAt.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"decidedAt","typeLabel":"string\u003cdate-time> | null"}},"required":["id","employeeId","companyId","kind","effectiveDate","status","changedComponentIds","steps","requestedVia","createdAt","decidedAt"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"id":"\u003cstring>","employeeId":"\u003cstring>","companyId":"\u003cstring>","kind":"increase","effectiveDate":"2023-12-25","status":"awaiting_approval","changedComponentIds":["\u003cstring>"],"steps":[{"id":"\u003cstring>","label":"\u003cstring>","approvers":["\u003cstring>"],"status":"waiting"}],"requestedVia":{"keyId":"\u003cstring>"},"createdAt":"2023-11-07T05:31:56Z","decidedAt":"2023-11-07T05:31:56Z"}}},"exampleType":"generated"}},"exampleType":"generated"},"abe46c79-39c4-4f6d-96bb-186a124b0262":{"description":"No valid key. Problem types: `missing-key`, `invalid-key`, `revoked-key`, `expired-key`, `rolled-key-expired`.","headers":{"WWW-Authenticate":{"description":"Bearer realm=\"andteam\"","schema":{"type":"string"}}},"content":{"application/problem+json":{"schema":{"type":"object","properties":{"type":{"type":"string","description":"A stable URL for the kind of problem: https://docs.andteam.com/api/problems/{slug}.","isRequired":true,"uniqueKey":"type","typeLabel":"string"},"title":{"type":"string","isRequired":true,"uniqueKey":"title","typeLabel":"string"},"status":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"isRequired":true,"uniqueKey":"status","typeLabel":"integer"},"detail":{"type":"string","uniqueKey":"detail","typeLabel":"string"},"instance":{"type":"string","uniqueKey":"instance","typeLabel":"string"},"errors":{"description":"validation-failed: every field that is wrong, at once.","type":"array","items":{"type":"object","properties":{"pointer":{"type":"string","description":"A JSON Pointer (RFC 6901) to the field in the request body, such as /candidate/personalEmail.","isRequired":true,"uniqueKey":"errors.items.[INDEX].pointer","typeLabel":"string"},"code":{"type":"string","description":"A stable code for the error, such as required, invalid, insufficient-balance.","isRequired":true,"uniqueKey":"errors.items.[INDEX].code","typeLabel":"string"},"detail":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].detail","typeLabel":"string"}},"required":["pointer","code","detail"],"additionalProperties":false,"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"uniqueKey":"errors","typeLabel":"object[]"},"fields":{"description":"field-locked: every field in the request the HRIS owns for this person.","type":"array","items":{"type":"string","uniqueKey":"fields.items.[INDEX]","typeLabel":"string"},"uniqueKey":"fields","typeLabel":"string[]"},"existingId":{"description":"pending-change-exists, duplicate-hire, possible-rehire: the id of the existing record.","type":"string","uniqueKey":"existingId","typeLabel":"string"},"step":{"description":"approval-chain-unresolvable: the step that resolves to nobody.","type":"string","uniqueKey":"step","typeLabel":"string"}},"required":["type","title","status"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"type":"\u003cstring>","title":"\u003cstring>","status":0,"detail":"\u003cstring>","instance":"\u003cstring>","errors":[{"pointer":"\u003cstring>","code":"\u003cstring>","detail":"\u003cstring>"}],"fields":["\u003cstring>"],"existingId":"\u003cstring>","step":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"2a356892-faca-48cc-80ae-4346edb4dd96":{"description":"Not allowed. Problem types: `pending-approval`, `ip-not-allowed`, `field-group-required`, `company-not-allowed`, `write-not-allowed`, `requester-not-allowed`, `test-key-not-allowed`.","headers":{},"content":{"application/problem+json":{"schema":{"type":"object","properties":{"type":{"type":"string","description":"A stable URL for the kind of problem: https://docs.andteam.com/api/problems/{slug}.","isRequired":true,"uniqueKey":"type","typeLabel":"string"},"title":{"type":"string","isRequired":true,"uniqueKey":"title","typeLabel":"string"},"status":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"isRequired":true,"uniqueKey":"status","typeLabel":"integer"},"detail":{"type":"string","uniqueKey":"detail","typeLabel":"string"},"instance":{"type":"string","uniqueKey":"instance","typeLabel":"string"},"errors":{"description":"validation-failed: every field that is wrong, at once.","type":"array","items":{"type":"object","properties":{"pointer":{"type":"string","description":"A JSON Pointer (RFC 6901) to the field in the request body, such as /candidate/personalEmail.","isRequired":true,"uniqueKey":"errors.items.[INDEX].pointer","typeLabel":"string"},"code":{"type":"string","description":"A stable code for the error, such as required, invalid, insufficient-balance.","isRequired":true,"uniqueKey":"errors.items.[INDEX].code","typeLabel":"string"},"detail":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].detail","typeLabel":"string"}},"required":["pointer","code","detail"],"additionalProperties":false,"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"uniqueKey":"errors","typeLabel":"object[]"},"fields":{"description":"field-locked: every field in the request the HRIS owns for this person.","type":"array","items":{"type":"string","uniqueKey":"fields.items.[INDEX]","typeLabel":"string"},"uniqueKey":"fields","typeLabel":"string[]"},"existingId":{"description":"pending-change-exists, duplicate-hire, possible-rehire: the id of the existing record.","type":"string","uniqueKey":"existingId","typeLabel":"string"},"step":{"description":"approval-chain-unresolvable: the step that resolves to nobody.","type":"string","uniqueKey":"step","typeLabel":"string"}},"required":["type","title","status"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"type":"\u003cstring>","title":"\u003cstring>","status":0,"detail":"\u003cstring>","instance":"\u003cstring>","errors":[{"pointer":"\u003cstring>","code":"\u003cstring>","detail":"\u003cstring>"}],"fields":["\u003cstring>"],"existingId":"\u003cstring>","step":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"f5b1ad34-dd1c-4c57-a36b-1e9c311b0abf":{"description":"Not found. Problem types: `not-found`.","headers":{},"content":{"application/problem+json":{"schema":{"type":"object","properties":{"type":{"type":"string","description":"A stable URL for the kind of problem: https://docs.andteam.com/api/problems/{slug}.","isRequired":true,"uniqueKey":"type","typeLabel":"string"},"title":{"type":"string","isRequired":true,"uniqueKey":"title","typeLabel":"string"},"status":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"isRequired":true,"uniqueKey":"status","typeLabel":"integer"},"detail":{"type":"string","uniqueKey":"detail","typeLabel":"string"},"instance":{"type":"string","uniqueKey":"instance","typeLabel":"string"},"errors":{"description":"validation-failed: every field that is wrong, at once.","type":"array","items":{"type":"object","properties":{"pointer":{"type":"string","description":"A JSON Pointer (RFC 6901) to the field in the request body, such as /candidate/personalEmail.","isRequired":true,"uniqueKey":"errors.items.[INDEX].pointer","typeLabel":"string"},"code":{"type":"string","description":"A stable code for the error, such as required, invalid, insufficient-balance.","isRequired":true,"uniqueKey":"errors.items.[INDEX].code","typeLabel":"string"},"detail":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].detail","typeLabel":"string"}},"required":["pointer","code","detail"],"additionalProperties":false,"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"uniqueKey":"errors","typeLabel":"object[]"},"fields":{"description":"field-locked: every field in the request the HRIS owns for this person.","type":"array","items":{"type":"string","uniqueKey":"fields.items.[INDEX]","typeLabel":"string"},"uniqueKey":"fields","typeLabel":"string[]"},"existingId":{"description":"pending-change-exists, duplicate-hire, possible-rehire: the id of the existing record.","type":"string","uniqueKey":"existingId","typeLabel":"string"},"step":{"description":"approval-chain-unresolvable: the step that resolves to nobody.","type":"string","uniqueKey":"step","typeLabel":"string"}},"required":["type","title","status"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"type":"\u003cstring>","title":"\u003cstring>","status":0,"detail":"\u003cstring>","instance":"\u003cstring>","errors":[{"pointer":"\u003cstring>","code":"\u003cstring>","detail":"\u003cstring>"}],"fields":["\u003cstring>"],"existingId":"\u003cstring>","step":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"b0b67f8a-4b11-4962-8dcb-0a1a5086df56":{"description":"Conflict. Problem types: `ambiguous-id`, `field-locked`, `approval-chain-unresolvable`, `pending-change-exists`, `duplicate-hire`, `possible-rehire`, `idempotency-in-progress`, `not-withdrawable`.","headers":{},"content":{"application/problem+json":{"schema":{"type":"object","properties":{"type":{"type":"string","description":"A stable URL for the kind of problem: https://docs.andteam.com/api/problems/{slug}.","isRequired":true,"uniqueKey":"type","typeLabel":"string"},"title":{"type":"string","isRequired":true,"uniqueKey":"title","typeLabel":"string"},"status":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"isRequired":true,"uniqueKey":"status","typeLabel":"integer"},"detail":{"type":"string","uniqueKey":"detail","typeLabel":"string"},"instance":{"type":"string","uniqueKey":"instance","typeLabel":"string"},"errors":{"description":"validation-failed: every field that is wrong, at once.","type":"array","items":{"type":"object","properties":{"pointer":{"type":"string","description":"A JSON Pointer (RFC 6901) to the field in the request body, such as /candidate/personalEmail.","isRequired":true,"uniqueKey":"errors.items.[INDEX].pointer","typeLabel":"string"},"code":{"type":"string","description":"A stable code for the error, such as required, invalid, insufficient-balance.","isRequired":true,"uniqueKey":"errors.items.[INDEX].code","typeLabel":"string"},"detail":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].detail","typeLabel":"string"}},"required":["pointer","code","detail"],"additionalProperties":false,"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"uniqueKey":"errors","typeLabel":"object[]"},"fields":{"description":"field-locked: every field in the request the HRIS owns for this person.","type":"array","items":{"type":"string","uniqueKey":"fields.items.[INDEX]","typeLabel":"string"},"uniqueKey":"fields","typeLabel":"string[]"},"existingId":{"description":"pending-change-exists, duplicate-hire, possible-rehire: the id of the existing record.","type":"string","uniqueKey":"existingId","typeLabel":"string"},"step":{"description":"approval-chain-unresolvable: the step that resolves to nobody.","type":"string","uniqueKey":"step","typeLabel":"string"}},"required":["type","title","status"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"type":"\u003cstring>","title":"\u003cstring>","status":0,"detail":"\u003cstring>","instance":"\u003cstring>","errors":[{"pointer":"\u003cstring>","code":"\u003cstring>","detail":"\u003cstring>"}],"fields":["\u003cstring>"],"existingId":"\u003cstring>","step":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"e39311f2-90d3-4cd4-bd56-2cb42a719b7b":{"description":"Precondition failed. Problem types: `precondition-failed`.","headers":{},"content":{"application/problem+json":{"schema":{"type":"object","properties":{"type":{"type":"string","description":"A stable URL for the kind of problem: https://docs.andteam.com/api/problems/{slug}.","isRequired":true,"uniqueKey":"type","typeLabel":"string"},"title":{"type":"string","isRequired":true,"uniqueKey":"title","typeLabel":"string"},"status":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"isRequired":true,"uniqueKey":"status","typeLabel":"integer"},"detail":{"type":"string","uniqueKey":"detail","typeLabel":"string"},"instance":{"type":"string","uniqueKey":"instance","typeLabel":"string"},"errors":{"description":"validation-failed: every field that is wrong, at once.","type":"array","items":{"type":"object","properties":{"pointer":{"type":"string","description":"A JSON Pointer (RFC 6901) to the field in the request body, such as /candidate/personalEmail.","isRequired":true,"uniqueKey":"errors.items.[INDEX].pointer","typeLabel":"string"},"code":{"type":"string","description":"A stable code for the error, such as required, invalid, insufficient-balance.","isRequired":true,"uniqueKey":"errors.items.[INDEX].code","typeLabel":"string"},"detail":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].detail","typeLabel":"string"}},"required":["pointer","code","detail"],"additionalProperties":false,"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"uniqueKey":"errors","typeLabel":"object[]"},"fields":{"description":"field-locked: every field in the request the HRIS owns for this person.","type":"array","items":{"type":"string","uniqueKey":"fields.items.[INDEX]","typeLabel":"string"},"uniqueKey":"fields","typeLabel":"string[]"},"existingId":{"description":"pending-change-exists, duplicate-hire, possible-rehire: the id of the existing record.","type":"string","uniqueKey":"existingId","typeLabel":"string"},"step":{"description":"approval-chain-unresolvable: the step that resolves to nobody.","type":"string","uniqueKey":"step","typeLabel":"string"}},"required":["type","title","status"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"type":"\u003cstring>","title":"\u003cstring>","status":0,"detail":"\u003cstring>","instance":"\u003cstring>","errors":[{"pointer":"\u003cstring>","code":"\u003cstring>","detail":"\u003cstring>"}],"fields":["\u003cstring>"],"existingId":"\u003cstring>","step":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"fe1bac67-5fcf-4bd7-ba00-b03a1577699f":{"description":"Unsupported media type. Problem types: `unsupported-media-type`.","headers":{},"content":{"application/problem+json":{"schema":{"type":"object","properties":{"type":{"type":"string","description":"A stable URL for the kind of problem: https://docs.andteam.com/api/problems/{slug}.","isRequired":true,"uniqueKey":"type","typeLabel":"string"},"title":{"type":"string","isRequired":true,"uniqueKey":"title","typeLabel":"string"},"status":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"isRequired":true,"uniqueKey":"status","typeLabel":"integer"},"detail":{"type":"string","uniqueKey":"detail","typeLabel":"string"},"instance":{"type":"string","uniqueKey":"instance","typeLabel":"string"},"errors":{"description":"validation-failed: every field that is wrong, at once.","type":"array","items":{"type":"object","properties":{"pointer":{"type":"string","description":"A JSON Pointer (RFC 6901) to the field in the request body, such as /candidate/personalEmail.","isRequired":true,"uniqueKey":"errors.items.[INDEX].pointer","typeLabel":"string"},"code":{"type":"string","description":"A stable code for the error, such as required, invalid, insufficient-balance.","isRequired":true,"uniqueKey":"errors.items.[INDEX].code","typeLabel":"string"},"detail":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].detail","typeLabel":"string"}},"required":["pointer","code","detail"],"additionalProperties":false,"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"uniqueKey":"errors","typeLabel":"object[]"},"fields":{"description":"field-locked: every field in the request the HRIS owns for this person.","type":"array","items":{"type":"string","uniqueKey":"fields.items.[INDEX]","typeLabel":"string"},"uniqueKey":"fields","typeLabel":"string[]"},"existingId":{"description":"pending-change-exists, duplicate-hire, possible-rehire: the id of the existing record.","type":"string","uniqueKey":"existingId","typeLabel":"string"},"step":{"description":"approval-chain-unresolvable: the step that resolves to nobody.","type":"string","uniqueKey":"step","typeLabel":"string"}},"required":["type","title","status"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"type":"\u003cstring>","title":"\u003cstring>","status":0,"detail":"\u003cstring>","instance":"\u003cstring>","errors":[{"pointer":"\u003cstring>","code":"\u003cstring>","detail":"\u003cstring>"}],"fields":["\u003cstring>"],"existingId":"\u003cstring>","step":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"ba2d2542-60da-4fc3-8cc6-086c5945b254":{"description":"Not valid. Problem types: `validation-failed`, `idempotency-key-reused`.","headers":{},"content":{"application/problem+json":{"schema":{"type":"object","properties":{"type":{"type":"string","description":"A stable URL for the kind of problem: https://docs.andteam.com/api/problems/{slug}.","isRequired":true,"uniqueKey":"type","typeLabel":"string"},"title":{"type":"string","isRequired":true,"uniqueKey":"title","typeLabel":"string"},"status":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"isRequired":true,"uniqueKey":"status","typeLabel":"integer"},"detail":{"type":"string","uniqueKey":"detail","typeLabel":"string"},"instance":{"type":"string","uniqueKey":"instance","typeLabel":"string"},"errors":{"description":"validation-failed: every field that is wrong, at once.","type":"array","items":{"type":"object","properties":{"pointer":{"type":"string","description":"A JSON Pointer (RFC 6901) to the field in the request body, such as /candidate/personalEmail.","isRequired":true,"uniqueKey":"errors.items.[INDEX].pointer","typeLabel":"string"},"code":{"type":"string","description":"A stable code for the error, such as required, invalid, insufficient-balance.","isRequired":true,"uniqueKey":"errors.items.[INDEX].code","typeLabel":"string"},"detail":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].detail","typeLabel":"string"}},"required":["pointer","code","detail"],"additionalProperties":false,"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"uniqueKey":"errors","typeLabel":"object[]"},"fields":{"description":"field-locked: every field in the request the HRIS owns for this person.","type":"array","items":{"type":"string","uniqueKey":"fields.items.[INDEX]","typeLabel":"string"},"uniqueKey":"fields","typeLabel":"string[]"},"existingId":{"description":"pending-change-exists, duplicate-hire, possible-rehire: the id of the existing record.","type":"string","uniqueKey":"existingId","typeLabel":"string"},"step":{"description":"approval-chain-unresolvable: the step that resolves to nobody.","type":"string","uniqueKey":"step","typeLabel":"string"}},"required":["type","title","status"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"type":"\u003cstring>","title":"\u003cstring>","status":0,"detail":"\u003cstring>","instance":"\u003cstring>","errors":[{"pointer":"\u003cstring>","code":"\u003cstring>","detail":"\u003cstring>"}],"fields":["\u003cstring>"],"existingId":"\u003cstring>","step":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"ec587d77-9008-4cf1-bd14-ff933b5d2b70":{"description":"Rate limited. Problem types: `rate-limited`.","headers":{"Retry-After":{"description":"Seconds to wait before the next request.","schema":{"type":"integer"}}},"content":{"application/problem+json":{"schema":{"type":"object","properties":{"type":{"type":"string","description":"A stable URL for the kind of problem: https://docs.andteam.com/api/problems/{slug}.","isRequired":true,"uniqueKey":"type","typeLabel":"string"},"title":{"type":"string","isRequired":true,"uniqueKey":"title","typeLabel":"string"},"status":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"isRequired":true,"uniqueKey":"status","typeLabel":"integer"},"detail":{"type":"string","uniqueKey":"detail","typeLabel":"string"},"instance":{"type":"string","uniqueKey":"instance","typeLabel":"string"},"errors":{"description":"validation-failed: every field that is wrong, at once.","type":"array","items":{"type":"object","properties":{"pointer":{"type":"string","description":"A JSON Pointer (RFC 6901) to the field in the request body, such as /candidate/personalEmail.","isRequired":true,"uniqueKey":"errors.items.[INDEX].pointer","typeLabel":"string"},"code":{"type":"string","description":"A stable code for the error, such as required, invalid, insufficient-balance.","isRequired":true,"uniqueKey":"errors.items.[INDEX].code","typeLabel":"string"},"detail":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].detail","typeLabel":"string"}},"required":["pointer","code","detail"],"additionalProperties":false,"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"uniqueKey":"errors","typeLabel":"object[]"},"fields":{"description":"field-locked: every field in the request the HRIS owns for this person.","type":"array","items":{"type":"string","uniqueKey":"fields.items.[INDEX]","typeLabel":"string"},"uniqueKey":"fields","typeLabel":"string[]"},"existingId":{"description":"pending-change-exists, duplicate-hire, possible-rehire: the id of the existing record.","type":"string","uniqueKey":"existingId","typeLabel":"string"},"step":{"description":"approval-chain-unresolvable: the step that resolves to nobody.","type":"string","uniqueKey":"step","typeLabel":"string"}},"required":["type","title","status"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"type":"\u003cstring>","title":"\u003cstring>","status":0,"detail":"\u003cstring>","instance":"\u003cstring>","errors":[{"pointer":"\u003cstring>","code":"\u003cstring>","detail":"\u003cstring>"}],"fields":["\u003cstring>"],"existingId":"\u003cstring>","step":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"0bb16ac0-d554-4045-b29f-a386d5bcaf63":{"description":"Server error. Problem types: `internal-error`.","headers":{},"content":{"application/problem+json":{"schema":{"type":"object","properties":{"type":{"type":"string","description":"A stable URL for the kind of problem: https://docs.andteam.com/api/problems/{slug}.","isRequired":true,"uniqueKey":"type","typeLabel":"string"},"title":{"type":"string","isRequired":true,"uniqueKey":"title","typeLabel":"string"},"status":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"isRequired":true,"uniqueKey":"status","typeLabel":"integer"},"detail":{"type":"string","uniqueKey":"detail","typeLabel":"string"},"instance":{"type":"string","uniqueKey":"instance","typeLabel":"string"},"errors":{"description":"validation-failed: every field that is wrong, at once.","type":"array","items":{"type":"object","properties":{"pointer":{"type":"string","description":"A JSON Pointer (RFC 6901) to the field in the request body, such as /candidate/personalEmail.","isRequired":true,"uniqueKey":"errors.items.[INDEX].pointer","typeLabel":"string"},"code":{"type":"string","description":"A stable code for the error, such as required, invalid, insufficient-balance.","isRequired":true,"uniqueKey":"errors.items.[INDEX].code","typeLabel":"string"},"detail":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].detail","typeLabel":"string"}},"required":["pointer","code","detail"],"additionalProperties":false,"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"uniqueKey":"errors","typeLabel":"object[]"},"fields":{"description":"field-locked: every field in the request the HRIS owns for this person.","type":"array","items":{"type":"string","uniqueKey":"fields.items.[INDEX]","typeLabel":"string"},"uniqueKey":"fields","typeLabel":"string[]"},"existingId":{"description":"pending-change-exists, duplicate-hire, possible-rehire: the id of the existing record.","type":"string","uniqueKey":"existingId","typeLabel":"string"},"step":{"description":"approval-chain-unresolvable: the step that resolves to nobody.","type":"string","uniqueKey":"step","typeLabel":"string"}},"required":["type","title","status"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"type":"\u003cstring>","title":"\u003cstring>","status":0,"detail":"\u003cstring>","instance":"\u003cstring>","errors":[{"pointer":"\u003cstring>","code":"\u003cstring>","detail":"\u003cstring>"}],"fields":["\u003cstring>"],"existingId":"\u003cstring>","step":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"8176f727-c71c-46ea-9693-90364dc198f4":{"apiKey":{"type":"http","scheme":"bearer","bearerFormat":"atk_live_…","description":"`Authorization: Bearer atk_live_…` (a sandbox's keys are `atk_test_…`). Created in the API keys section of the Integrations settings; the secret is shown once.","scopes":[],"schemeName":"apiKey"}},"0c7e1611-cf8c-415a-bf94-31afa5ec5942":{"oauth":{"type":"oauth2","description":"For an app installed in many tenants: client credentials, a one-hour `ato_…` token per tenant.","flows":{"clientCredentials":{"tokenUrl":"https://api.v3.andteam.com/v1/oauth/token","scopes":{}}},"scopes":[],"schemeName":"oauth"}}},"servers":{"53173e53-73ef-4ae2-87b8-83a71010e39d":{"url":"https://api.v3.andteam.com/v1"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","bearerFormat":"atk_live_…","description":"`Authorization: Bearer atk_live_…` (a sandbox's keys are `atk_test_…`). Created in the API keys section of the Integrations settings; the secret is shown once.","scopes":[],"schemeName":"apiKey"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"`Authorization: Bearer atk_live_…` (a sandbox's keys are `atk_test_…`). Created in the API keys section of the Integrations settings; the secret is shown once.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"apiKey","name":"Authorization"}],"title":"apiKey"},{"schemes":[{"scheme":{"type":"oauth2","description":"For an app installed in many tenants: client credentials, a one-hour `ato_…` token per tenant.","flows":{"clientCredentials":{"tokenUrl":"https://api.v3.andteam.com/v1/oauth/token","scopes":{}}},"scopes":[],"schemeName":"oauth"},"schema":{"title":"OAuth2 Auth","type":"string","isRequired":true,"description":"For an app installed in many tenants: client credentials, a one-hour `ato_…` token per tenant.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"oauth","name":"Authorization"}],"title":"oauth"}]},"originalFileLocation":"openapi.json"},"subdomain":"andteam","siteName":"andteam","title":"File an increase, promotion or adjustment of pay - andteam","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-11T08:45:03.413Z","originalFileLocation":"api-reference/pay/file-an-increase-promotion-or-adjustment-of-pay.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Needs the Pay field group\u0026#x27;s Write switch. Filed through andteam\u0026#x27;s own Change pay as the key\u0026#x27;s requester: the package is checked against the tenant\u0026#x27;s compensation rules and the date rule, and the approval chain, the self-approval guard and the audit trail apply. With the tenant\u0026#x27;s pay change approval chain the answer is 202 and nothing is written to pay until the last step approves; with none, 201. reason is kept as the change\u0026#x27;s note. A person in a protected group is not found unless the key\u0026#x27;s Pay approval includes protected groups. andteam never sends a letter for an API change.\">\u003cmeta data-mint-head name=\"application-name\" content=\"andteam\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/andteam/D1YWVRbXj0UYh9MI/_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/andteam/D1YWVRbXj0UYh9MI/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/andteam/D1YWVRbXj0UYh9MI/_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/andteam/D1YWVRbXj0UYh9MI/_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/andteam/D1YWVRbXj0UYh9MI/_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/andteam/D1YWVRbXj0UYh9MI/_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/andteam/D1YWVRbXj0UYh9MI/_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/andteam/D1YWVRbXj0UYh9MI/_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/andteam/D1YWVRbXj0UYh9MI/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"File an increase, promotion or adjustment of pay - andteam\">\u003cmeta data-mint-head property=\"og:description\" content=\"Needs the Pay field group\u0026#x27;s Write switch. Filed through andteam\u0026#x27;s own Change pay as the key\u0026#x27;s requester: the package is checked against the tenant\u0026#x27;s compensation rules and the date rule, and the approval chain, the self-approval guard and the audit trail apply. With the tenant\u0026#x27;s pay change approval chain the answer is 202 and nothing is written to pay until the last step approves; with none, 201. reason is kept as the change\u0026#x27;s note. A person in a protected group is not found unless the key\u0026#x27;s Pay approval includes protected groups. andteam never sends a letter for an API change.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"andteam\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.andteam.com/api-reference/pay/file-an-increase-promotion-or-adjustment-of-pay\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://andteam.mintlify.site/_mintlify/api/og/v2?division=Pay\u0026amp;title=File+an+increase%2C+promotion+or+adjustment+of+pay\u0026amp;description=Needs+the+Pay+field+group%27s+Write+switch.+Filed+through+andteam%27s+own+Change+pay+as+the+key%27s+requester%3A+the+package+is+checked+against+the+tenant%27s+compensatio\u0026amp;theme=823a7c0489dceecba2e0c789\u0026amp;signature=71a214901cdb3e0ff567386cbea025000f5a24b86be7577916492b339fc818c2\">\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=\"File an increase, promotion or adjustment of pay - andteam\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Needs the Pay field group\u0026#x27;s Write switch. Filed through andteam\u0026#x27;s own Change pay as the key\u0026#x27;s requester: the package is checked against the tenant\u0026#x27;s compensation rules and the date rule, and the approval chain, the self-approval guard and the audit trail apply. With the tenant\u0026#x27;s pay change approval chain the answer is 202 and nothing is written to pay until the last step approves; with none, 201. reason is kept as the change\u0026#x27;s note. A person in a protected group is not found unless the key\u0026#x27;s Pay approval includes protected groups. andteam never sends a letter for an API change.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://andteam.mintlify.site/_mintlify/api/og/v2?division=Pay\u0026amp;title=File+an+increase%2C+promotion+or+adjustment+of+pay\u0026amp;description=Needs+the+Pay+field+group%27s+Write+switch.+Filed+through+andteam%27s+own+Change+pay+as+the+key%27s+requester%3A+the+package+is+checked+against+the+tenant%27s+compensatio\u0026amp;theme=823a7c0489dceecba2e0c789\u0026amp;signature=71a214901cdb3e0ff567386cbea025000f5a24b86be7577916492b339fc818c2\">\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/andteam/D1YWVRbXj0UYh9MI/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"andteam\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#00827B\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.andteam.com/api-reference/pay/file-an-increase-promotion-or-adjustment-of-pay\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/pay/file-an-increase-promotion-or-adjustment-of-pay.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.andteam.com/#organization\",\"name\":\"andteam\",\"url\":\"https://docs.andteam.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/andteam/MVfTtzphnPhhxPa9/logo/andteam.svg?fit=max\u0026auto=format\u0026n=MVfTtzphnPhhxPa9\u0026q=85\u0026s=b11d93ffad90324a82a8c0d5d1a0c404\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.andteam.com#website\",\"name\":\"andteam\",\"url\":\"https://docs.andteam.com\",\"publisher\":{\"@id\":\"https://docs.andteam.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.andteam.com/api-reference/pay/file-an-increase-promotion-or-adjustment-of-pay#webpage\",\"url\":\"https://docs.andteam.com/api-reference/pay/file-an-increase-promotion-or-adjustment-of-pay\",\"name\":\"File an increase, promotion or adjustment of pay\",\"description\":\"Needs the Pay field group's Write switch. Filed through andteam's own Change pay as the key's requester: the package is checked against the tenant's compensation rules and the date rule, and the approval chain, the self-approval guard and the audit trail apply. With the tenant's pay change approval chain the answer is 202 and nothing is written to pay until the last step approves; with none, 201. reason is kept as the change's note. A person in a protected group is not found unless the key's Pay approval includes protected groups. andteam never sends a letter for an API change.\",\"dateModified\":\"2026-11-11T08:45:03.413Z\",\"isPartOf\":{\"@id\":\"https://docs.andteam.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.andteam.com/api-reference/pay/file-an-increase-promotion-or-adjustment-of-pay#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.andteam.com/api-reference/pay/file-an-increase-promotion-or-adjustment-of-pay#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Pay\",\"item\":\"https://docs.andteam.com/api-reference/pay/get-an-employees-current-pay-package\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"File an increase, promotion or adjustment of pay\",\"item\":\"https://docs.andteam.com/api-reference/pay/file-an-increase-promotion-or-adjustment-of-pay\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.andteam.com/api-reference/pay/file-an-increase-promotion-or-adjustment-of-pay#apireference\",\"headline\":\"File an increase, promotion or adjustment of pay\",\"name\":\"File an increase, promotion or adjustment of pay\",\"description\":\"Needs the Pay field group's Write switch. Filed through andteam's own Change pay as the key's requester: the package is checked against the tenant's compensation rules and the date rule, and the approval chain, the self-approval guard and the audit trail apply. With the tenant's pay change approval chain the answer is 202 and nothing is written to pay until the last step approves; with none, 201. reason is kept as the change's note. A person in a protected group is not found unless the key's Pay approval includes protected groups. andteam never sends a letter for an API change.\",\"url\":\"https://docs.andteam.com/api-reference/pay/file-an-increase-promotion-or-adjustment-of-pay\",\"mainEntityOfPage\":{\"@id\":\"https://docs.andteam.com/api-reference/pay/file-an-increase-promotion-or-adjustment-of-pay#webpage\"},\"dateModified\":\"2026-11-11T08:45:03.413Z\",\"publisher\":{\"@id\":\"https://docs.andteam.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.andteam.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"andteam\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"andteam\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/pay/file-an-increase-promotion-or-adjustment-of-pay.md","siteName":"andteam","nav":{"global":null,"tabs":[{"tab":"Guides","pages":[{"title":"Guides","href":""}]},{"tab":"API reference","groups":[{"group":"Directory","pages":[{"title":"List employees","deprecated":null,"version":null,"openapi":"/openapi.json get /employees","href":"/api-reference/directory/list-employees"},{"title":"Get one employee","deprecated":null,"version":null,"openapi":"/openapi.json get /employees/{id}","href":"/api-reference/directory/get-one-employee"},{"title":"Change an employee's personal and contact details","deprecated":null,"version":null,"openapi":"/openapi.json patch /employees/{id}","href":"/api-reference/directory/change-an-employees-personal-and-contact-details"},{"title":"List published employee events","deprecated":null,"version":null,"openapi":"/openapi.json get /events","href":"/api-reference/directory/list-published-employee-events"}]},{"group":"Organisation","pages":[{"title":"List the key's companies","deprecated":null,"version":null,"openapi":"/openapi.json get /companies","href":"/api-reference/organisation/list-the-keys-companies"},{"title":"List the structure's units below Company","deprecated":null,"version":null,"openapi":"/openapi.json get /org-units","href":"/api-reference/organisation/list-the-structures-units-below-company"},{"title":"List locations","deprecated":null,"version":null,"openapi":"/openapi.json get /locations","href":"/api-reference/organisation/list-locations"},{"title":"List a lookup's values","deprecated":null,"version":null,"openapi":"/openapi.json get /lookups/{type}","href":"/api-reference/organisation/list-a-lookups-values"}]},{"group":"Positions","pages":[{"title":"List positions","deprecated":null,"version":null,"openapi":"/openapi.json get /positions","href":"/api-reference/positions/list-positions"}]},{"group":"Time off","pages":[{"title":"List absences that were approved: approved, or cancelled once withdrawn (dates only, never the leave type)","deprecated":null,"version":null,"openapi":"/openapi.json get /time-off","href":"/api-reference/time-off/list-absences-that-were-approved:-approved-or-cancelled-once-withdrawn-dates-only-never-the-leave-type"}]},{"group":"Job history","pages":[{"title":"A person's job history, newest first","deprecated":null,"version":null,"openapi":"/openapi.json get /employees/{id}/job-history","href":"/api-reference/job-history/a-persons-job-history-newest-first"},{"title":"List job-history entries across the key's companies","deprecated":null,"version":null,"openapi":"/openapi.json get /job-history","href":"/api-reference/job-history/list-job-history-entries-across-the-keys-companies"},{"title":"File a promotion, transfer or re-grade","deprecated":null,"version":null,"openapi":"/openapi.json post /employees/{id}/job-changes","href":"/api-reference/job-history/file-a-promotion-transfer-or-re-grade"},{"title":"Get a job change","deprecated":null,"version":null,"openapi":"/openapi.json get /job-changes/{id}","href":"/api-reference/job-history/get-a-job-change"},{"title":"Withdraw a pending job change","deprecated":null,"version":null,"openapi":"/openapi.json post /job-changes/{id}/withdraw","href":"/api-reference/job-history/withdraw-a-pending-job-change"}]},{"group":"Leave","pages":[{"title":"List the leave types","deprecated":null,"version":null,"openapi":"/openapi.json get /leave-types","href":"/api-reference/leave/list-the-leave-types"},{"title":"A person's leave balances","deprecated":null,"version":null,"openapi":"/openapi.json get /employees/{id}/leave-balances","href":"/api-reference/leave/a-persons-leave-balances"},{"title":"List leave requests (never a sick request)","deprecated":null,"version":null,"openapi":"/openapi.json get /leave-requests","href":"/api-reference/leave/list-leave-requests-never-a-sick-request"},{"title":"Get one leave request","deprecated":null,"version":null,"openapi":"/openapi.json get /leave-requests/{id}","href":"/api-reference/leave/get-one-leave-request"},{"title":"Request leave for an employee","deprecated":null,"version":null,"openapi":"/openapi.json post /employees/{id}/leave-requests","href":"/api-reference/leave/request-leave-for-an-employee"},{"title":"Withdraw a leave request this key made","deprecated":null,"version":null,"openapi":"/openapi.json post /leave-requests/{id}/withdraw","href":"/api-reference/leave/withdraw-a-leave-request-this-key-made"}]},{"group":"Certifications","pages":[{"title":"A person's current certifications","deprecated":null,"version":null,"openapi":"/openapi.json get /employees/{id}/certifications","href":"/api-reference/certifications/a-persons-current-certifications"}]},{"group":"Pay","pages":[{"title":"Get an employee's current pay package","deprecated":null,"version":null,"openapi":"/openapi.json get /employees/{id}/pay","href":"/api-reference/pay/get-an-employees-current-pay-package"},{"title":"List an employee's pay packages, newest first","description":"Needs the Pay field group. Pay, approved by a holder of Sign off payroll. Packages in force so far, newest first: a change still to come is left out until its date. Never the reason note or who approved it. People in protected groups answer 404 unless the approver ticked Include protected groups.","deprecated":null,"version":null,"openapi":"/openapi.json get /employees/{id}/pay-history","href":"/api-reference/pay/list-an-employees-pay-packages-newest-first"},{"title":"File an increase, promotion or adjustment of pay","deprecated":null,"version":null,"openapi":"/openapi.json post /employees/{id}/pay-changes","href":"/api-reference/pay/file-an-increase-promotion-or-adjustment-of-pay"},{"title":"Get a pay change","description":"Needs the Pay field group. Any pay change of the key's companies, filed through the API or in andteam: which components and from when, never an amount.","deprecated":null,"version":null,"openapi":"/openapi.json get /pay-changes/{id}","href":"/api-reference/pay/get-a-pay-change"},{"title":"Withdraw a pending pay change","deprecated":null,"version":null,"openapi":"/openapi.json post /pay-changes/{id}/withdraw","href":"/api-reference/pay/withdraw-a-pending-pay-change"}]},{"group":"Performance","pages":[{"title":"List an employee's released final performance ratings","deprecated":null,"version":null,"openapi":"/openapi.json get /employees/{id}/performance-ratings","href":"/api-reference/performance/list-an-employees-released-final-performance-ratings"}]},{"group":"Documents","pages":[{"title":"List an employee's documents, newest first","deprecated":null,"version":null,"openapi":"/openapi.json get /employees/{id}/documents","href":"/api-reference/documents/list-an-employees-documents-newest-first"},{"title":"Download a document","deprecated":null,"version":null,"openapi":"/openapi.json get /documents/{id}/download","href":"/api-reference/documents/download-a-document"}]},{"group":"Hires","pages":[{"title":"File a new hire: a prefilled draft offer HR completes","deprecated":null,"version":null,"openapi":"/openapi.json post /hires","href":"/api-reference/hires/file-a-new-hire:-a-prefilled-draft-offer-hr-completes"},{"title":"Get one hire and its status","deprecated":null,"version":null,"openapi":"/openapi.json get /hires/{id}","href":"/api-reference/hires/get-one-hire-and-its-status"}]},{"group":"Authentication","pages":[{"title":"Get an access token (OAuth client credentials)","deprecated":null,"version":null,"openapi":"/openapi.json post /oauth/token","href":"/api-reference/authentication/get-an-access-token-oauth-client-credentials"}]},{"group":"Reference","pages":[{"title":"This document","deprecated":null,"version":null,"openapi":"/openapi.json get /openapi.json","href":"/api-reference/reference/this-document"}]},{"group":"Webhooks","pages":[{"title":"Employeehired","version":null,"deprecated":null,"openapi":"/openapi.json webhook employee.hired","href":"/api-reference/webhooks/employeehired"},{"title":"Employeestarted","version":null,"deprecated":null,"openapi":"/openapi.json webhook employee.started","href":"/api-reference/webhooks/employeestarted"},{"title":"Employeechanged","version":null,"deprecated":null,"openapi":"/openapi.json webhook employee.changed","href":"/api-reference/webhooks/employeechanged"},{"title":"Employeeleaving","version":null,"deprecated":null,"openapi":"/openapi.json webhook employee.leaving","href":"/api-reference/webhooks/employeeleaving"},{"title":"Employeeleft","version":null,"deprecated":null,"openapi":"/openapi.json webhook employee.left","href":"/api-reference/webhooks/employeeleft"},{"title":"Employeehire withdrawn","version":null,"deprecated":null,"openapi":"/openapi.json webhook employee.hire_withdrawn","href":"/api-reference/webhooks/employeehire_withdrawn"},{"title":"Employeetermination cancelled","version":null,"deprecated":null,"openapi":"/openapi.json webhook employee.termination_cancelled","href":"/api-reference/webhooks/employeetermination_cancelled"},{"title":"Hirestatus changed","version":null,"deprecated":null,"openapi":"/openapi.json webhook hire.status_changed","href":"/api-reference/webhooks/hirestatus_changed"},{"title":"Job changerequested","version":null,"deprecated":null,"openapi":"/openapi.json webhook job_change.requested","href":"/api-reference/webhooks/job_changerequested"},{"title":"Job changedecided","version":null,"deprecated":null,"openapi":"/openapi.json webhook job_change.decided","href":"/api-reference/webhooks/job_changedecided"},{"title":"Pay changerequested","version":null,"deprecated":null,"openapi":"/openapi.json webhook pay_change.requested","href":"/api-reference/webhooks/pay_changerequested"},{"title":"Pay changedecided","version":null,"deprecated":null,"openapi":"/openapi.json webhook pay_change.decided","href":"/api-reference/webhooks/pay_changedecided"},{"title":"Leave requestsubmitted","version":null,"deprecated":null,"openapi":"/openapi.json webhook leave_request.submitted","href":"/api-reference/webhooks/leave_requestsubmitted"},{"title":"Leave requestdecided","version":null,"deprecated":null,"openapi":"/openapi.json webhook leave_request.decided","href":"/api-reference/webhooks/leave_requestdecided"},{"title":"Performancerating released","version":null,"deprecated":null,"openapi":"/openapi.json webhook performance.rating_released","href":"/api-reference/webhooks/performancerating_released"},{"title":"Documentadded","version":null,"deprecated":null,"openapi":"/openapi.json webhook document.added","href":"/api-reference/webhooks/documentadded"}]}]},{"tab":"Changelog","pages":[{"title":"Changelog","href":"/api/changelog"}]}]},"basePath":"","title":"File an increase, promotion or adjustment of pay - andteam","buildId":"dpl_DqYu5MPb49gWBBbUGgpHQUmCHY3P","deploymentId":"dpl_DqYu5MPb49gWBBbUGgpHQUmCHY3P","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-CybtLBIt.js","utils-BMLj2fvV.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-B6In562Y.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-Dr8Mfhp9.js","snippetPresets-2rmQvMVl.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-WMqJYdZj.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-CJ-MlPHu.js","shallow-dY3TMRCk.js","getApiPlaygroundDisplay-v-1B2bKm.js","CodeSnippet-BDhiTB7U.js","CodeSnippets-D9hnzQcS.js","Page-C4GwDT3_.js","getPastedJson-Th2V45jI.js","icon-BQXch1W9.js","MethodPill-BCqUneP3.js","DuplicateIcon-Q_-bhurZ.js","createIcon-DUjLHRqp.js","DynamicMarkdown-B-f2cqXQ.js","SectionHeading-Da5NsV4v.js","axios-vUo_bRtp.js","Markdown-D13FWkIM.js","clsx-D3Isdib3.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-C-XZBk9h.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink--qIqmmVG.js"]}