Returns the balance of the employee employeeId that can be compensated with rest over the from-to period, per source, in seconds. It is the value POST /overtime-policies/v1/compensations/rest checks balanceBeforeSeconds against: read it right before that request, with the same from/to, and send the value of the key matching the source (positive_balance for positive_balance, negative_balance for negative_balance, total_balance otherwise). Only closed days count (up to yesterday), and time to be remunerated, time already compensated and expired time are excluded, so it drops after every compensation and a replayed request is rejected with 409 compensable_balance_changed. A reset adjustment zeroes it as of the moment it is made, except that time expired before the reset still reduces it afterwards. It differs from GET /overtime-policies/v1/employees/{employeeId}/balance, which is the balance adjustments are checked against. The employee must belong to the company of the token. The read permission is checked over the employee before the lookup: an employee the API consumer has no role over answers 403. When the permission passes, as it does for a company-wide API consumer, an id that is not an employee of the company of the token (including an unknown id) answers 422 employee_not_adjustable.
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
employeeId
string<uuid>
required
The employee ID. It must belong to the company of the token.
Query Parameters
from
string<date>
required
First day of the period (Y-m-d). Must not be after to. Use the same value as in POST /overtime-policies/v1/compensations/rest.
Example:
"2026-01-01"
to
string<date>
required
Last day of the period (Y-m-d), inclusive. It can be equal to from. Use the same value as in POST /overtime-policies/v1/compensations/rest.
Example:
"2026-01-31"
Response
Rest-compensable balance of the employee for the period. The status is 200; meta is the default single-object meta.
data
object
required
Balance of the employee that can be compensated with rest over the requested period, in seconds, per source (RestCompensableBalanceForApiView). Only closed days count; the rest and shared buckets, margins, adjustments and transfers are included; time to be remunerated, time already compensated and expired time are not. Every number is clamped at 0.
Show child attributes
meta
object
required
Show child attributes
Was this page helpful?
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Sesame HR API","colors":{"primary":"#1F2D52","light":"#55E5BC","dark":"#4F46E5"},"logo":{"light":"https://mintcdn.com/sesanelabssl/zP97BBsaqG7vDc2J/images/logo-light.svg?fit=max\u0026auto=format\u0026n=zP97BBsaqG7vDc2J\u0026q=85\u0026s=771054c1315d6cbe9d409449d51dbbc0","dark":"https://mintcdn.com/sesanelabssl/zP97BBsaqG7vDc2J/images/logo-dark.svg?fit=max\u0026auto=format\u0026n=zP97BBsaqG7vDc2J\u0026q=85\u0026s=81f767c1ec1cd9f8d9d4c4a65dda06f7","href":"https://sesamehr.com"},"favicon":"https://mintcdn.com/sesanelabssl/NnyzTHeMUwJu94lY/favicon.svg?fit=max\u0026auto=format\u0026n=NnyzTHeMUwJu94lY\u0026q=85\u0026s=25a3d7a0afbd065955838a4935895021","api":{"playground":{},"mdx":{"auth":{"method":"bearer"}}},"appearance":{"default":"light"},"navbar":{"links":[{"href":"https://help.sesamehr.com","label":"Support"},{"href":"https://status.sesametime.com","label":"Status"}],"primary":{"type":"button","label":"Get API Key","href":"https://app.sesametime.com/admin/configuration/integrations/api-tokens"}},"footer":{"socials":{"linkedin":"https://www.linkedin.com/company/sesamehr","youtube":"https://youtube.com/@sesamehr","instagram":"https://instagram.com/sesame_hr"}},"seo":{"indexing":"navigable"},"integrations":{"ga4":{"measurementId":"G-XXXXXXXXXX"},"intercom":{"appId":"app_id"}},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","grok","cursor","vscode"],"display":"header"},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"sesanelabssl","hasAudioNarration":false,"actualSubdomain":"sesanelabssl","customDomains":["apidocs.sesametime.com"],"gitSource":{"type":"gitlab","owner":"sesame","repo":"mintlify-apidocs-sesame-v2","hostUrl":"https://repositorios.artvisual.net","projectId":1475,"deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"feedback":{"thumbs":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6af59cf02babf8b7e6acd2c7","clientVersion":"0.0.4270","searchFilterCounts":[{"language":"default","tag":"API Reference","count":338},{"language":"default","tag":"API Legacy","count":291},{"language":"default","tag":"Core","count":44},{"language":"default","tag":"Getting Started","count":10},{"language":"default","tag":"Planners","count":9},{"language":"default","tag":"Custom fields","count":8},{"language":"default","tag":"Work Entries","count":8},{"language":"default","tag":"Recruitment","count":8},{"language":"default","tag":"Employees","count":7},{"language":"default","tag":"Contracts","count":7}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":true,"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":"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":"site-roles","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},{"name":"starter-pricing","enabled":true,"variant":{"name":"treatment","enabled":true,"payload":{"type":"string","value":"treatment"},"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"wildcard-email-auth","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"starterQuestions":[{"_id":"69cced8f7db85b9ab8235864","deploymentId":"69c39fdef9f51c568e93a0c0","questionText":"How do I get my employees’ vacation days?","status":"active","generatedBy":"manual","createdAt":"2026-04-01T10:03:59.680Z","updatedAt":"2026-04-01T10:03:59.680Z","__v":0},{"_id":"69cced8c7db85b9ab823585e","deploymentId":"69c39fdef9f51c568e93a0c0","questionText":"How do I get my employees’ work entries?","status":"active","generatedBy":"manual","createdAt":"2026-04-01T10:03:56.114Z","updatedAt":"2026-04-01T10:03:56.114Z","__v":0},{"_id":"69cced857db85b9ab823583e","deploymentId":"69c39fdef9f51c568e93a0c0","questionText":"How do I get all my active employees?","status":"active","generatedBy":"manual","createdAt":"2026-04-01T10:03:49.145Z","updatedAt":"2026-04-01T10:03:49.145Z","__v":0}],"googleFontsInlined":false},"customCss":[{"filePath":"custom.css","content":".endpoint-versions{display:inline-flex;align-items:center;gap:0.375rem;margin-bottom:1rem;font-size:0.875rem}.endpoint-versions-label{color:rgb(107 114 128);margin-right:0.125rem}.dark .endpoint-versions-label{color:rgb(156 163 175)}.endpoint-versions [data-version]{padding:0.125rem 0.625rem;border:1px solid rgb(0 0 0 / 0.15);border-radius:9999px;line-height:1.4;text-decoration:none;color:inherit}.dark .endpoint-versions [data-version]{border-color:rgb(255 255 255 / 0.2)}.endpoint-versions a[data-version]:hover{border-color:#1f2d52;color:#1f2d52}.dark .endpoint-versions a[data-version]:hover{border-color:#55e5bc;color:#55e5bc}.endpoint-versions [data-current]{background:#1f2d52;border-color:#1f2d52;color:#ffffff;font-weight:600}.dark .endpoint-versions [data-current]{background:#55e5bc;border-color:#55e5bc;color:#0b1120}a.endpoint-version-active,button.endpoint-version-active{background:rgb(31 45 82 / 0.1);color:#1f2d52}.dark a.endpoint-version-active,.dark button.endpoint-version-active{background:rgb(85 229 188 / 0.1);color:#55e5bc}.api-deprecation{display:block;margin:1rem 0;padding:0.85rem 1rem;border:1px solid;border-radius:0.5rem;font-size:0.875rem;line-height:1.55}.api-deprecation:not([data-state]){display:none}.api-deprecation::before{margin-right:0.4rem}.api-deprecation[data-state=\"deprecated\"]{background:rgb(245 158 11 / 0.08);border-color:rgb(245 158 11 / 0.35);color:#9a6700}.api-deprecation[data-state=\"deprecated\"]::before{content:\"\\26A0\\FE0F\"}.dark .api-deprecation[data-state=\"deprecated\"]{color:#fbbf24}.api-deprecation[data-state=\"expired\"]{background:rgb(239 68 68 / 0.09);border-color:rgb(239 68 68 / 0.4);color:#b42318}.api-deprecation[data-state=\"expired\"]::before{content:\"\\26D4\"}.dark .api-deprecation[data-state=\"expired\"]{color:#f87171}.api-deprecation code{padding:0.05rem 0.35rem;border-radius:0.25rem;background:rgb(0 0 0 / 0.08);font-size:0.85em}.dark .api-deprecation code{background:rgb(255 255 255 / 0.12)}.api-deprecation a{color:inherit;text-decoration:underline;text-underline-offset:2px}.api-deprecation a:hover code{background:rgb(0 0 0 / 0.16)}.dark .api-deprecation a:hover code{background:rgb(255 255 255 / 0.2)}"}]}
{"page":{"pagePath":"api-reference/getemployeerestcompensablebalance","slug":"/api-reference/getemployeerestcompensablebalance","pageMetadata":{"title":"Get the rest-compensable balance of an employee","openapi":"GET /overtime-policies/v1/employees/{employeeId}/rest-compensable-balance","description":"Returns the balance of the employee `employeeId` that can be compensated with rest over the `from`-`to` period, per source, in seconds. It is the value `POST /overtime-policies/v1/compensations/rest` checks `balanceBeforeSeconds` against: read it right before that request, with the same `from`/`to`, and send the value of the key matching the source (`positive_balance` for `positive_balance`, `negative_balance` for `negative_balance`, `total_balance` otherwise). Only closed days count (up to yesterday), and time to be remunerated, time already compensated and expired time are excluded, so it drops after every compensation and a replayed request is rejected with 409 `compensable_balance_changed`. A `reset` adjustment zeroes it as of the moment it is made, except that time expired before the reset still reduces it afterwards. It differs from `GET /overtime-policies/v1/employees/{employeeId}/balance`, which is the balance adjustments are checked against. The employee must belong to the company of the token. The read permission is checked over the employee before the lookup: an employee the API consumer has no role over answers 403. When the permission passes, as it does for a company-wide API consumer, an id that is not an employee of the company of the token (including an unknown id) answers 422 `employee_not_adjustable`.","href":"/api-reference/getemployeerestcompensablebalance"},"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: [\"Returns the balance of the employee \", _jsx(_components.code, {\n children: \"employeeId\"\n }), \" that can be compensated with rest over the \", _jsx(_components.code, {\n children: \"from\"\n }), \"-\", _jsx(_components.code, {\n children: \"to\"\n }), \" period, per source, in seconds. It is the value \", _jsx(_components.code, {\n children: \"POST /overtime-policies/v1/compensations/rest\"\n }), \" checks \", _jsx(_components.code, {\n children: \"balanceBeforeSeconds\"\n }), \" against: read it right before that request, with the same \", _jsx(_components.code, {\n children: \"from\"\n }), \"/\", _jsx(_components.code, {\n children: \"to\"\n }), \", and send the value of the key matching the source (\", _jsx(_components.code, {\n children: \"positive_balance\"\n }), \" for \", _jsx(_components.code, {\n children: \"positive_balance\"\n }), \", \", _jsx(_components.code, {\n children: \"negative_balance\"\n }), \" for \", _jsx(_components.code, {\n children: \"negative_balance\"\n }), \", \", _jsx(_components.code, {\n children: \"total_balance\"\n }), \" otherwise). Only closed days count (up to yesterday), and time to be remunerated, time already compensated and expired time are excluded, so it drops after every compensation and a replayed request is rejected with 409 \", _jsx(_components.code, {\n children: \"compensable_balance_changed\"\n }), \". A \", _jsx(_components.code, {\n children: \"reset\"\n }), \" adjustment zeroes it as of the moment it is made, except that time expired before the reset still reduces it afterwards. It differs from \", _jsx(_components.code, {\n children: \"GET /overtime-policies/v1/employees/{employeeId}/balance\"\n }), \", which is the balance adjustments are checked against. The employee must belong to the company of the token. The read permission is checked over the employee before the lookup: an employee the API consumer has no role over answers 403. When the permission passes, as it does for a company-wide API consumer, an id that is not an employee of the company of the token (including an unknown id) answers 422 \", _jsx(_components.code, {\n children: \"employee_not_adjustable\"\n }), \".\"]\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":"Get the rest-compensable balance of an employee","openapi":"GET /overtime-policies/v1/employees/{employeeId}/rest-compensable-balance","description":"Returns the balance of the employee `employeeId` that can be compensated with rest over the `from`-`to` period, per source, in seconds. It is the value `POST /overtime-policies/v1/compensations/rest` checks `balanceBeforeSeconds` against: read it right before that request, with the same `from`/`to`, and send the value of the key matching the source (`positive_balance` for `positive_balance`, `negative_balance` for `negative_balance`, `total_balance` otherwise). Only closed days count (up to yesterday), and time to be remunerated, time already compensated and expired time are excluded, so it drops after every compensation and a replayed request is rejected with 409 `compensable_balance_changed`. A `reset` adjustment zeroes it as of the moment it is made, except that time expired before the reset still reduces it afterwards. It differs from `GET /overtime-policies/v1/employees/{employeeId}/balance`, which is the balance adjustments are checked against. The employee must belong to the company of the token. The read permission is checked over the employee before the lookup: an employee the API consumer has no role over answers 403. When the permission passes, as it does for a company-wide API consumer, an id that is not an employee of the company of the token (including an unknown id) answers 422 `employee_not_adjustable`.","href":"/api-reference/getemployeerestcompensablebalance"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/sesanelabssl/51834092d564e888/custom.js"],"openApiReferenceData":{"operation":{"tags":["Overtime Policies"],"summary":"Get the rest-compensable balance of an employee","description":"Returns the balance of the employee `employeeId` that can be compensated with rest over the `from`-`to` period, per source, in seconds. It is the value `POST /overtime-policies/v1/compensations/rest` checks `balanceBeforeSeconds` against: read it right before that request, with the same `from`/`to`, and send the value of the key matching the source (`positive_balance` for `positive_balance`, `negative_balance` for `negative_balance`, `total_balance` otherwise). Only closed days count (up to yesterday), and time to be remunerated, time already compensated and expired time are excluded, so it drops after every compensation and a replayed request is rejected with 409 `compensable_balance_changed`. A `reset` adjustment zeroes it as of the moment it is made, except that time expired before the reset still reduces it afterwards. It differs from `GET /overtime-policies/v1/employees/{employeeId}/balance`, which is the balance adjustments are checked against. The employee must belong to the company of the token. The read permission is checked over the employee before the lookup: an employee the API consumer has no role over answers 403. When the permission passes, as it does for a company-wide API consumer, an id that is not an employee of the company of the token (including an unknown id) answers 422 `employee_not_adjustable`.","operationId":"GetEmployeeRestCompensableBalance","parameters":["c1953523-1065-47f2-a759-87ffc1be0785","36a71288-5031-4929-9b20-95314087b77f","0caf2b1c-b1b2-4d78-8e72-cd0672ecfde7"],"responses":{"200":"7138368a-af79-4f8b-9d75-ff2aa365e334","401":"1e7004f2-ebb2-4385-b5a9-7f701f150572","402":"70f53158-620b-4db9-ae6a-03351c3337af","403":"4c097b3d-159f-48b0-94b0-1df6b66ca757","422":"81b0e967-6946-4d32-a70e-160c1cb0df70","429":"f08e36ed-f879-490a-bff3-ee2136ed5aba"},"security":["a8bc11b5-709f-4651-907e-ca2de12de754"],"method":"get","type":"path","servers":["80dd7ad3-bce0-4217-bd70-4335da38c420"],"path":"/overtime-policies/v1/employees/{employeeId}/rest-compensable-balance","baseUrlOptions":["https://api-{region}.sesametime.com"],"title":"Get the rest-compensable balance of an employee","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"c1953523-1065-47f2-a759-87ffc1be0785":{"name":"employeeId","in":"path","required":true,"description":"The employee ID. It must belong to the company of the token.","schema":{"type":"string","format":"uuid","isRequired":true,"description":"The employee ID. It must belong to the company of the token.","uniqueKey":"","typeLabel":"string\u003cuuid>"}},"36a71288-5031-4929-9b20-95314087b77f":{"name":"from","in":"query","required":true,"description":"First day of the period (Y-m-d). Must not be after `to`. Use the same value as in `POST /overtime-policies/v1/compensations/rest`.","schema":{"type":"string","format":"date","example":"2026-01-01","isRequired":true,"description":"First day of the period (Y-m-d). Must not be after `to`. Use the same value as in `POST /overtime-policies/v1/compensations/rest`.","uniqueKey":"","typeLabel":"string\u003cdate>"}},"0caf2b1c-b1b2-4d78-8e72-cd0672ecfde7":{"name":"to","in":"query","required":true,"description":"Last day of the period (Y-m-d), inclusive. It can be equal to `from`. Use the same value as in `POST /overtime-policies/v1/compensations/rest`.","schema":{"type":"string","format":"date","example":"2026-01-31","isRequired":true,"description":"Last day of the period (Y-m-d), inclusive. It can be equal to `from`. Use the same value as in `POST /overtime-policies/v1/compensations/rest`.","uniqueKey":"","typeLabel":"string\u003cdate>"}}},"responses":{"7138368a-af79-4f8b-9d75-ff2aa365e334":{"description":"Rest-compensable balance of the employee for the period. The status is 200; `meta` is the default single-object meta.","content":{"application/json":{"schema":{"type":"object","required":["data","meta"],"properties":{"data":{"type":"object","description":"Balance of the employee that can be compensated with rest over the requested period, in seconds, per source (RestCompensableBalanceForApiView). Only closed days count; the rest and shared buckets, margins, adjustments and transfers are included; time to be remunerated, time already compensated and expired time are not. Every number is clamped at 0.","required":["total_balance","positive_balance","negative_balance"],"properties":{"total_balance":{"type":"integer","minimum":0,"description":"Net rest-compensable balance. Value to send as `balanceBeforeSeconds` for source `total_balance` (or when `source` is omitted).","example":5400,"isRequired":true,"uniqueKey":"data.total_balance","typeLabel":"integer"},"positive_balance":{"type":"integer","minimum":0,"description":"Rest-compensable positive balance. Value to send as `balanceBeforeSeconds` for source `positive_balance`.","example":7200,"isRequired":true,"uniqueKey":"data.positive_balance","typeLabel":"integer"},"negative_balance":{"oneOf":[{"type":"integer","minimum":0,"description":"Rest-compensable magnitude of the negative balance (a positive number). Value to send as `balanceBeforeSeconds` for source `negative_balance`. `null` when the overtime policy of the employee does not allow compensating from the negative balance (only independent policies with separate positive and negative balances do); a request with that source is then rejected with 422.","example":1800,"isRequired":true,"uniqueKey":"data.negative_balance.oneOf.0","typeLabel":"integer"},{"type":"null","minimum":0,"description":"Rest-compensable magnitude of the negative balance (a positive number). Value to send as `balanceBeforeSeconds` for source `negative_balance`. `null` when the overtime policy of the employee does not allow compensating from the negative balance (only independent policies with separate positive and negative balances do); a request with that source is then rejected with 422.","example":1800,"isRequired":true,"uniqueKey":"data.negative_balance.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.negative_balance","typeLabel":"integer | null"}},"isRequired":true,"uniqueKey":"data","typeLabel":"object"},"meta":{"type":"object","properties":{"currentPage":{"type":"integer","example":1,"uniqueKey":"meta.currentPage","typeLabel":"integer"},"lastPage":{"type":"integer","example":1,"uniqueKey":"meta.lastPage","typeLabel":"integer"},"total":{"type":"integer","example":1,"uniqueKey":"meta.total","typeLabel":"integer"},"perPage":{"type":"integer","example":1,"uniqueKey":"meta.perPage","typeLabel":"integer"}},"isRequired":true,"uniqueKey":"meta","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"negative_source_available":{"title":"negative_source_available","summary":"Independent policy with separate positive and negative balances","value":{"data":{"total_balance":5400,"positive_balance":7200,"negative_balance":1800},"meta":{"currentPage":1,"lastPage":1,"total":1,"perPage":1}}},"negative_source_unavailable":{"title":"negative_source_unavailable","summary":"Policy that does not compensate from the negative balance","value":{"data":{"total_balance":7200,"positive_balance":7200,"negative_balance":null},"meta":{"currentPage":1,"lastPage":1,"total":1,"perPage":1}}}},"exampleType":"examples"}},"exampleType":"examples"},"1e7004f2-ebb2-4385-b5a9-7f701f150572":{"description":"Unauthorized - The `Authorization: Bearer` token is missing, unknown or disabled (`unauthorized`, UnauthorizedHttpException), or the API token has expired (`api_token_expired`, ApiConsumerSessionExpiredException).","content":{"application/json":{"schema":{"type":"object","description":"Error envelope produced by JsonApiResponseFactory for every non-2xx response.","required":["error"],"properties":{"error":{"type":"object","required":["status","message","errors"],"properties":{"status":{"type":"integer","description":"HTTP status code, repeated in the body","example":422,"isRequired":true,"uniqueKey":"error.status","typeLabel":"integer"},"message":{"type":"string","description":"Error message. For domain and authentication errors it is a stable error code; for request validation errors it is `Unprocessable entity`.","example":"employee_not_adjustable","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"errors":{"oneOf":[{"type":"string","description":"For domain and authentication errors, a stable error code (string) to branch on. For request validation errors, an object keyed by field name whose value is the list of messages for that field (translated into the request locale).","example":"employee_not_adjustable","isRequired":true,"uniqueKey":"error.errors.oneOf.0","typeLabel":"string"},{"type":"object","description":"For domain and authentication errors, a stable error code (string) to branch on. For request validation errors, an object keyed by field name whose value is the list of messages for that field (translated into the request locale).","example":{"employeeId":["validator.invalid_uuid"]},"additionalProperties":{"type":"array","items":{"type":"string","uniqueKey":"error.errors.oneOf.1.additionalProperties.items.[INDEX]","typeLabel":"string"},"uniqueKey":"error.errors.oneOf.1.additionalProperties","typeLabel":"string[]"},"isRequired":true,"uniqueKey":"error.errors.oneOf.1","typeLabel":"object"}],"isRequired":true,"uniqueKey":"error.errors","typeLabel":"string | object"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"unauthorized":{"title":"unauthorized","summary":"Missing, unknown or disabled token","value":{"error":{"status":401,"message":"Unauthorized","errors":"unauthorized"}}},"api_token_expired":{"title":"api_token_expired","summary":"Expired API token","value":{"error":{"status":401,"message":"api_token_expired","errors":"api_token_expired"}}}},"exampleType":"examples"}},"exampleType":"examples"},"70f53158-620b-4db9-ae6a-03351c3337af":{"description":"Payment Required - The subscription of the company of the token is cancelled (SubscriptionPseudoCancelledException).","content":{"application/json":{"schema":{"type":"object","description":"Error envelope produced by JsonApiResponseFactory for every non-2xx response.","required":["error"],"properties":{"error":{"type":"object","required":["status","message","errors"],"properties":{"status":{"type":"integer","description":"HTTP status code, repeated in the body","example":422,"isRequired":true,"uniqueKey":"error.status","typeLabel":"integer"},"message":{"type":"string","description":"Error message. For domain and authentication errors it is a stable error code; for request validation errors it is `Unprocessable entity`.","example":"employee_not_adjustable","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"errors":{"oneOf":[{"type":"string","description":"For domain and authentication errors, a stable error code (string) to branch on. For request validation errors, an object keyed by field name whose value is the list of messages for that field (translated into the request locale).","example":"employee_not_adjustable","isRequired":true,"uniqueKey":"error.errors.oneOf.0","typeLabel":"string"},{"type":"object","description":"For domain and authentication errors, a stable error code (string) to branch on. For request validation errors, an object keyed by field name whose value is the list of messages for that field (translated into the request locale).","example":{"employeeId":["validator.invalid_uuid"]},"additionalProperties":{"type":"array","items":{"type":"string","uniqueKey":"error.errors.oneOf.1.additionalProperties.items.[INDEX]","typeLabel":"string"},"uniqueKey":"error.errors.oneOf.1.additionalProperties","typeLabel":"string[]"},"isRequired":true,"uniqueKey":"error.errors.oneOf.1","typeLabel":"object"}],"isRequired":true,"uniqueKey":"error.errors","typeLabel":"string | object"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"subscription_expired":{"title":"subscription_expired","summary":"Cancelled subscription","value":{"error":{"status":402,"message":"subscription_expired","errors":"subscription_expired"}}}},"exampleType":"examples"}},"exampleType":"examples"},"4c097b3d-159f-48b0-94b0-1df6b66ca757":{"description":"Forbidden - The token is not an API consumer token, the company has no access to the Public API, or the API consumer has no role over the affected entity (ForbiddenAccessPermissionException, raised by VerifyPublicAPIAddonIsEnabledMiddleware or by the permission check of the command / query).","content":{"application/json":{"schema":{"type":"object","description":"Error envelope produced by JsonApiResponseFactory for every non-2xx response.","required":["error"],"properties":{"error":{"type":"object","required":["status","message","errors"],"properties":{"status":{"type":"integer","description":"HTTP status code, repeated in the body","example":422,"isRequired":true,"uniqueKey":"error.status","typeLabel":"integer"},"message":{"type":"string","description":"Error message. For domain and authentication errors it is a stable error code; for request validation errors it is `Unprocessable entity`.","example":"employee_not_adjustable","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"errors":{"oneOf":[{"type":"string","description":"For domain and authentication errors, a stable error code (string) to branch on. For request validation errors, an object keyed by field name whose value is the list of messages for that field (translated into the request locale).","example":"employee_not_adjustable","isRequired":true,"uniqueKey":"error.errors.oneOf.0","typeLabel":"string"},{"type":"object","description":"For domain and authentication errors, a stable error code (string) to branch on. For request validation errors, an object keyed by field name whose value is the list of messages for that field (translated into the request locale).","example":{"employeeId":["validator.invalid_uuid"]},"additionalProperties":{"type":"array","items":{"type":"string","uniqueKey":"error.errors.oneOf.1.additionalProperties.items.[INDEX]","typeLabel":"string"},"uniqueKey":"error.errors.oneOf.1.additionalProperties","typeLabel":"string[]"},"isRequired":true,"uniqueKey":"error.errors.oneOf.1","typeLabel":"object"}],"isRequired":true,"uniqueKey":"error.errors","typeLabel":"string | object"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"forbidden_access_permission":{"title":"forbidden_access_permission","summary":"No access","value":{"error":{"status":403,"message":"Forbidden Access Permission","errors":"forbidden_access_permission"}}}},"exampleType":"examples"}},"exampleType":"examples"},"81b0e967-6946-4d32-a70e-160c1cb0df70":{"description":"Unprocessable Entity - Either the path or query string failed validation (FindEmployeeBalanceForApiValidator, shared with `GET /overtime-policies/v1/employees/{employeeId}/balance`): `employeeId` not a UUID (`validator.invalid_uuid`); `from` or `to` missing or blank (`validator.not_null`, `validator.not_blank`) or not a Y-m-d date (`validator.invalid_type`); `from` after `to`, reported on `from` (`validator.invalid_date`). `message` is `Unprocessable entity` and `errors` is an object keyed by field. The field messages listed are translation keys: the response carries their text in the request locale (the key itself when there is no translation), so branch on the field name, not on the message. Or `employee_not_adjustable`: the employee does not belong to the company of the token (EmployeeNotAdjustableException, EmployeeAdjustabilityGuard::assertReadable).","content":{"application/json":{"schema":{"type":"object","description":"Error envelope produced by JsonApiResponseFactory for every non-2xx response.","required":["error"],"properties":{"error":{"type":"object","required":["status","message","errors"],"properties":{"status":{"type":"integer","description":"HTTP status code, repeated in the body","example":422,"isRequired":true,"uniqueKey":"error.status","typeLabel":"integer"},"message":{"type":"string","description":"Error message. For domain and authentication errors it is a stable error code; for request validation errors it is `Unprocessable entity`.","example":"employee_not_adjustable","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"errors":{"oneOf":[{"type":"string","description":"For domain and authentication errors, a stable error code (string) to branch on. For request validation errors, an object keyed by field name whose value is the list of messages for that field (translated into the request locale).","example":"employee_not_adjustable","isRequired":true,"uniqueKey":"error.errors.oneOf.0","typeLabel":"string"},{"type":"object","description":"For domain and authentication errors, a stable error code (string) to branch on. For request validation errors, an object keyed by field name whose value is the list of messages for that field (translated into the request locale).","example":{"employeeId":["validator.invalid_uuid"]},"additionalProperties":{"type":"array","items":{"type":"string","uniqueKey":"error.errors.oneOf.1.additionalProperties.items.[INDEX]","typeLabel":"string"},"uniqueKey":"error.errors.oneOf.1.additionalProperties","typeLabel":"string[]"},"isRequired":true,"uniqueKey":"error.errors.oneOf.1","typeLabel":"object"}],"isRequired":true,"uniqueKey":"error.errors","typeLabel":"string | object"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"missing_dates":{"title":"missing_dates","summary":"`from`/`to` missing","value":{"error":{"status":422,"message":"Unprocessable entity","errors":{"from":["validator.not_null","validator.not_blank"],"to":["validator.not_null","validator.not_blank"]}}}},"from_after_to":{"title":"from_after_to","summary":"`from` after `to`","value":{"error":{"status":422,"message":"Unprocessable entity","errors":{"from":["validator.invalid_date"]}}}},"employee_not_adjustable":{"title":"employee_not_adjustable","summary":"Employee not in the company of the token","value":{"error":{"status":422,"message":"employee_not_adjustable","errors":"employee_not_adjustable"}}}},"exampleType":"examples"}},"exampleType":"examples"},"f08e36ed-f879-490a-bff3-ee2136ed5aba":{"description":"Too Many Requests - The company of the token exceeded the API consumer call limit (1000 calls per minute) (ApiConsumerSessionCallMaxExceededException).","content":{"application/json":{"schema":{"type":"object","description":"Error envelope produced by JsonApiResponseFactory for every non-2xx response.","required":["error"],"properties":{"error":{"type":"object","required":["status","message","errors"],"properties":{"status":{"type":"integer","description":"HTTP status code, repeated in the body","example":422,"isRequired":true,"uniqueKey":"error.status","typeLabel":"integer"},"message":{"type":"string","description":"Error message. For domain and authentication errors it is a stable error code; for request validation errors it is `Unprocessable entity`.","example":"employee_not_adjustable","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"errors":{"oneOf":[{"type":"string","description":"For domain and authentication errors, a stable error code (string) to branch on. For request validation errors, an object keyed by field name whose value is the list of messages for that field (translated into the request locale).","example":"employee_not_adjustable","isRequired":true,"uniqueKey":"error.errors.oneOf.0","typeLabel":"string"},{"type":"object","description":"For domain and authentication errors, a stable error code (string) to branch on. For request validation errors, an object keyed by field name whose value is the list of messages for that field (translated into the request locale).","example":{"employeeId":["validator.invalid_uuid"]},"additionalProperties":{"type":"array","items":{"type":"string","uniqueKey":"error.errors.oneOf.1.additionalProperties.items.[INDEX]","typeLabel":"string"},"uniqueKey":"error.errors.oneOf.1.additionalProperties","typeLabel":"string[]"},"isRequired":true,"uniqueKey":"error.errors.oneOf.1","typeLabel":"object"}],"isRequired":true,"uniqueKey":"error.errors","typeLabel":"string | object"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"api_consumer_rate_limit_exceeded":{"title":"api_consumer_rate_limit_exceeded","summary":"Rate limit exceeded","value":{"error":{"status":429,"message":"Api consumer rate limit exceeded","errors":"api_consumer_rate_limit_exceeded"}}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"a8bc11b5-709f-4651-907e-ca2de12de754":{"Bearer":{"type":"http","scheme":"bearer","bearerFormat":"JWT","scopes":[],"schemeName":"Bearer"}}},"servers":{"80dd7ad3-bce0-4217-bd70-4335da38c420":{"url":"https://api-{region}.sesametime.com","variables":{"region":{"default":"eu1"}}}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","bearerFormat":"JWT","scopes":[],"schemeName":"Bearer"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Bearer authentication header of the form `Bearer \u003ctoken>`, where `\u003ctoken>` is your auth token.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"Bearer","name":"Authorization"}],"title":"Bearer"}]},"originalFileLocation":"openapi.json"},"subdomain":"sesanelabssl","siteName":"Sesame HR API","title":"Get the rest-compensable balance of an employee - Sesame HR API","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-09T11:46:37.711Z","originalFileLocation":"api-reference/getemployeerestcompensablebalance.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=\"light\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Returns the balance of the employee employeeId that can be compensated with rest over the from-to period, per source, in seconds. It is the value POST /overtime-policies/v1/compensations/rest checks balanceBeforeSeconds against: read it right before that request, with the same from/to, and send the value of the key matching the source (positive_balance for positive_balance, negative_balance for negative_balance, total_balance otherwise). Only closed days count (up to yesterday), and time to be remunerated, time already compensated and expired time are excluded, so it drops after every compensation and a replayed request is rejected with 409 compensable_balance_changed. A reset adjustment zeroes it as of the moment it is made, except that time expired before the reset still reduces it afterwards. It differs from GET /overtime-policies/v1/employees/{employeeId}/balance, which is the balance adjustments are checked against. The employee must belong to the company of the token. The read permission is checked over the employee before the lookup: an employee the API consumer has no role over answers 403. When the permission passes, as it does for a company-wide API consumer, an id that is not an employee of the company of the token (including an unknown id) answers 422 employee_not_adjustable.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Sesame HR API\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/sesanelabssl/Fdu8Z-5mpMhk_iaZ/_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/sesanelabssl/Fdu8Z-5mpMhk_iaZ/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/sesanelabssl/Fdu8Z-5mpMhk_iaZ/_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/sesanelabssl/Fdu8Z-5mpMhk_iaZ/_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/sesanelabssl/Fdu8Z-5mpMhk_iaZ/_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/sesanelabssl/Fdu8Z-5mpMhk_iaZ/_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/sesanelabssl/Fdu8Z-5mpMhk_iaZ/_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/sesanelabssl/Fdu8Z-5mpMhk_iaZ/_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/sesanelabssl/Fdu8Z-5mpMhk_iaZ/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Get the rest-compensable balance of an employee - Sesame HR API\">\u003cmeta data-mint-head property=\"og:description\" content=\"Returns the balance of the employee employeeId that can be compensated with rest over the from-to period, per source, in seconds. It is the value POST /overtime-policies/v1/compensations/rest checks balanceBeforeSeconds against: read it right before that request, with the same from/to, and send the value of the key matching the source (positive_balance for positive_balance, negative_balance for negative_balance, total_balance otherwise). Only closed days count (up to yesterday), and time to be remunerated, time already compensated and expired time are excluded, so it drops after every compensation and a replayed request is rejected with 409 compensable_balance_changed. A reset adjustment zeroes it as of the moment it is made, except that time expired before the reset still reduces it afterwards. It differs from GET /overtime-policies/v1/employees/{employeeId}/balance, which is the balance adjustments are checked against. The employee must belong to the company of the token. The read permission is checked over the employee before the lookup: an employee the API consumer has no role over answers 403. When the permission passes, as it does for a company-wide API consumer, an id that is not an employee of the company of the token (including an unknown id) answers 422 employee_not_adjustable.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Sesame HR API\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://apidocs.sesametime.com/api-reference/getemployeerestcompensablebalance\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://sesanelabssl.mintlify.site/_mintlify/api/og/v2?division=Overtime+Policies\u0026amp;title=Get+the+rest-compensable+balance+of+an+employee\u0026amp;description=Returns+the+balance+of+the+employee+%60employeeId%60+that+can+be+compensated+with+rest+over+the+%60from%60-%60to%60+period%2C+per+source%2C+in+seconds.+It+is+the+value+%60POST+%2Fo\u0026amp;theme=04d37b22239f766ea8b37b90\u0026amp;signature=661ded809258495a626fe8f01191f7a1c3b5608a984bd05ff835895c4fb0ad45\">\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=\"Get the rest-compensable balance of an employee - Sesame HR API\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Returns the balance of the employee employeeId that can be compensated with rest over the from-to period, per source, in seconds. It is the value POST /overtime-policies/v1/compensations/rest checks balanceBeforeSeconds against: read it right before that request, with the same from/to, and send the value of the key matching the source (positive_balance for positive_balance, negative_balance for negative_balance, total_balance otherwise). Only closed days count (up to yesterday), and time to be remunerated, time already compensated and expired time are excluded, so it drops after every compensation and a replayed request is rejected with 409 compensable_balance_changed. A reset adjustment zeroes it as of the moment it is made, except that time expired before the reset still reduces it afterwards. It differs from GET /overtime-policies/v1/employees/{employeeId}/balance, which is the balance adjustments are checked against. The employee must belong to the company of the token. The read permission is checked over the employee before the lookup: an employee the API consumer has no role over answers 403. When the permission passes, as it does for a company-wide API consumer, an id that is not an employee of the company of the token (including an unknown id) answers 422 employee_not_adjustable.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://sesanelabssl.mintlify.site/_mintlify/api/og/v2?division=Overtime+Policies\u0026amp;title=Get+the+rest-compensable+balance+of+an+employee\u0026amp;description=Returns+the+balance+of+the+employee+%60employeeId%60+that+can+be+compensated+with+rest+over+the+%60from%60-%60to%60+period%2C+per+source%2C+in+seconds.+It+is+the+value+%60POST+%2Fo\u0026amp;theme=04d37b22239f766ea8b37b90\u0026amp;signature=661ded809258495a626fe8f01191f7a1c3b5608a984bd05ff835895c4fb0ad45\">\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/sesanelabssl/Fdu8Z-5mpMhk_iaZ/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Sesame HR API\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#1F2D52\">\u003clink data-mint-head rel=\"canonical\" href=\"https://apidocs.sesametime.com/api-reference/getemployeerestcompensablebalance\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/getemployeerestcompensablebalance.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://apidocs.sesametime.com/#organization\",\"name\":\"Sesame HR API\",\"url\":\"https://apidocs.sesametime.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/sesanelabssl/zP97BBsaqG7vDc2J/images/logo-light.svg?fit=max\u0026auto=format\u0026n=zP97BBsaqG7vDc2J\u0026q=85\u0026s=771054c1315d6cbe9d409449d51dbbc0\"}},{\"@type\":\"WebSite\",\"@id\":\"https://apidocs.sesametime.com#website\",\"name\":\"Sesame HR API\",\"url\":\"https://apidocs.sesametime.com\",\"publisher\":{\"@id\":\"https://apidocs.sesametime.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://apidocs.sesametime.com/api-reference/getemployeerestcompensablebalance#webpage\",\"url\":\"https://apidocs.sesametime.com/api-reference/getemployeerestcompensablebalance\",\"name\":\"Get the rest-compensable balance of an employee\",\"description\":\"Returns the balance of the employee employeeId that can be compensated with rest over the from-to period, per source, in seconds. It is the value POST /overtime-policies/v1/compensations/rest checks balanceBeforeSeconds against: read it right before that request, with the same from/to, and send the value of the key matching the source (positive_balance for positive_balance, negative_balance for negative_balance, total_balance otherwise). Only closed days count (up to yesterday), and time to be remunerated, time already compensated and expired time are excluded, so it drops after every compensation and a replayed request is rejected with 409 compensable_balance_changed. A reset adjustment zeroes it as of the moment it is made, except that time expired before the reset still reduces it afterwards. It differs from GET /overtime-policies/v1/employees/{employeeId}/balance, which is the balance adjustments are checked against. The employee must belong to the company of the token. The read permission is checked over the employee before the lookup: an employee the API consumer has no role over answers 403. When the permission passes, as it does for a company-wide API consumer, an id that is not an employee of the company of the token (including an unknown id) answers 422 employee_not_adjustable.\",\"dateModified\":\"2026-11-09T11:46:37.711Z\",\"isPartOf\":{\"@id\":\"https://apidocs.sesametime.com#website\"},\"breadcrumb\":{\"@id\":\"https://apidocs.sesametime.com/api-reference/getemployeerestcompensablebalance#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://apidocs.sesametime.com/api-reference/getemployeerestcompensablebalance#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"API Reference\",\"item\":\"https://apidocs.sesametime.com/api-reference/legacy-introduction\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Overtime Policies\",\"item\":\"https://apidocs.sesametime.com/api-reference/createovertimebalanceadjustment\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Get the rest-compensable balance of an employee\",\"item\":\"https://apidocs.sesametime.com/api-reference/getemployeerestcompensablebalance\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://apidocs.sesametime.com/api-reference/getemployeerestcompensablebalance#apireference\",\"headline\":\"Get the rest-compensable balance of an employee\",\"name\":\"Get the rest-compensable balance of an employee\",\"description\":\"Returns the balance of the employee employeeId that can be compensated with rest over the from-to period, per source, in seconds. It is the value POST /overtime-policies/v1/compensations/rest checks balanceBeforeSeconds against: read it right before that request, with the same from/to, and send the value of the key matching the source (positive_balance for positive_balance, negative_balance for negative_balance, total_balance otherwise). Only closed days count (up to yesterday), and time to be remunerated, time already compensated and expired time are excluded, so it drops after every compensation and a replayed request is rejected with 409 compensable_balance_changed. A reset adjustment zeroes it as of the moment it is made, except that time expired before the reset still reduces it afterwards. It differs from GET /overtime-policies/v1/employees/{employeeId}/balance, which is the balance adjustments are checked against. The employee must belong to the company of the token. The read permission is checked over the employee before the lookup: an employee the API consumer has no role over answers 403. When the permission passes, as it does for a company-wide API consumer, an id that is not an employee of the company of the token (including an unknown id) answers 422 employee_not_adjustable.\",\"url\":\"https://apidocs.sesametime.com/api-reference/getemployeerestcompensablebalance\",\"mainEntityOfPage\":{\"@id\":\"https://apidocs.sesametime.com/api-reference/getemployeerestcompensablebalance#webpage\"},\"dateModified\":\"2026-11-09T11:46:37.711Z\",\"publisher\":{\"@id\":\"https://apidocs.sesametime.com/#organization\"},\"isPartOf\":{\"@id\":\"https://apidocs.sesametime.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Sesame HR API\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Sesame HR API\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/getemployeerestcompensablebalance.md","siteName":"Sesame HR API","nav":{"global":null,"tabs":[{"tab":"Getting Started","pages":[{"title":"Getting Started","href":"/introduction"}]},{"tab":"API Reference","pages":[{"title":"API Reference","href":"/api-reference-v2/core/v4/employees-employee-id-complementary-trainings-get"}]},{"tab":"API Legacy","groups":[{"group":"API Reference","pages":[{"title":"API Reference","href":"/api-reference/legacy-introduction"},{"group":"Security","pages":[{"title":"Show Token Info","openapi":"GET /core/v3/info","href":"/api-reference/showtokeninfo"}]},{"group":"Company","pages":[{"title":"Update a company","openapi":"PUT /core/v3/companies/{id}","href":"/api-reference/updatecompany"}]},{"group":"Employees","pages":[{"title":"Create an employee","openapi":"POST /core/v3/employees","href":"/api-reference/createemployee"},{"title":"List employees","openapi":"GET /core/v3/employees","href":"/api-reference/listemployees"},{"title":"Get an employee","openapi":"GET /core/v3/employees/{id}","href":"/api-reference/getemployee"},{"title":"Update an employee","openapi":"PUT /core/v3/employees/{id}","href":"/api-reference/updateemployee"},{"title":"Delete an employee","openapi":"DELETE /core/v3/employees/{id}","href":"/api-reference/deleteemployee"}]},{"group":"Job Charges","pages":[{"title":"Create a job charge","openapi":"POST /core/v3/job-charges","href":"/api-reference/createjobcharge"},{"title":"List job charges","openapi":"GET /core/v3/job-charges","href":"/api-reference/listjobcharges"},{"title":"Get a job charge","openapi":"GET /core/v3/job-charges/{jobChargeId}","href":"/api-reference/retrievejobcharge"},{"title":"Update a job charge","openapi":"PUT /core/v3/job-charges/{jobChargeId}","href":"/api-reference/updatejobcharge"},{"title":"Delete a job charge","openapi":"DELETE /core/v3/job-charges/{jobChargeId}","href":"/api-reference/deletejobchargein"}]},{"group":"Employee Profiles","pages":[{"title":"Get organization chart manager by employee id","openapi":"GET /core/v3/employee-profiles/organization-chart-managers/{employeeId}","href":"/api-reference/getmanagerbyemployeeid"},{"title":"Update organization chart manager by employee id","openapi":"PUT /core/v3/employee-profiles/organization-chart-managers/{employeeId}","href":"/api-reference/updatemanagerbyemployeeid"}]},{"group":"Employee Image Profiles","pages":[{"title":"Upload the profile picture (avatar) of an employee","openapi":"POST /core/v3/employees/{employeeId}/image-profile","href":"/api-reference/uploademployeeimageprofile"},{"title":"Delete the profile picture (avatar) of an employee","openapi":"DELETE /core/v3/employees/{employeeId}/image-profile","href":"/api-reference/deleteemployeeimageprofile"}]},{"group":"Employee Managers","pages":[{"title":"Assign an employee manager","openapi":"POST /core/v3/employee-managers","href":"/api-reference/assignemployeemanager"},{"title":"List employee managers","openapi":"GET /core/v3/employee-managers","href":"/api-reference/listemployeemanagers"},{"title":"Update an employee manager","openapi":"PUT /core/v3/employee-managers/{id}","href":"/api-reference/updateemployeemanager"},{"title":"Delete an employee manager","openapi":"DELETE /core/v3/employee-managers/{id}","href":"/api-reference/deleteemployeemanager"}]},{"group":"Roles","pages":[{"title":"List Roles","openapi":"GET /core/v3/roles","href":"/api-reference/listroles"}]},{"group":"Employee Assignations Roles","pages":[{"title":"List Assignations Roles by Employee","openapi":"GET /core/v3/roles/assignation/{employeeId}","href":"/api-reference/listrolesbyemployee"},{"title":"Assign Role","openapi":"POST /core/v3/roles/assignation","href":"/api-reference/assignroles"},{"title":"Unassign Role","openapi":"DELETE /core/v3/roles/assignation","href":"/api-reference/unassignroles"}]},{"group":"Departments","pages":[{"title":"Create a department","openapi":"POST /core/v3/departments","href":"/api-reference/createdepartment"},{"title":"List departments","openapi":"GET /core/v3/departments","href":"/api-reference/listdepartments"},{"title":"Update a department","openapi":"PUT /core/v3/departments/{id}","href":"/api-reference/updatedepartment"},{"title":"Delete a department","openapi":"DELETE /core/v3/departments/{id}","href":"/api-reference/deletedepartment"}]},{"group":"Employee Department Assignations","pages":[{"title":"List employee department assignation","openapi":"GET /core/v3/employee-department-assignations","href":"/api-reference/listemployeedepartmentassignations"},{"title":"Assign an employee to a department","openapi":"POST /core/v3/employee-department-assignations","href":"/api-reference/assignemployeetodepartment"},{"title":"Unassign employee from department","openapi":"DELETE /core/v3/employee-department-assignations","href":"/api-reference/unassignemployeefromdepartments"}]},{"group":"Offices","pages":[{"title":"Create an office","openapi":"POST /core/v3/offices","href":"/api-reference/createoffice"},{"title":"List offices","openapi":"GET /core/v3/offices","href":"/api-reference/listoffices"},{"title":"Retrieve an office","openapi":"GET /core/v3/offices/{id}","href":"/api-reference/retrieveoffice"},{"title":"Update an office","openapi":"PUT /core/v3/offices/{id}","href":"/api-reference/updateoffice"},{"title":"Delete an office","openapi":"DELETE /core/v3/offices/{id}","href":"/api-reference/deleteoffice"}]},{"group":"Locations","pages":[{"title":"List locations","openapi":"GET /core/v3/locations","href":"/api-reference/listlocations"},{"title":"Create a location","openapi":"POST /core/v3/locations","href":"/api-reference/createlocation"},{"title":"Retrieve a location","openapi":"GET /core/v3/locations/{id}","href":"/api-reference/retrievelocation"},{"title":"Update a location","openapi":"PUT /core/v3/locations/{id}","href":"/api-reference/updatelocation"},{"title":"Delete a location","openapi":"DELETE /core/v3/locations/{id}","href":"/api-reference/deletelocation"}]},{"group":"Employee Office Assignations","pages":[{"title":"List employee office assignation","openapi":"GET /core/v3/employee-office-assignations","href":"/api-reference/listemployeeofficeassignations"},{"title":"Assign an employee to an office","openapi":"POST /core/v3/employee-office-assignations","href":"/api-reference/assignemployeetooffice"},{"title":"Unassign employee from office","openapi":"DELETE /core/v3/employee-office-assignations","href":"/api-reference/unassignemployeefromoffices"},{"title":"Update an employee office assignation","openapi":"PUT /core/v3/employee-office-assignations/{id}","href":"/api-reference/updateemployeeofficeassignation"}]},{"group":"Custom Fields","pages":[{"title":"Create a custom field","openapi":"POST /core/v3/custom-fields","href":"/api-reference/createcustomfield"},{"title":"List custom fields","openapi":"GET /core/v3/custom-fields","href":"/api-reference/listcustomfields"},{"title":"Update a custom field","openapi":"PUT /core/v3/custom-fields/{id}","href":"/api-reference/updatecustomfield"},{"title":"Delete a custom field","openapi":"DELETE /core/v3/custom-fields/{id}","href":"/api-reference/deletecustomfield"}]},{"group":"Entity Groups","pages":[{"title":"List entity groups","openapi":"GET /core/v3/entity-groups","href":"/api-reference/retrieveentitygroups"},{"title":"Create an entity group","openapi":"POST /core/v3/entity-groups","href":"/api-reference/createentitygroup"},{"title":"Update a group","openapi":"PUT /core/v3/entity-groups/{entityGroupId}","href":"/api-reference/updategroup"},{"title":"Delete an entity group","openapi":"DELETE /core/v3/entity-groups/{entityGroupId}","href":"/api-reference/deletegroup"}]},{"group":"Entity Group Assignations","pages":[{"title":"Assign employees to an entity group","openapi":"POST /core/v3/entity-group-assignation","href":"/api-reference/assignemployeetogroup"},{"title":"Unassign employee from an entity group","openapi":"DELETE /core/v3/entity-group-assignation","href":"/api-reference/unassignemployeefromgroup"}]},{"group":"Location Assignations","pages":[{"title":"List location assignations","openapi":"GET /core/v3/location-assignations","href":"/api-reference/listlocationassignations"},{"title":"Assign a location to an entity","openapi":"POST /core/v3/location-assignations","href":"/api-reference/assignlocationtoentity"},{"title":"Unassign a location from an entity","openapi":"DELETE /core/v3/location-assignations","href":"/api-reference/unassignlocationfromentity"}]},{"group":"Entity Group Owners Assignations","pages":[{"title":"List owners of an entity group","openapi":"GET /core/v3/entity-group-owners-assignation","href":"/api-reference/listgroupowners"},{"title":"Assign an owner to an entity group","openapi":"POST /core/v3/entity-group-owners-assignation","href":"/api-reference/assignownertogroup"},{"title":"Unassign employee to own the entity group ","openapi":"DELETE /core/v3/entity-group-owners-assignation","href":"/api-reference/unassignownerfromgroup"}]},{"group":"Configurations","pages":[{"title":"Get available check origins configuration","openapi":"GET /core/v3/configurations/available-check-origin","href":"/api-reference/getavailablecheckorigins"},{"title":"Create or update available check origins configuration","openapi":"PUT /core/v3/configurations/available-check-origin","href":"/api-reference/createorupdateavailablecheckorigins"}]},{"group":"Work Entries","pages":[{"title":"Automatic clock-in or clock-out based on current status","openapi":"POST /schedule/v1/work-entries/clock","href":"/api-reference/clock"},{"title":"Starts a new work entry right now","openapi":"POST /schedule/v1/work-entries/clock-in","href":"/api-reference/clockin"},{"title":"Ends the last work entry","openapi":"POST /schedule/v1/work-entries/clock-out","href":"/api-reference/clockout"},{"title":"Create Work Entry","openapi":"POST /schedule/v1/work-entries","href":"/api-reference/createworkentry"},{"title":"List Company Work Entries","openapi":"GET /schedule/v1/work-entries","href":"/api-reference/listworkentries"},{"title":"Update Work Entry","openapi":"PUT /schedule/v1/work-entries/{id}","href":"/api-reference/updateworkentry"},{"title":"Partial Update Work Entry","openapi":"PATCH /schedule/v1/work-entries/{id}","href":"/api-reference/patchworkentry"},{"title":"Delete Work Entry","openapi":"DELETE /schedule/v1/work-entries/{id}","href":"/api-reference/deleteworkentry"}]},{"group":"Check Types","pages":[{"title":"List Check Types","openapi":"GET /schedule/v1/check-types","href":"/api-reference/listchecktypes"},{"title":"Create Check Type","openapi":"POST /schedule/v1/check-types","href":"/api-reference/createchecktype"}]},{"group":"Check Type Collections","pages":[{"title":"List Check Type Collections","openapi":"GET /schedule/v1/check-type-collections","href":"/api-reference/listchecktypecollection"},{"title":"Retrieve a Check Type Collection by Id","openapi":"GET /schedule/v1/check-type-collections/{checkTypeCollectionId}","href":"/api-reference/retrievechecktypecollection"}]},{"group":"Work Breaks","pages":[{"title":"List Work Breaks","openapi":"GET /schedule/v1/work-breaks","href":"/api-reference/listworkbreaks"}]},{"group":"Check Validation","pages":[{"title":"List Check Validation By Employees and Status","openapi":"GET /schedule/v1/check-validation","href":"/api-reference/listcheckvalidations"}]},{"group":"Check Incidences","pages":[{"title":"List Company Check Incidences","openapi":"GET /schedule/v1/check-incidences","href":"/api-reference/listcheckincidences"},{"title":"Bulk Update Check Incidences","openapi":"PUT /schedule/v1/check-incidences","href":"/api-reference/bulkupdatecheckincidences"},{"title":"Update Check Incidence","openapi":"PUT /schedule/v1/check-incidences/{checkIncidenceId}","href":"/api-reference/updatecheckincidence"},{"title":"Get Employee Check Incidences","openapi":"GET /schedule/v1/check-incidences/employees/{employeeId}","href":"/api-reference/getemployeecheckincidences"},{"title":"Send Notifications for Check Incidences","openapi":"POST /schedule/v1/check-incidences/send-notifications","href":"/api-reference/sendcheckincidencenotifications"}]},{"group":"Statistics","pages":[{"title":"List Worked Hours By Employee","openapi":"GET /schedule/v1/reports/worked-hours","href":"/api-reference/workedhoursbyemployee"},{"title":"List Worked Hours By Employee and Week Day","openapi":"GET /schedule/v1/reports/worked-hours-by-week-day","href":"/api-reference/workedhoursbyemployeeandweekday"},{"title":"List Worked Hours By Employee In Night Hours","openapi":"GET /schedule/v1/reports/worked-night-hours","href":"/api-reference/workednighthoursbyemployee"},{"title":"List Worked Absence Days By Employee","openapi":"GET /schedule/v1/reports/worked-absence-days","href":"/api-reference/workedholidaydaysbyemployee"}]},{"group":"Vacation Configurations","pages":[{"title":"Creates a new vacation configuration","openapi":"POST /schedule/v1/vacation-configurations","href":"/api-reference/createvacationconfiguration"},{"title":"List Vacation Configurations","openapi":"GET /schedule/v1/vacation-configurations","href":"/api-reference/listvacationconfigurations"},{"title":"Retrieve a vacation configuration","openapi":"GET /schedule/v1/vacation-configurations/{vacationConfigurationId}","href":"/api-reference/retrievevacationconfiguration"},{"title":"Updates a vacation configuration","openapi":"PUT /schedule/v1/vacation-configurations/{vacationConfigurationId}","href":"/api-reference/updatevacationconfiguration"},{"title":"Deletes a vacation configuration","openapi":"DELETE /schedule/v1/vacation-configurations/{vacationConfigurationId}","href":"/api-reference/deletevacationconfiguration"}]},{"group":"Vacation Configurations Assignations","pages":[{"title":"Retrieve employees assigned to a vacation configuration","openapi":"GET /schedule/v1/vacation-configurations-assignations/{vacationConfigurationId}","href":"/api-reference/retrieveemployeesassignedtovacationconfiguration"},{"title":"Assigns a vacation configuration to an employee","openapi":"POST /schedule/v1/vacation-configurations-assignations/{vacationConfigurationId}","href":"/api-reference/assignvacationconfigurationtoemployee"}]},{"group":"Vacation Calendars","pages":[{"title":"List Vacation Calendars","openapi":"GET /schedule/v1/vacation-calendars","href":"/api-reference/listvacationcalendars"},{"title":"Create Vacation Calendar","openapi":"POST /schedule/v1/vacation-calendars","href":"/api-reference/createvacationcalendar"},{"title":"Create empty vacation calendar","openapi":"POST /schedule/v1/vacation-calendars/create","href":"/api-reference/createemptyvacationcalendar"},{"title":"Add days off to vacation calendar","openapi":"POST /schedule/v1/vacation-calendars/days-off","href":"/api-reference/adddaysofftovacationcalendar"},{"title":"Update Vacation Calendar","openapi":"PUT /schedule/v1/vacation-calendars/{id}","href":"/api-reference/updatevacationcalendar"},{"title":"Delete Days Off from Vacation Calendar","openapi":"DELETE /schedule/v1/vacation-calendars/{id}/days-off","href":"/api-reference/deletedaysofffromvacationcalendar"}]},{"group":"Vacation Calendar Totals","pages":[{"title":"Retrieve Vacation Calendar Totals","openapi":"GET /schedule/v1/vacation-calendar-totals","href":"/api-reference/retrievevacationcalendartotals"}]},{"group":"Calendar Max Day Off Adjustments","pages":[{"title":"Create Calendar Max Day Off Adjustment","openapi":"POST /schedule/v1/vacation-calendar/calendar/{calendarId}/adjustment","href":"/api-reference/createcalendarmaxdayoffadjustment"},{"title":"Get Calendar Max Day Off Adjustments","openapi":"GET /schedule/v1/vacation-calendar/calendar/{calendarId}/adjustment","href":"/api-reference/getcalendarmaxdayoffadjustments"},{"title":"Delete Calendar Max Day Off Adjustment","openapi":"DELETE /schedule/v1/vacation-calendar/calendar/{calendarId}/adjustment/{adjustmentId}","href":"/api-reference/deletecalendarmaxdayoffadjustment"}]},{"group":"Calendar Max Day Off Accumulated","pages":[{"title":"List Calendar Max Day Off Accumulated","openapi":"GET /schedule/v1/calendar-max-day-off-accumulated/{calendarId}","href":"/api-reference/listcalendarmaxdayoffaccumulated"}]},{"group":"Vacation Day Off","pages":[{"title":"List Vacation Day Off","openapi":"GET /schedule/v1/vacation-day-off","href":"/api-reference/listvacationdayoff"}]},{"group":"Vacation Day Off Requests","pages":[{"title":"Create Vacation Day Off Request","openapi":"POST /schedule/v1/vacation-day-off-requests","href":"/api-reference/createvacationdayoffrequest"},{"title":"List Vacation Day Off Requests","openapi":"GET /schedule/v1/vacation-day-off-requests","href":"/api-reference/listvacationdayoffrequests"},{"title":"Accept Vacation Day Off Request","openapi":"POST /schedule/v1/vacation-day-off-requests/{id}/accept","href":"/api-reference/acceptvacationdayoffrequest"},{"title":"Reject Vacation Day Off Request","openapi":"POST /schedule/v1/vacation-day-off-requests/{id}/reject","href":"/api-reference/rejectvacationdayoffrequest"},{"title":"Delete Vacation Day Off Request","openapi":"DELETE /schedule/v1/vacation-day-off-requests/{id}","href":"/api-reference/deletevacationdayoffrequest"}]},{"group":"Absence Types","pages":[{"title":"List Absence Types","openapi":"GET /schedule/v1/absence-types","href":"/api-reference/listabsencetypes"},{"title":"List hours compensation absence types available for employees","openapi":"GET /schedule/v1/employees/available-hours-compensation-types","href":"/api-reference/listavailablehourscompensationtypes"}]},{"group":"Absence Calendars","pages":[{"title":"List Absence Calendars","openapi":"GET /schedule/v1/absence-calendars","href":"/api-reference/listabsencecalendars"},{"title":"Create Absence Calendar","openapi":"POST /schedule/v1/absence-calendars","href":"/api-reference/createabsencecalendar"},{"title":"Update Absence Calendar","openapi":"PUT /schedule/v1/absence-calendars/{id}","href":"/api-reference/updateabsencecalendar"}]},{"group":"Absence Day Off","pages":[{"title":"List Absence Day Off","openapi":"GET /schedule/v1/absence-day-off","href":"/api-reference/listabsencedayoff"},{"title":"Delete Absence Days Off from Calendar","openapi":"DELETE /schedule/v1/absence-day-off/{calendarId}","href":"/api-reference/deleteabsencedaysofffromvacationcalendar"}]},{"group":"Absence Day Off Requests","pages":[{"title":"Create Absence Day Off Request","openapi":"POST /schedule/v1/absence-day-off-requests","href":"/api-reference/createabsencedayoffrequest"},{"title":"List Absence Day Off Requests","openapi":"GET /schedule/v1/absence-day-off-requests","href":"/api-reference/listabsencedayoffrequests"},{"title":"Accept Absence Day Off Request","openapi":"POST /schedule/v1/absence-day-off-requests/{id}/accept","href":"/api-reference/acceptabsencedayoffrequest"},{"title":"Reject Absence Day Off Request","openapi":"POST /schedule/v1/absence-day-off-requests/{id}/reject","href":"/api-reference/rejectabsencedayoffrequest"},{"title":"Delete Absence Day Off Request","openapi":"DELETE /schedule/v1/absence-day-off-requests/{id}","href":"/api-reference/deleteabsencedayoffrequest"}]},{"group":"Holiday Calendars","pages":[{"title":"List Holidays Calendar","openapi":"GET /schedule/v1/holiday-calendar","href":"/api-reference/listholidayscalendar"},{"title":"Create Holidays Calendar","openapi":"POST /schedule/v1/holiday-calendar","href":"/api-reference/createholidayscalendar"},{"title":"List Holiday Calendar","openapi":"GET /schedule/v1/holiday-calendar/{holidayCalendarId}","href":"/api-reference/listholidaycalendar"},{"title":"Update Holidays Calendar","openapi":"PUT /schedule/v1/holiday-calendar/{holidayCalendarId}","href":"/api-reference/updateholidayscalendar"},{"title":"Delete Holidays Calendar","openapi":"DELETE /schedule/v1/holiday-calendar/{holidayCalendarId}","href":"/api-reference/deleteholidayscalendar"}]},{"group":"Holidays","pages":[{"title":"List Holidays","openapi":"GET /schedule/v1/holidays","href":"/api-reference/listholidays"},{"title":"Get Employees By Holiday Calendar","openapi":"GET /schedule/v1/holidays/{holidayCalendarId}/employees","href":"/api-reference/getemployeesbyholidaycalendar"},{"title":"Assign Holiday Calendar To Employee","openapi":"POST /schedule/v1/holidays/{holidayCalendarId}/employees","href":"/api-reference/assignholidaycalendartoemployee"},{"title":"Unassign Holiday Calendar To Employee","openapi":"DELETE /schedule/v1/holidays/{holidayCalendarId}/employees","href":"/api-reference/unassignholidaycalendartoemploye"}]},{"group":"Worked holidays","pages":[{"title":"List Worked Holidays","openapi":"GET /schedule/v1/worked-holidays","href":"/api-reference/listworkedholidays"},{"title":"Create a worked holiday for an employee","openapi":"POST /schedule/v1/worked-holidays","href":"/api-reference/createworkedholiday"},{"title":"Delete Worked Holiday for an employee","openapi":"DELETE /schedule/v1/worked-holidays/{workedHolidayId}","href":"/api-reference/deleteworkedholiday"}]},{"group":"Schedule Templates","pages":[{"title":"List schedule templates","openapi":"GET /schedule/v1/schedule-templates","href":"/api-reference/listscheduletemplates"}]},{"group":"Employee Schedule Templates","pages":[{"title":"List employee schedule template","openapi":"GET /schedule/v1/employees/{employeeId}/schedule-templates","href":"/api-reference/listemployeescheduletemplate"},{"title":"List employee's entity schedule templates","openapi":"GET /schedule/v1/employees/{employeeId}/entity-schedule-templates","href":"/api-reference/listemployeeentityscheduletemplates"},{"title":"Create employee schedule template","openapi":"POST /schedule/v1/entity-schedule-templates","href":"/api-reference/createentityscheduletemplate"},{"title":"Delete employee schedule template","openapi":"DELETE /schedule/v1/entity-schedule-templates/{entityScheduleTemplateId}","href":"/api-reference/deleteentityscheduletemplate"}]},{"group":"Agreements","pages":[{"title":"List agreements","openapi":"GET /schedule/v1/agreements","href":"/api-reference/listagreements"},{"title":"Create an agreement","openapi":"POST /schedule/v1/agreements","href":"/api-reference/createagreement"},{"title":"Get agreement","openapi":"GET /schedule/v1/agreements/{agreementId}","href":"/api-reference/getagreement"},{"title":"Update an agreement","openapi":"PUT /schedule/v1/agreements/{agreementId}","href":"/api-reference/updateagreement"},{"title":"Delete agreement","openapi":"DELETE /schedule/v1/agreements/{agreementId}","href":"/api-reference/deleteagreement"}]},{"group":"Employee Agreements","pages":[{"title":"Create employee agreement","openapi":"POST /schedule/v1/agreement-employees","href":"/api-reference/createemployeeagreement"},{"title":"Delete employee agreement","openapi":"DELETE /schedule/v1/agreement-employees/{agreementEmployeeId}","href":"/api-reference/deleteemployeeagreement"}]},{"group":"Contracts","pages":[{"title":"Get contracts by employee","openapi":"GET /contract/v1/contracts/{employeeId}","href":"/api-reference/getcontractsemployee"},{"title":"Create a contract","openapi":"POST /contract/v1/contracts","href":"/api-reference/createcontract"},{"title":"Get contract payrolls","openapi":"GET /contract/v1/contracts/contracts-for-payroll","href":"/api-reference/contractpayrolls"},{"title":"Update a contract","openapi":"PUT /contract/v1/contracts/{contractId}","href":"/api-reference/updatecontract"},{"title":"Delete a contract","openapi":"DELETE /contract/v1/contracts/{contractId}","href":"/api-reference/deletecontract"},{"title":"Get current contract by employeeId","openapi":"GET /contract/v1/contracts/{employeeId}/current-contract","href":"/api-reference/currentcontract"},{"title":"Create an employee leave","openapi":"POST /contract/v1/employee-leave/employees/{employeeId}","href":"/api-reference/createemployeeleave"}]},{"group":"Job Charges For Contracts","pages":[{"title":"Create a job charge","openapi":"POST /contract/v1/job-charges","href":"/api-reference/createjobchargeincontract"},{"title":"List job charges","openapi":"GET /contract/v1/job-charges","href":"/api-reference/listjobchargesincontract"},{"title":"Get a job charge in contract","openapi":"GET /contract/v1/job-charges/{jobChargeId}","href":"/api-reference/retrievejobchargeincontract"},{"title":"Update a job charge in contract","openapi":"PUT /contract/v1/job-charges/{jobChargeId}","href":"/api-reference/updatejobchargeincontract"},{"title":"Delete a job charge in contract","openapi":"DELETE /contract/v1/job-charges/{jobChargeId}","href":"/api-reference/deletejobchargeincontract"}]},{"group":"Contract Types","pages":[{"title":"Create a contract type","openapi":"POST /contract/v1/contract-types","href":"/api-reference/createcontracttype"},{"title":"List contract types","openapi":"GET /contract/v1/contract-types","href":"/api-reference/listcontracttypes"},{"title":"Get a contract type","openapi":"GET /contract/v1/contract-types/{contractTypeId}","href":"/api-reference/getcontracttypes"},{"title":"Update a contract type","openapi":"PUT /contract/v1/contract-types/{contractTypeId}","href":"/api-reference/updatecontracttype"},{"title":"Delete a contract type","openapi":"DELETE /contract/v1/contract-types/{contractTypeId}","href":"/api-reference/deletecontracttype"}]},{"group":"Contract Terminated","pages":[{"title":"Get contract terminated details","openapi":"GET /contract/v1/contract-terminated/{contractId}","href":"/api-reference/getcontractterminateddetails"}]},{"group":"Salaries","pages":[{"title":"List Contribution Groups","openapi":"GET /contract/v1/contribution-groups","href":"/api-reference/listcontributiongroups"},{"title":"List Salaries","openapi":"GET /contract/v1/salaries","href":"/api-reference/listsalaries"},{"title":"Create Salary","openapi":"POST /contract/v1/salaries","href":"/api-reference/createsalary"},{"title":"Update a salary","openapi":"PUT /contract/v1/salaries/{salaryId}","href":"/api-reference/updatesalary"},{"title":"Delete a salary","openapi":"DELETE /contract/v1/salaries/{salaryId}","href":"/api-reference/deletesalary"}]},{"group":"Degrees","pages":[{"title":"Create a degree","openapi":"POST /contract/v1/degrees","href":"/api-reference/createdegreeincontract"},{"title":"List degrees","openapi":"GET /contract/v1/degrees","href":"/api-reference/listdegreesincontract"},{"title":"Get a degree","openapi":"GET /contract/v1/degrees/{degreeId}","href":"/api-reference/getdegreeincontract"},{"title":"Update a degree","openapi":"PUT /contract/v1/degrees/{degreeId}","href":"/api-reference/updatedegreeincontract"},{"title":"Delete a degree","openapi":"DELETE /contract/v1/degrees/{degreeId}","href":"/api-reference/deletedegreeincontract"}]},{"group":"Workday Types","pages":[{"title":"List workday types","openapi":"GET /contract/v1/workday-types","href":"/api-reference/listworkdaytypesincontract"},{"title":"Create a workday type","openapi":"POST /contract/v1/workday-types","href":"/api-reference/createworkdaytypeincontract"},{"title":"Update a workday type","openapi":"PUT /contract/v1/workday-types/{workdayTypeId}","href":"/api-reference/updateworkdaytypeincontract"},{"title":"Delete a workday type","openapi":"DELETE /contract/v1/workday-types/{workdayTypeId}","href":"/api-reference/deleteworkdaytypeincontract"}]},{"group":"Job Levels For Contracts","pages":[{"title":"List job levels","openapi":"GET /contract/v1/job-levels","href":"/api-reference/listjoblevelsincontract"}]},{"group":"Contract Annexes","pages":[{"title":"List contract annexes","openapi":"GET /contract/v1/contracts/{contractId}/annexes","href":"/api-reference/listcontractannexes"},{"title":"Create a contract annex","openapi":"POST /contract/v1/contracts/{contractId}/annexes","href":"/api-reference/createcontractannex"},{"title":"Get a contract annex","openapi":"GET /contract/v1/contracts/{contractId}/annexes/{annexId}","href":"/api-reference/getcontractannex"},{"title":"Update a contract annex","openapi":"PUT /contract/v1/contracts/{contractId}/annexes/{annexId}","href":"/api-reference/updatecontractannex"},{"title":"Delete a contract annex","openapi":"DELETE /contract/v1/contracts/{contractId}/annexes/{annexId}","href":"/api-reference/deletecontractannex"}]},{"group":"Compensations","pages":[{"title":"List all compensations","openapi":"GET /contract/v1/compensations","href":"/api-reference/listcompensations"},{"title":"Create a new compensation","openapi":"POST /contract/v1/compensations","href":"/api-reference/createcompensation"},{"title":"Get a single compensation","openapi":"GET /contract/v1/compensations/{compensationId}","href":"/api-reference/getcompensation"},{"title":"Update a compensation","openapi":"PUT /contract/v1/compensations/{compensationId}","href":"/api-reference/updatecompensation"},{"title":"Delete a compensation","openapi":"DELETE /contract/v1/compensations/{compensationId}","href":"/api-reference/deletecompensation"}]},{"group":"Employee Compensations","pages":[{"title":"List employees assigned to a compensation","openapi":"GET /contract/v1/compensations/{compensationId}/employees","href":"/api-reference/listcompensationemployees"},{"title":"List compensations assigned to an employee","openapi":"GET /contract/v1/employees/{employeeId}/compensations","href":"/api-reference/listemployeecompensations"},{"title":"Assign a compensation to an employee","openapi":"POST /contract/v1/employees/{employeeId}/compensations/{compensationId}","href":"/api-reference/assigncompensationtoemployee"},{"title":"Update an employee compensation assignment","openapi":"PUT /contract/v1/employee-compensations/{salaryCompensationId}","href":"/api-reference/updateemployeecompensation"},{"title":"Remove a compensation assignment from an employee","openapi":"DELETE /contract/v1/employee-compensations/{salaryCompensationId}","href":"/api-reference/deleteemployeecompensation"}]},{"group":"Monthly Variable Compensations","pages":[{"title":"List all monthly variable compensations","openapi":"GET /contract/v1/monthly-variable-compensations","href":"/api-reference/listmonthlyvariablecompensations"},{"title":"Create a monthly variable compensation","openapi":"POST /contract/v1/monthly-variable-compensations","href":"/api-reference/createmonthlyvariablecompensation"},{"title":"Get a monthly variable compensation","openapi":"GET /contract/v1/monthly-variable-compensations/{monthlyVariableCompensationId}","href":"/api-reference/getmonthlyvariablecompensation"},{"title":"Delete a monthly variable compensation","openapi":"DELETE /contract/v1/monthly-variable-compensations/{monthlyVariableCompensationId}","href":"/api-reference/deletemonthlyvariablecompensation"}]},{"group":"Employee Leave Types","pages":[{"title":"List all employee leave types","openapi":"GET /contract/v1/employee-leave-types","href":"/api-reference/listemployeeleavetypes"},{"title":"Create a new employee leave type","openapi":"POST /contract/v1/employee-leave-types","href":"/api-reference/createemployeeleavetype"},{"title":"Get a single employee leave type","openapi":"GET /contract/v1/employee-leave-types/{employeeLeaveTypeId}","href":"/api-reference/getemployeeleavetype"},{"title":"Update an employee leave type","openapi":"PUT /contract/v1/employee-leave-types/{employeeLeaveTypeId}","href":"/api-reference/updateemployeeleavetype"},{"title":"Delete an employee leave type","openapi":"DELETE /contract/v1/employee-leave-types/{employeeLeaveTypeId}","href":"/api-reference/deleteemployeeleavetype"}]},{"group":"Leave Reasons","pages":[{"title":"List all leave reasons","openapi":"GET /contract/v1/leave-reasons","href":"/api-reference/listleavereasons"},{"title":"Create a new leave reason","openapi":"POST /contract/v1/leave-reasons","href":"/api-reference/createleavereason"},{"title":"Update a leave reason","openapi":"PUT /contract/v1/leave-reasons/{leaveReasonId}","href":"/api-reference/updateleavereason"},{"title":"Delete a leave reason","openapi":"DELETE /contract/v1/leave-reasons/{leaveReasonId}","href":"/api-reference/deleteleavereason"}]},{"group":"Comments","pages":[{"title":"Create a comment for a thread or for an entity reference","openapi":"POST /discussion/v1/comments","href":"/api-reference/createcomment"},{"title":"List comments","openapi":"GET /discussion/v1/comments","href":"/api-reference/listcomments"},{"title":"Update a comment by id","openapi":"PUT /discussion/v1/comments/{commentId}","href":"/api-reference/updatecommentbyid"},{"title":"Delete a comment by id","openapi":"DELETE /discussion/v1/comments/{commentId}","href":"/api-reference/deletecommentbyid"}]},{"group":"Time Entries","pages":[{"title":"Time Entry In","openapi":"POST /project/v1/time-entries/start","href":"/api-reference/timeentryin"},{"title":"Time Entry Out","openapi":"POST /project/v1/time-entries/stop","href":"/api-reference/timeentryout"},{"title":"Create Time Entry","openapi":"POST /project/v1/time-entries","href":"/api-reference/createtimeentry"},{"title":"List Time Entries","openapi":"GET /project/v1/time-entries","href":"/api-reference/listtimeentries"},{"title":"Update Time Entry","openapi":"PUT /project/v1/time-entries/{id}","href":"/api-reference/updatetimeentry"},{"title":"Delete a Time Entry","openapi":"DELETE /project/v1/time-entries/{id}","href":"/api-reference/deletetimeentry"}]},{"group":"Customers","pages":[{"title":"Create a customer","openapi":"POST /project/v1/customers","href":"/api-reference/createcustomer"},{"title":"List customers","openapi":"GET /project/v1/customers","href":"/api-reference/listcustomers"},{"title":"Update a customer","openapi":"PUT /project/v1/customers/{id}","href":"/api-reference/updatecustomer"},{"title":"Delete a customer","openapi":"DELETE /project/v1/customers/{id}","href":"/api-reference/deletecustomer"}]},{"group":"Projects","pages":[{"title":"Create a project","openapi":"POST /project/v1/projects","href":"/api-reference/createproject"},{"title":"List projects","openapi":"GET /project/v1/projects","href":"/api-reference/listprojects"},{"title":"Update a project","openapi":"PUT /project/v1/projects/{id}","href":"/api-reference/updateproject"},{"title":"Delete a project","openapi":"DELETE /project/v1/projects/{id}","href":"/api-reference/deleteproject"}]},{"group":"Planned Tasks","pages":[{"title":"Create a planned task for a project","openapi":"POST /project/v1/planned-tasks","href":"/api-reference/createplannedtask"},{"title":"List planned tasks","openapi":"GET /project/v1/planned-tasks","href":"/api-reference/listplannedtasks"},{"title":"Update a planned task","openapi":"PUT /project/v1/planned-tasks/{plannedTaskId}","href":"/api-reference/updateplannedtask"},{"title":"Delete a planned task by id","openapi":"DELETE /project/v1/planned-tasks/{plannedTaskId}","href":"/api-reference/deleteplannedtaskbyid"}]},{"group":"Planned Tasks Assignations","pages":[{"title":"Assign an Entity (Employee, Office, Department or EntityGroup) to a planned task","openapi":"POST /project/v1/planned-tasks-assignations","href":"/api-reference/assignentityreferencetoplannedtask"},{"title":"List planned tasks assignations by plannedTaskId","openapi":"GET /project/v1/planned-tasks-assignations/{plannedTaskId}","href":"/api-reference/listplannedtasksassignations"},{"title":"Delete a planned task assignation by id","openapi":"DELETE /project/v1/planned-tasks-assignations/{plannedTaskAssignationId}","href":"/api-reference/deleteplannedtaskassignation"}]},{"group":"Documents","pages":[{"title":"List company directories","openapi":"GET /document/v1/directories","href":"/api-reference/listcompanydirectories"},{"title":"List directory documents","openapi":"GET /document/v1/directories/{directoryId}/documents","href":"/api-reference/listdirectorydocuments"},{"title":"Upload document","openapi":"POST /document/v1/directories/{directoryId}/documents","href":"/api-reference/uploaddocument"},{"title":"Download a binary file of the document","openapi":"GET /document/v1/documents/{documentId}/download","href":"/api-reference/downloaddocument"},{"title":"Update document visibility","openapi":"PUT /document/v1/documents/{documentId}","href":"/api-reference/updatedocumentvisibility"},{"title":"delete document","openapi":"DELETE /document/v1/documents/{documentId}","href":"/api-reference/deletedocument"}]},{"group":"Recruitment","pages":[{"title":"Get vacancies list","openapi":"GET /recruitment/v1/vacancies","href":"/api-reference/listvacancies"},{"title":"Get a vacancy","openapi":"GET /recruitment/v1/vacancies/{id}","href":"/api-reference/getvacancy"},{"title":"Get candidates by vacancy and status","openapi":"GET /recruitment/v1/vacancies/{vacancyId}/candidates","href":"/api-reference/getcandidatesbyvacancyandstatus"},{"title":"Create a candidate","openapi":"POST /recruitment/v1/candidates","href":"/api-reference/createcandidate"},{"title":"Get a candidate","openapi":"GET /recruitment/v1/candidates/{id}","href":"/api-reference/getcandidate"},{"title":"Update a candidate","openapi":"PUT /recruitment/v1/candidates/{id}","href":"/api-reference/updatecandidate"},{"title":"Upload candidate document","openapi":"POST /recruitment/v1/candidates/{id}","href":"/api-reference/uploaddocumenttocandidate"},{"title":"Get candidate status list","openapi":"GET /recruitment/v1/candidate-status/{vacancyId}","href":"/api-reference/listcandidatestatus"}]},{"group":"Hours Bag","pages":[{"title":"List employees hours bag aggregate balance","openapi":"GET /schedule/v1/employees-hours-bags","href":"/api-reference/listemployeeshoursbags"}]},{"group":"Hours Bag Rule History","pages":[{"title":"List Hours Bag Rule History","openapi":"GET /schedule/v1/hours-bag-rule-history","href":"/api-reference/listhoursbagrulehistory"}]},{"group":"Hours Bag Rules","pages":[{"title":"List Hours Bag Rules","openapi":"GET /schedule/v1/hours-bag-rules","href":"/api-reference/listhoursbagrules"}]},{"group":"Overtime Validation","pages":[{"title":"List validated overtime requests (history)","openapi":"GET /schedule/v1/overtime-validation/history","href":"/api-reference/listovertimevalidationhistory"}]},{"group":"Training Types","pages":[{"title":"List types of trainings","openapi":"GET /training/v1/training-types","href":"/api-reference/listtrainingtypes"}]},{"group":"Trainings","pages":[{"title":"Create a training","openapi":"POST /training/v1/trainings","href":"/api-reference/createtraining"},{"title":"List trainings","openapi":"GET /training/v1/trainings","href":"/api-reference/listtrainings"},{"title":"Get a training","openapi":"GET /training/v1/trainings/{trainingId}","href":"/api-reference/gettraining"},{"title":"Update a training","openapi":"PUT /training/v1/trainings/{trainingId}","href":"/api-reference/updatetraining"},{"title":"Delete a training","openapi":"DELETE /training/v1/trainings/{trainingId}","href":"/api-reference/deletetraining"}]},{"group":"Employee Training Assignation","pages":[{"title":"Assign employees to a training","openapi":"POST /training/v1/training-employees-assignations/{trainingId}","href":"/api-reference/assignemployeestotraining"},{"title":"List employees from a training","openapi":"GET /training/v1/training-employees-assignations/{trainingId}","href":"/api-reference/listemployeesintraining"},{"title":"Unassign employees to a training","openapi":"DELETE /training/v1/training-employees-assignations/{trainingId}","href":"/api-reference/unassignemployeestotraining"}]},{"group":"Employee Training Status","pages":[{"title":"Update employee status at a training","openapi":"PUT /training/v1/training-employees-status/{assignId}","href":"/api-reference/updateemployeesstatusattraining"}]},{"group":"Expense Management","pages":[{"title":"List company expenses","openapi":"GET /expense-management/v1/expenses","href":"/api-reference/listcompanyexpenses"},{"title":"List expense categories","openapi":"GET /expense-management/v1/expense-categories","href":"/api-reference/listexpensecategories"},{"title":"List expense payment methods","openapi":"GET /expense-management/v1/expense-payment-methods","href":"/api-reference/listexpensepaymentmethods"}]},{"group":"Polls","pages":[{"title":"List poll evaluations of the company","openapi":"GET /poll/v1/evaluations","href":"/api-reference/listevaluations"},{"title":"Answer a candidate recruitment evaluation","openapi":"POST /poll/v1/evaluations/candidate-recruitment/{evaluationId}","href":"/api-reference/answercandidaterecruitmentevaluation"}]},{"group":"Shifts","pages":[{"title":"List Company Shifts","openapi":"GET /schedule/v1/shifts","href":"/api-reference/listshifts"},{"title":"Create Shift","openapi":"POST /schedule/v1/shifts","href":"/api-reference/createshift"}]},{"group":"Planners","pages":[{"title":"List Company Planners","openapi":"GET /schedule/v1/planners","href":"/api-reference/listplanners"},{"title":"List Planner Employees","openapi":"GET /schedule/v1/planners/{plannerId}/employees","href":"/api-reference/listplanneremployees"},{"title":"Assign Employees to Planner","openapi":"POST /schedule/v1/planners/{plannerId}/employees","href":"/api-reference/assignemployeestoplanner"},{"title":"List Planner Entity References","openapi":"GET /schedule/v1/planners/{plannerId}/entity-references","href":"/api-reference/listplannerentityreferences"},{"title":"List Shift Assignments in Planner","openapi":"GET /schedule/v1/planners/{plannerId}/shift-assignments","href":"/api-reference/listshiftassignmentsinplanner"},{"title":"Assign Shifts to Employees in Planner","openapi":"POST /schedule/v1/planners/{plannerId}/shift-assignments","href":"/api-reference/assignshiftstoemployeesinplanner"},{"title":"Delete Shift Assignment","openapi":"DELETE /schedule/v1/planners/{plannerId}/shift-assignments/{shiftAssignmentId}","href":"/api-reference/deleteshiftassignment"},{"title":"Assign Free Days to Employees in Planner","openapi":"POST /schedule/v1/planners/{plannerId}/free-days","href":"/api-reference/assignfreedaystoemployeesinplanner"},{"title":"Delete Free Days from Employees in Planner","openapi":"DELETE /schedule/v1/planners/{plannerId}/free-days","href":"/api-reference/deletefreedaysfromemployeesinplanner"}]},{"group":"Shift Assignments","pages":[{"title":"List Shift Assignments","openapi":"GET /schedule/v1/shift-assignments","href":"/api-reference/listshiftassignments"}]},{"group":"Requests","pages":[{"title":"List requests","openapi":"GET /request/v1/requests","href":"/api-reference/listrequests"},{"title":"Get a single request","openapi":"GET /request/v1/requests/{requestId}","href":"/api-reference/getrequest"},{"title":"Get request documents","openapi":"GET /request/v1/requests/{requestId}/documents","href":"/api-reference/getrequestdocuments"}]},{"group":"Request Types","pages":[{"title":"List request types","openapi":"GET /request/v1/request-types","href":"/api-reference/listrequesttypes"}]},{"group":"MX Payroll","pages":[{"title":"List Mexican employees with their master payroll data","openapi":"GET /third-party-context/v1/all-mx-employee-data","href":"/api-reference/listallmxemployeedata"},{"title":"Get the master payroll data of one Mexican employee","openapi":"GET /third-party-context/v1/all-mx-employee-data/{employeeId}","href":"/api-reference/getmxemployeedata"}]},{"group":"Overtime Policies","pages":[{"title":"Adjust the overtime balance of an employee","openapi":"POST /overtime-policies/v1/adjustments","href":"/api-reference/createovertimebalanceadjustment"},{"title":"Compensate overtime of an employee with rest","openapi":"POST /overtime-policies/v1/compensations/rest","href":"/api-reference/createovertimerestcompensation"},{"title":"List the overtime balance adjustments of an employee","openapi":"GET /overtime-policies/v1/employees/{employeeId}/adjustments","href":"/api-reference/listemployeeovertimebalanceadjustments"},{"title":"Get the overtime balance of an employee","openapi":"GET /overtime-policies/v1/employees/{employeeId}/balance","description":"Returns the total, positive and negative overtime balance of the employee `employeeId` for the `from`-`to` period, including the adjustments already applied. Read it right before `POST /overtime-policies/v1/adjustments` and send the value of the matching key as `balanceBeforeSeconds`. To compensate with rest, read `GET /overtime-policies/v1/employees/{employeeId}/rest-compensable-balance` instead. The employee must belong to the company of the token. The read permission is checked over the employee before the lookup: an employee the API consumer has no role over answers 403. When the permission passes, as it does for a company-wide API consumer, an id that is not an employee of the company of the token (including an unknown id) answers 422 `employee_not_adjustable`.","href":"/api-reference/getemployeeovertimebalance"},{"title":"Get the rest-compensable balance of an employee","openapi":"GET /overtime-policies/v1/employees/{employeeId}/rest-compensable-balance","href":"/api-reference/getemployeerestcompensablebalance"},{"title":"Get the balance of every overtime rule of an employee","openapi":"GET /overtime-policies/v1/employees/{employeeId}/rule-balances","description":"Returns, for the employee `employeeId` and the `from`-`to` period (closed days only: up to yesterday), the balance of every multiplier and typifying rule assigned to the employee or with generated time or movements in the period. The balance is the generated time plus the rule adjustments, minus the rule compensations, and can be negative. Read it right before `POST /overtime-policies/v1/adjustments` with a rule source and copy from the item of the rule `ruleId` and `source` as they are, and `balanceSeconds` as `balanceBeforeSeconds`. The read permission is checked over the employee: an employee the API consumer has no role over answers 403. When the permission passes, as it does for a company-wide API consumer, an id that is not an employee of the company of the token (including an unknown id) answers 200 with an empty list.","href":"/api-reference/getemployeeovertimerulebalances"}]},{"title":"Webhooks","href":"/api-reference/webhooks"}]}]},{"tab":"Changelog","pages":[{"title":"Changelog","href":"/changelog/overview"}]}]},"basePath":"","title":"Get the rest-compensable balance of an employee - Sesame HR API","deploymentId":"dpl_DyXGnKeCjZyA3sUdfMJ7FjkdBefg","buildId":"dpl_DyXGnKeCjZyA3sUdfMJ7FjkdBefg","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-CiUHMMOm.js","snippetPresets-BgfXU7Bw.js","utils-DWvOwgy_.js","style-to-object-BY3JEAdk.js","utils-BN7RXSMJ.js","v4-DIgz8zy6.js","addUniqueKeysToSchema-CFw8bq89.js","conditional-requirements-CFM0id0Q.js","cloneDeep-CAwdfOU2.js","_Uint8Array-BJr8e-ZL.js","isObject-FP1Yky1u.js","ApiExamples-XX0UgMZK.js","usePlaygroundInputsStore-DXDFSa1V.js","shallow-CdX5aREi.js","isEqual-CoOaxexF.js","CodeSnippets-Cg2wpzWm.js","CodeSnippet-D_HwgQO_.js","getApiPlaygroundDisplay-CmCoerhe.js","Page-CVJ-f_k1.js","DynamicMarkdown-CQM9Bhbv.js","SectionHeading-DpbrP8nQ.js","icon-BPCgijHy.js","MethodPill-GQ8DuY0c.js","getPastedJson-Cb5mT31m.js","Check2Icon-a7bUI6e8.js","axios-CsQoIw0U.js","Markdown-CX2QY19L.js","AssistantPageLink-CY3bFglh.js","dist-Dl6_zDnT.js","lib-DMeTj1gb.js","lib-B8HbPgcC.js","katex-Dbtb6Wk7.js","html-void-elements-mCSPHezU.js","marked.esm-CZWythHk.js"]}