The occupational scheme terms: which statutory regime the scheme tops
up, how the top-up composes with statutory pay, what it is measured
against, and the week bands that set the occupational pay level.
{"docsConfig":{"theme":"palm","$schema":"https://mintlify.com/docs.json","name":"Intermezzo Docs","colors":{"primary":"#73f","light":"#a67cf0","dark":"#73f"},"logo":{"light":"https://mintcdn.com/intermezzo/XOEFYK36Q6eJv_R4/logo/intermezzo_light.svg?fit=max\u0026auto=format\u0026n=XOEFYK36Q6eJv_R4\u0026q=85\u0026s=4b9e8941df9647de37ca603f7ca47f49","dark":"https://mintcdn.com/intermezzo/sciYsehRUBwL7M2i/logo/intermezzo_dark.svg?fit=max\u0026auto=format\u0026n=sciYsehRUBwL7M2i\u0026q=85\u0026s=5bed853d508d4d8bae6691ed85740729","href":"https://intermezzo.ai"},"favicon":"https://mintcdn.com/intermezzo/XOEFYK36Q6eJv_R4/favicon.png?fit=max\u0026auto=format\u0026n=XOEFYK36Q6eJv_R4\u0026q=85\u0026s=5970f25bec25b022614415fec2a93940","api":{"examples":{"defaults":"required","prefill":true}},"appearance":{"default":"light","strict":true},"navbar":{"links":[{"href":"mailto:support@intermezzo.ai","label":"Support"}]},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"intermezzo","hasAudioNarration":false,"actualSubdomain":"intermezzo","customDomains":["docs.intermezzo.ai"],"gitSource":{"type":"github","owner":"intermezzo-ai","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"feedback":{"thumbs":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6ad20dd390399234bc7bc063","clientVersion":"0.0.4111","searchFilterCounts":[{"language":"default","tag":"API Reference","count":205},{"language":"default","tag":"Great Britain","count":129},{"language":"default","tag":"Core","count":80},{"language":"default","tag":"Employees","count":45},{"language":"default","tag":"Organizations","count":26},{"language":"default","tag":"Payroll","count":21},{"language":"default","tag":"Reports","count":21},{"language":"default","tag":"Worksites","count":16},{"language":"default","tag":"Pension","count":15},{"language":"default","tag":"Post Payroll","count":14}]},"assistantConfig":{},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/preview/great-britain/get-absence-scheme","slug":"/api-reference/preview/great-britain/get-absence-scheme","pageMetadata":{"title":"Get Absence Scheme","description":"Latest terms edition of one scheme.","deprecated":null,"version":null,"openapi":"/api-reference/preview.json get /gb/organizations/{organization_id}/absence-schemes/{scheme_id}","href":"/api-reference/preview/great-britain/get-absence-scheme","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Latest terms edition of one scheme.\"\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 Absence Scheme","description":"Latest terms edition of one scheme.","deprecated":null,"version":null,"openapi":"/api-reference/preview.json get /gb/organizations/{organization_id}/absence-schemes/{scheme_id}","href":"/api-reference/preview/great-britain/get-absence-scheme","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["Great Britain","Absence Schemes"],"summary":"Get Absence Scheme","description":"Latest terms edition of one scheme.","operationId":"get_absence_scheme_gb_organizations__organization_id__absence_schemes__scheme_id__get","security":["fa2db52e-e60e-4387-8623-3ace143141cc"],"parameters":["2b4e93d5-02d8-41d7-b1ba-05f169a411ba","dfd06479-02dd-45d5-aed9-9f9e5ce0a9ad"],"responses":{"200":"d805ebba-b1d6-405a-ac2f-cb70fac90a10","400":"06bf66e9-8871-47dc-b6ff-7d159021c13d","404":"813ed491-2cbd-441b-a7cf-b2b6f9c49c68","422":"aa564a3d-4719-4458-9592-0f83ffab604d"},"method":"get","type":"path","servers":["6065456c-46b1-44e8-a7ee-50f9e55aa028"],"path":"/gb/organizations/{organization_id}/absence-schemes/{scheme_id}","baseUrlOptions":["https://preview.intermezzo.ai"],"title":"Get Absence Scheme","codeSamples":[],"requiredOnlyExamples":true,"requestExampleType":"generated","responseExampleType":"generated","prefillPlaygroundWithExample":true,"prefillPlaygroundExamples":[]},"dependencies":{"parameters":{"2b4e93d5-02d8-41d7-b1ba-05f169a411ba":{"name":"organization_id","in":"path","required":true,"schema":{"type":"string","title":"Organization Id","isRequired":true,"uniqueKey":"","typeLabel":"string"}},"dfd06479-02dd-45d5-aed9-9f9e5ce0a9ad":{"name":"scheme_id","in":"path","required":true,"schema":{"type":"string","title":"Scheme Id","isRequired":true,"uniqueKey":"","typeLabel":"string"}}},"responses":{"d805ebba-b1d6-405a-ac2f-cb70fac90a10":{"description":"Successful Response","content":{"application/json":{"schema":{"properties":{"scheme_id":{"type":"string","title":"Scheme Id","isRequired":true,"uniqueKey":"scheme_id","typeLabel":"string"},"edition_id":{"type":"integer","title":"Edition Id","isRequired":true,"uniqueKey":"edition_id","typeLabel":"integer"},"name":{"type":"string","title":"Name","isRequired":true,"uniqueKey":"name","typeLabel":"string"},"valid_from":{"type":"string","format":"date","title":"Valid From","isRequired":true,"uniqueKey":"valid_from","typeLabel":"string\u003cdate>"},"terms":{"properties":{"regime":{"type":"string","enum":["SMP","SPP","SAP","SHPP","SPBP","SNCP"],"title":"FamilyPayRegime","description":"The six statutory family-pay regimes a claim or assignment can cover.","isRequired":true,"uniqueKey":"terms.regime","typeLabel":"enum\u003cstring>"},"offset_mode":{"type":"string","enum":["INCLUSIVE","ADDITIVE","SUBSTITUTIVE"],"title":"SchemeOffsetMode","description":"How occupational pay composes with the statutory line. SUBSTITUTIVE\nis an employer-facing alias that behaves as INCLUSIVE: statutory rights\ncannot be signed away. Consumers read `GBSchemeTerms.effective_offset_mode`,\nnever the raw value.","isRequired":true,"uniqueKey":"terms.offset_mode","typeLabel":"enum\u003cstring>"},"top_up_wage_type_code":{"type":"string","maxLength":50,"minLength":1,"title":"Top Up Wage Type Code","description":"Catalog EARNINGS wage type the occupational top-up line is emitted under (validated against the catalog at scheme write)","isRequired":true,"uniqueKey":"terms.top_up_wage_type_code","typeLabel":"string"},"content_schema_version":{"type":"integer","maximum":1,"minimum":1,"title":"Content Schema Version","description":"Shape of the stored terms document; omit it and the current shape is assumed","default":1,"uniqueKey":"terms.content_schema_version","typeLabel":"integer"},"baseline":{"type":"string","enum":["CONTRACTUAL_WEEKLY","AWE"],"title":"SchemeBaseline","description":"What a band percentage is applied to.","default":"CONTRACTUAL_WEEKLY","uniqueKey":"terms.baseline","typeLabel":"enum\u003cstring>"},"bands":{"items":{"properties":{"from_week":{"type":"integer","maximum":52,"minimum":1,"title":"From Week","isRequired":true,"uniqueKey":"terms.bands.items.[INDEX].from_week","typeLabel":"integer"},"to_week":{"type":"integer","maximum":52,"minimum":1,"title":"To Week","isRequired":true,"uniqueKey":"terms.bands.items.[INDEX].to_week","typeLabel":"integer"},"pay_level":{"properties":{"percent":{"type":"string","title":"Percent","isRequired":true,"uniqueKey":"terms.bands.items.[INDEX].pay_level.percent","typeLabel":"string"},"kind":{"type":"string","const":"percent_of_baseline","title":"Kind","default":"percent_of_baseline","uniqueKey":"terms.bands.items.[INDEX].pay_level.kind","typeLabel":"string"},"statutory_floor":{"type":"boolean","title":"Statutory Floor","default":false,"uniqueKey":"terms.bands.items.[INDEX].pay_level.statutory_floor","typeLabel":"boolean"}},"additionalProperties":false,"type":"object","required":["percent"],"title":"PercentOfBaselinePay","description":"Occupational pay as a percentage of the scheme baseline. `statutory_floor`\nrecords the max(statutory, X% baseline) pattern; `statutory_floor` is stored\nfor the valuer; it does not change validation.","isRequired":true,"uniqueKey":"terms.bands.items.[INDEX].pay_level","typeLabel":"PercentOfBaselinePay · object"}},"additionalProperties":false,"type":"object","required":["from_week","to_week","pay_level"],"title":"SchemeWeekBand","description":"One band of leave weeks, 1-based, inclusive at both ends.","uniqueKey":"terms.bands.items.[INDEX]","typeLabel":"SchemeWeekBand · object"},"type":"array","title":"Bands","description":"Base band set; may be empty only when service_bands exist (short-service employees are then statutory-only)","uniqueKey":"terms.bands","typeLabel":"SchemeWeekBand · object[]"},"service_bands":{"oneOf":[{"type":"array","items":{"properties":{"min_service_months":{"type":"integer","minimum":0,"title":"Min Service Months","isRequired":true,"uniqueKey":"terms.service_bands.oneOf.0.items.[INDEX].min_service_months","typeLabel":"integer"},"bands":{"items":{"properties":{"from_week":{"type":"integer","maximum":52,"minimum":1,"title":"From Week","isRequired":true,"uniqueKey":"terms.service_bands.oneOf.0.items.[INDEX].bands.items.[INDEX].from_week","typeLabel":"integer"},"to_week":{"type":"integer","maximum":52,"minimum":1,"title":"To Week","isRequired":true,"uniqueKey":"terms.service_bands.oneOf.0.items.[INDEX].bands.items.[INDEX].to_week","typeLabel":"integer"},"pay_level":{"properties":{"percent":{"type":"string","title":"Percent","isRequired":true,"uniqueKey":"terms.service_bands.oneOf.0.items.[INDEX].bands.items.[INDEX].pay_level.percent","typeLabel":"string"},"kind":{"type":"string","const":"percent_of_baseline","title":"Kind","default":"percent_of_baseline","uniqueKey":"terms.service_bands.oneOf.0.items.[INDEX].bands.items.[INDEX].pay_level.kind","typeLabel":"string"},"statutory_floor":{"type":"boolean","title":"Statutory Floor","default":false,"uniqueKey":"terms.service_bands.oneOf.0.items.[INDEX].bands.items.[INDEX].pay_level.statutory_floor","typeLabel":"boolean"}},"additionalProperties":false,"type":"object","required":["percent"],"title":"PercentOfBaselinePay","description":"Occupational pay as a percentage of the scheme baseline. `statutory_floor`\nrecords the max(statutory, X% baseline) pattern; `statutory_floor` is stored\nfor the valuer; it does not change validation.","isRequired":true,"uniqueKey":"terms.service_bands.oneOf.0.items.[INDEX].bands.items.[INDEX].pay_level","typeLabel":"PercentOfBaselinePay · object"}},"additionalProperties":false,"type":"object","required":["from_week","to_week","pay_level"],"title":"SchemeWeekBand","description":"One band of leave weeks, 1-based, inclusive at both ends.","uniqueKey":"terms.service_bands.oneOf.0.items.[INDEX].bands.items.[INDEX]","typeLabel":"SchemeWeekBand · object"},"type":"array","minItems":1,"title":"Bands","isRequired":true,"uniqueKey":"terms.service_bands.oneOf.0.items.[INDEX].bands","typeLabel":"SchemeWeekBand · object[]"}},"additionalProperties":false,"type":"object","required":["min_service_months","bands"],"title":"SchemeServiceBand","description":"A band set unlocked at a service threshold. It replaces the base\n`bands` for employees whose service is at least `min_service_months`\n(highest matching threshold wins; below every threshold the base `bands`\napply).","uniqueKey":"terms.service_bands.oneOf.0.items.[INDEX]","typeLabel":"SchemeServiceBand · object"},"title":"Service Bands","uniqueKey":"terms.service_bands.oneOf.0","typeLabel":"SchemeServiceBand · object[]"},{"type":"null","title":"Service Bands","uniqueKey":"terms.service_bands.oneOf.1","typeLabel":"null"}],"uniqueKey":"terms.service_bands","typeLabel":"SchemeServiceBand · object[] | null"}},"additionalProperties":false,"type":"object","required":["regime","offset_mode","top_up_wage_type_code"],"title":"GBSchemeTerms","description":"The occupational scheme terms: which statutory regime the scheme tops\nup, how the top-up composes with statutory pay, what it is measured\nagainst, and the week bands that set the occupational pay level.","isRequired":true,"uniqueKey":"terms","typeLabel":"GBSchemeTerms · object"},"created_at":{"type":"string","format":"date-time","title":"Created At","isRequired":true,"uniqueKey":"created_at","typeLabel":"string\u003cdate-time>"},"effective_offset_mode":{"type":"string","enum":["INCLUSIVE","ADDITIVE","SUBSTITUTIVE"],"title":"SchemeOffsetMode","description":"How the occupational top-up actually composes with the statutory line for these terms","readOnly":true,"isRequired":true,"uniqueKey":"effective_offset_mode","typeLabel":"enum\u003cstring>"},"valid_to":{"oneOf":[{"type":"string","title":"Valid To","format":"date","uniqueKey":"valid_to.oneOf.0","typeLabel":"string\u003cdate>"},{"type":"null","title":"Valid To","uniqueKey":"valid_to.oneOf.1","typeLabel":"null"}],"uniqueKey":"valid_to","typeLabel":"string\u003cdate> | null"}},"additionalProperties":false,"type":"object","required":["scheme_id","edition_id","name","valid_from","terms","created_at","effective_offset_mode"],"title":"GBAbsenceSchemeResponse","description":"One edition of a scheme's terms. `valid_to` is null while the edition\nis open-ended.","uniqueKey":"","typeLabel":"GBAbsenceSchemeResponse · object"},"examples":{"Example":{"title":"Example","value":{"scheme_id":"\u003cstring>","edition_id":123,"name":"\u003cstring>","valid_from":"2023-12-25","terms":{"regime":"SMP","offset_mode":"INCLUSIVE","top_up_wage_type_code":"\u003cstring>","content_schema_version":1,"baseline":"CONTRACTUAL_WEEKLY","bands":[{"from_week":26,"to_week":26,"pay_level":{"percent":"\u003cstring>","kind":"percent_of_baseline","statutory_floor":false}}],"service_bands":[{"min_service_months":1,"bands":[{"from_week":26,"to_week":26,"pay_level":{"percent":"\u003cstring>","kind":"percent_of_baseline","statutory_floor":false}}]}]},"created_at":"2023-11-07T05:31:56Z","effective_offset_mode":"INCLUSIVE","valid_to":"2023-12-25"}}},"exampleType":"generated"}},"exampleType":"generated"},"06bf66e9-8871-47dc-b6ff-7d159021c13d":{"description":"- `ORG_BELONGS_TO_A_DIFFERENT_COUNTRY`: Raised when an organization belongs to a different country than the one in the path.","content":{"application/json":{"schema":{"type":"object","title":"ErrorResponse","required":["errors"],"properties":{"errors":{"type":"array","items":{"additionalProperties":false,"description":"Represents an error that occurred during processing.\n\nDesigned for client-side i18n:\n- code: Use this to look up translation (e.g., \"ORG_NOT_FOUND\")\n- message: English fallback if translation not available\n- field: Field name for form validation highlighting\n- params: Dynamic values for translation interpolation","properties":{"code":{"type":"string","enum":["ORG_BELONGS_TO_A_DIFFERENT_COUNTRY"],"title":"Code","description":"Unique error code for i18n lookup","isRequired":true,"uniqueKey":"errors.items.[INDEX].code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","title":"Message","description":"English fallback error message","isRequired":true,"uniqueKey":"errors.items.[INDEX].message","typeLabel":"string"},"field":{"oneOf":[{"type":"string","title":"Field","description":"Field that caused the error","uniqueKey":"errors.items.[INDEX].field.oneOf.0","typeLabel":"string"},{"type":"null","title":"Field","description":"Field that caused the error","uniqueKey":"errors.items.[INDEX].field.oneOf.1","typeLabel":"null"}],"uniqueKey":"errors.items.[INDEX].field","typeLabel":"string | null"},"params":{"oneOf":[{"type":"object","title":"Params","description":"Parameters for translation interpolation","additionalProperties":true,"uniqueKey":"errors.items.[INDEX].params.oneOf.0","typeLabel":"Params · object"},{"type":"null","title":"Params","description":"Parameters for translation interpolation","uniqueKey":"errors.items.[INDEX].params.oneOf.1","typeLabel":"null"}],"uniqueKey":"errors.items.[INDEX].params","typeLabel":"Params · object | null"}},"required":["code","message"],"title":"ErrorDetail","type":"object","uniqueKey":"errors.items.[INDEX]","typeLabel":"ErrorDetail · object"},"isRequired":true,"uniqueKey":"errors","typeLabel":"ErrorDetail · object[]"}},"uniqueKey":"","typeLabel":"ErrorResponse · object"},"examples":{"ORG_BELONGS_TO_A_DIFFERENT_COUNTRY":{"title":"ORG_BELONGS_TO_A_DIFFERENT_COUNTRY","value":{"errors":[{"code":"ORG_BELONGS_TO_A_DIFFERENT_COUNTRY","message":"Raised when an organization belongs to a different country than the one in the path."}]}}},"exampleType":"examples"}},"exampleType":"examples"},"813ed491-2cbd-441b-a7cf-b2b6f9c49c68":{"description":"- `ORG_NOT_FOUND`: Raised when an organization is not found.\n- `GB_ABSENCE_SCHEME_NOT_FOUND`: No absence scheme with this id exists in the organization.","content":{"application/json":{"schema":{"type":"object","title":"ErrorResponse","required":["errors"],"properties":{"errors":{"type":"array","items":{"additionalProperties":false,"description":"Represents an error that occurred during processing.\n\nDesigned for client-side i18n:\n- code: Use this to look up translation (e.g., \"ORG_NOT_FOUND\")\n- message: English fallback if translation not available\n- field: Field name for form validation highlighting\n- params: Dynamic values for translation interpolation","properties":{"code":{"type":"string","enum":["ORG_NOT_FOUND","GB_ABSENCE_SCHEME_NOT_FOUND"],"title":"Code","description":"Unique error code for i18n lookup","isRequired":true,"uniqueKey":"errors.items.[INDEX].code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","title":"Message","description":"English fallback error message","isRequired":true,"uniqueKey":"errors.items.[INDEX].message","typeLabel":"string"},"field":{"oneOf":[{"type":"string","title":"Field","description":"Field that caused the error","uniqueKey":"errors.items.[INDEX].field.oneOf.0","typeLabel":"string"},{"type":"null","title":"Field","description":"Field that caused the error","uniqueKey":"errors.items.[INDEX].field.oneOf.1","typeLabel":"null"}],"uniqueKey":"errors.items.[INDEX].field","typeLabel":"string | null"},"params":{"oneOf":[{"type":"object","title":"Params","description":"Parameters for translation interpolation","additionalProperties":true,"uniqueKey":"errors.items.[INDEX].params.oneOf.0","typeLabel":"Params · object"},{"type":"null","title":"Params","description":"Parameters for translation interpolation","uniqueKey":"errors.items.[INDEX].params.oneOf.1","typeLabel":"null"}],"uniqueKey":"errors.items.[INDEX].params","typeLabel":"Params · object | null"}},"required":["code","message"],"title":"ErrorDetail","type":"object","uniqueKey":"errors.items.[INDEX]","typeLabel":"ErrorDetail · object"},"isRequired":true,"uniqueKey":"errors","typeLabel":"ErrorDetail · object[]"}},"uniqueKey":"","typeLabel":"ErrorResponse · object"},"examples":{"ORG_NOT_FOUND":{"title":"ORG_NOT_FOUND","value":{"errors":[{"code":"ORG_NOT_FOUND","message":"Raised when an organization is not found."}]}},"GB_ABSENCE_SCHEME_NOT_FOUND":{"title":"GB_ABSENCE_SCHEME_NOT_FOUND","value":{"errors":[{"code":"GB_ABSENCE_SCHEME_NOT_FOUND","message":"No absence scheme with this id exists in the organization."}]}}},"exampleType":"examples"}},"exampleType":"examples"},"aa564a3d-4719-4458-9592-0f83ffab604d":{"description":"The request failed validation. Type and format errors use the generic FIELD_* codes.\n- `GB_ABSENCE_SCHEME_TERMS_MALFORMED`: The scheme's stored terms are malformed; write a new terms edition to repair it.","content":{"application/json":{"schema":{"type":"object","title":"ErrorResponse","required":["errors"],"properties":{"errors":{"type":"array","items":{"additionalProperties":false,"description":"Represents an error that occurred during processing.\n\nDesigned for client-side i18n:\n- code: Use this to look up translation (e.g., \"ORG_NOT_FOUND\")\n- message: English fallback if translation not available\n- field: Field name for form validation highlighting\n- params: Dynamic values for translation interpolation","properties":{"code":{"type":"string","enum":["GB_ABSENCE_SCHEME_TERMS_MALFORMED","FIELD_REQUIRED","FIELD_INVALID_TYPE_STRING","FIELD_INVALID_TYPE_INT","FIELD_INVALID_TYPE_FLOAT","FIELD_INVALID_TYPE_BOOL","FIELD_INVALID_TYPE_DICT","FIELD_INVALID_TYPE_LIST","FIELD_STRING_TOO_SHORT","FIELD_STRING_TOO_LONG","FIELD_STRING_PATTERN_MISMATCH","FIELD_VALUE_TOO_SMALL","FIELD_VALUE_TOO_LARGE","FIELD_INVALID_DATE","FIELD_INVALID_DATETIME","FIELD_INVALID_TIME","FIELD_INVALID_DATE_FORMAT","FIELD_INVALID_DATETIME_FORMAT","FIELD_INVALID_ENUM_VALUE","FIELD_INVALID_EMAIL","FIELD_INVALID_URL","FIELD_LIST_TOO_SHORT","FIELD_LIST_TOO_LONG","FIELD_UNKNOWN","FIELD_VALIDATION_ERROR"],"title":"Code","description":"Unique error code for i18n lookup","isRequired":true,"uniqueKey":"errors.items.[INDEX].code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","title":"Message","description":"English fallback error message","isRequired":true,"uniqueKey":"errors.items.[INDEX].message","typeLabel":"string"},"field":{"oneOf":[{"type":"string","title":"Field","description":"Field that caused the error","uniqueKey":"errors.items.[INDEX].field.oneOf.0","typeLabel":"string"},{"type":"null","title":"Field","description":"Field that caused the error","uniqueKey":"errors.items.[INDEX].field.oneOf.1","typeLabel":"null"}],"uniqueKey":"errors.items.[INDEX].field","typeLabel":"string | null"},"params":{"oneOf":[{"type":"object","title":"Params","description":"Parameters for translation interpolation","additionalProperties":true,"uniqueKey":"errors.items.[INDEX].params.oneOf.0","typeLabel":"Params · object"},{"type":"null","title":"Params","description":"Parameters for translation interpolation","uniqueKey":"errors.items.[INDEX].params.oneOf.1","typeLabel":"null"}],"uniqueKey":"errors.items.[INDEX].params","typeLabel":"Params · object | null"}},"required":["code","message"],"title":"ErrorDetail","type":"object","uniqueKey":"errors.items.[INDEX]","typeLabel":"ErrorDetail · object"},"isRequired":true,"uniqueKey":"errors","typeLabel":"ErrorDetail · object[]"}},"uniqueKey":"","typeLabel":"ErrorResponse · object"},"examples":{"GB_ABSENCE_SCHEME_TERMS_MALFORMED":{"title":"GB_ABSENCE_SCHEME_TERMS_MALFORMED","value":{"errors":[{"code":"GB_ABSENCE_SCHEME_TERMS_MALFORMED","message":"The scheme's stored terms are malformed; write a new terms edition to repair it."}]}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"fa2db52e-e60e-4387-8623-3ace143141cc":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Get token from Auth0 and paste it here","scopes":[],"schemeName":"BearerToken"}}},"servers":{"6065456c-46b1-44e8-a7ee-50f9e55aa028":{"url":"https://preview.intermezzo.ai","description":"Preview"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Get token from Auth0 and paste it here","scopes":[],"schemeName":"BearerToken"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Get token from Auth0 and paste it here","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"BearerToken","name":"Authorization"}],"title":"BearerToken"}]},"originalFileLocation":"api-reference/preview.json"},"subdomain":"intermezzo","siteName":"Intermezzo Docs","title":"Get Absence Scheme - Intermezzo Docs","navMaps":{"firstHrefInVersion":{"Preview":{"href":"/api-reference/preview/great-britain/get-absence-scheme","matchLevel":0}},"firstHrefInLanguage":{}},"lastModified":"2026-10-16T11:43:27.750Z","originalFileLocation":"api-reference/preview/great-britain/get-absence-scheme.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=\"light\";if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"light\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Latest terms edition of one scheme.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Intermezzo Docs\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/intermezzo/kfSq5e1CN76wLrfm/_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/intermezzo/kfSq5e1CN76wLrfm/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/intermezzo/kfSq5e1CN76wLrfm/_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/intermezzo/kfSq5e1CN76wLrfm/_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/intermezzo/kfSq5e1CN76wLrfm/_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/intermezzo/kfSq5e1CN76wLrfm/_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/intermezzo/kfSq5e1CN76wLrfm/_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/intermezzo/kfSq5e1CN76wLrfm/_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/intermezzo/kfSq5e1CN76wLrfm/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Get Absence Scheme - Intermezzo Docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"Latest terms edition of one scheme.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Intermezzo Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.intermezzo.ai/api-reference/preview/great-britain/get-absence-scheme\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://intermezzo.mintlify.site/_mintlify/api/og/v2?division=Absence+Schemes\u0026amp;title=Get+Absence+Scheme\u0026amp;description=Latest+terms+edition+of+one+scheme.\u0026amp;theme=2cc41bc2d4d72760d1901e1b\u0026amp;signature=1620647c85e6e2201023bf0531e042509a6b3f6685798071bd40189c1146b16e\">\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 Absence Scheme - Intermezzo Docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Latest terms edition of one scheme.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://intermezzo.mintlify.site/_mintlify/api/og/v2?division=Absence+Schemes\u0026amp;title=Get+Absence+Scheme\u0026amp;description=Latest+terms+edition+of+one+scheme.\u0026amp;theme=2cc41bc2d4d72760d1901e1b\u0026amp;signature=1620647c85e6e2201023bf0531e042509a6b3f6685798071bd40189c1146b16e\">\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/intermezzo/kfSq5e1CN76wLrfm/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Intermezzo Docs\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#73f\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.intermezzo.ai/api-reference/preview/great-britain/get-absence-scheme\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/preview/great-britain/get-absence-scheme.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.intermezzo.ai/#organization\",\"name\":\"Intermezzo Docs\",\"url\":\"https://docs.intermezzo.ai\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/intermezzo/XOEFYK36Q6eJv_R4/logo/intermezzo_light.svg?fit=max\u0026auto=format\u0026n=XOEFYK36Q6eJv_R4\u0026q=85\u0026s=4b9e8941df9647de37ca603f7ca47f49\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.intermezzo.ai#website\",\"name\":\"Intermezzo Docs\",\"url\":\"https://docs.intermezzo.ai\",\"publisher\":{\"@id\":\"https://docs.intermezzo.ai/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.intermezzo.ai/api-reference/preview/great-britain/get-absence-scheme#webpage\",\"url\":\"https://docs.intermezzo.ai/api-reference/preview/great-britain/get-absence-scheme\",\"name\":\"Get Absence Scheme\",\"description\":\"Latest terms edition of one scheme.\",\"dateModified\":\"2026-10-16T11:43:27.750Z\",\"isPartOf\":{\"@id\":\"https://docs.intermezzo.ai#website\"},\"breadcrumb\":{\"@id\":\"https://docs.intermezzo.ai/api-reference/preview/great-britain/get-absence-scheme#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.intermezzo.ai/api-reference/preview/great-britain/get-absence-scheme#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Great Britain\",\"item\":\"https://docs.intermezzo.ai/api-reference/preview/great-britain/create-employee\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Absence Schemes\",\"item\":\"https://docs.intermezzo.ai/api-reference/preview/great-britain/create-absence-scheme\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Get Absence Scheme\",\"item\":\"https://docs.intermezzo.ai/api-reference/preview/great-britain/get-absence-scheme\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.intermezzo.ai/api-reference/preview/great-britain/get-absence-scheme#apireference\",\"headline\":\"Get Absence Scheme\",\"name\":\"Get Absence Scheme\",\"description\":\"Latest terms edition of one scheme.\",\"url\":\"https://docs.intermezzo.ai/api-reference/preview/great-britain/get-absence-scheme\",\"mainEntityOfPage\":{\"@id\":\"https://docs.intermezzo.ai/api-reference/preview/great-britain/get-absence-scheme#webpage\"},\"dateModified\":\"2026-10-16T11:43:27.750Z\",\"publisher\":{\"@id\":\"https://docs.intermezzo.ai/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.intermezzo.ai#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Intermezzo Docs\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Intermezzo Docs\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/preview/great-britain/get-absence-scheme.md","siteName":"Intermezzo Docs","nav":{"global":null,"versions":[{"version":"Preview","tabs":[{"tab":"Guides","pages":[{"title":"Guides","href":""}]},{"tab":"API Reference","groups":[{"group":"Core","pages":[{"group":"Organizations","pages":[{"title":"Create Orgs","deprecated":null,"version":null,"openapi":"/api-reference/preview.json post /organizations","href":"/api-reference/preview/core/create-orgs"},{"title":"List Orgs","deprecated":null,"version":null,"openapi":"/api-reference/preview.json get /organizations","href":"/api-reference/preview/core/list-orgs"},{"title":"Create Orgs Bulk","deprecated":null,"version":null,"openapi":"/api-reference/preview.json post /organizations/list","href":"/api-reference/preview/core/create-orgs-bulk"},{"title":"Get Org","deprecated":null,"version":null,"openapi":"/api-reference/preview.json get /organizations/{organization_id}","href":"/api-reference/preview/core/get-org"},{"title":"Update Org","deprecated":null,"version":null,"openapi":"/api-reference/preview.json patch /organizations/{organization_id}","href":"/api-reference/preview/core/update-org"},{"title":"Shutdown Org","deprecated":null,"version":null,"openapi":"/api-reference/preview.json post /organizations/{organization_id}/shutdown","href":"/api-reference/preview/core/shutdown-org"},{"group":"Logo","pages":[{"title":"Generate logo upload URL","deprecated":null,"version":null,"openapi":"/api-reference/preview.json post /organizations/{organization_id}/logo/upload-url","href":"/api-reference/preview/core/generate-logo-upload-url"},{"title":"Confirm logo upload","deprecated":null,"version":null,"openapi":"/api-reference/preview.json post /organizations/{organization_id}/logo/confirm","href":"/api-reference/preview/core/confirm-logo-upload"}]},{"group":"Preferences","pages":[{"title":"Update Organization Preferences","deprecated":null,"version":null,"openapi":"/api-reference/preview.json patch /organizations/{organization_id}/preferences","href":"/api-reference/preview/core/update-organization-preferences"},{"title":"Get Current Organization Preferences","deprecated":null,"version":null,"openapi":"/api-reference/preview.json get /organizations/{organization_id}/preferences","href":"/api-reference/preview/core/get-current-organization-preferences"}]},{"group":"Insurance Details","pages":[{"title":"Get Organization Insurance Details","deprecated":null,"version":null,"openapi":"/api-reference/preview.json get /organizations/{organization_id}/insurance-details","href":"/api-reference/preview/core/get-organization-insurance-details"},{"title":"Create Organization Insurance Details","deprecated":null,"version":null,"openapi":"/api-reference/preview.json post /organizations/{organization_id}/insurance-details","href":"/api-reference/preview/core/create-organization-insurance-details"},{"title":"Update Organization Insurance Details","deprecated":null,"version":null,"openapi":"/api-reference/preview.json patch /organizations/{organization_id}/insurance-details/{insurance_details_id}","href":"/api-reference/preview/core/update-organization-insurance-details"}]},{"group":"Tax Details","pages":[{"title":"Get Organization Tax Identifiers","deprecated":null,"version":null,"openapi":"/api-reference/preview.json get /organizations/{organization_id}/tax-identifiers","href":"/api-reference/preview/core/get-organization-tax-identifiers"},{"title":"Create Organization Tax Identifier","deprecated":null,"version":null,"openapi":"/api-reference/preview.json post /organizations/{organization_id}/tax-identifiers","href":"/api-reference/preview/core/create-organization-tax-identifier"},{"title":"Update Organization Tax Identifier","deprecated":null,"version":null,"openapi":"/api-reference/preview.json patch /organizations/{organization_id}/tax-identifiers/{tax_identifier_id}","href":"/api-reference/preview/core/update-organization-tax-identifier"}]},{"group":"Contacts","pages":[{"title":"Get Organization Contacts","deprecated":null,"version":null,"openapi":"/api-reference/preview.json get /organizations/{organization_id}/contacts","href":"/api-reference/preview/core/get-organization-contacts"},{"title":"Create Organization Contact","deprecated":null,"version":null,"openapi":"/api-reference/preview.json post /organizations/{organization_id}/contacts","href":"/api-reference/preview/core/create-organization-contact"},{"title":"Attach Contacts To Organization","deprecated":null,"version":null,"openapi":"/api-reference/preview.json put /organizations/{organization_id}/contacts","href":"/api-reference/preview/core/attach-contacts-to-organization"},{"title":"Create multiple contacts in bulk","deprecated":null,"version":null,"openapi":"/api-reference/preview.json post /organizations/{organization_id}/contacts/list","href":"/api-reference/preview/core/create-multiple-contacts-in-bulk"},{"title":"Attach Contact To Organization","deprecated":null,"version":null,"openapi":"/api-reference/preview.json post /organizations/{organization_id}/contacts/{contact_id}","href":"/api-reference/preview/core/attach-contact-to-organization"},{"title":"Patch Organization Contact","deprecated":null,"version":null,"openapi":"/api-reference/preview.json patch /organizations/{organization_id}/contacts/{contact_id}","href":"/api-reference/preview/core/patch-organization-contact"}]},{"group":"Banking","pages":[{"title":"Get Organization Bank Accounts","deprecated":null,"version":null,"openapi":"/api-reference/preview.json get /organizations/{organization_id}/bank-accounts","href":"/api-reference/preview/core/get-organization-bank-accounts"},{"title":"Create Organization Bank Account","deprecated":null,"version":null,"openapi":"/api-reference/preview.json post /organizations/{organization_id}/bank-accounts","href":"/api-reference/preview/core/create-organization-bank-account"},{"title":"Create Organization Bank Accounts Bulk","deprecated":null,"version":null,"openapi":"/api-reference/preview.json post /organizations/{organization_id}/bank-accounts/list","href":"/api-reference/preview/core/create-organization-bank-accounts-bulk"},{"title":"Patch Organization Bank Account","deprecated":null,"version":null,"openapi":"/api-reference/preview.json patch /organizations/{organization_id}/bank-accounts/{bank_account_id}","href":"/api-reference/preview/core/patch-organization-bank-account"}]}]},{"group":"Worksites","pages":[{"title":"List Worksites","deprecated":null,"version":null,"openapi":"/api-reference/preview.json get /organizations/{organization_id}/worksites","href":"/api-reference/preview/core/list-worksites"},{"title":"Create Worksite","deprecated":null,"version":null,"openapi":"/api-reference/preview.json post /organizations/{organization_id}/worksites","href":"/api-reference/preview/core/create-worksite"},{"title":"Get Worksite","deprecated":null,"version":null,"openapi":"/api-reference/preview.json get /organizations/{organization_id}/worksites/{worksite_id}","href":"/api-reference/preview/core/get-worksite"},{"title":"Patch Worksite","deprecated":null,"version":null,"openapi":"/api-reference/preview.json patch /organizations/{organization_id}/worksites/{worksite_id}","href":"/api-reference/preview/core/patch-worksite"},{"title":"Create Worksites Bulk","deprecated":null,"version":null,"openapi":"/api-reference/preview.json post /organizations/{organization_id}/worksites/list","href":"/api-reference/preview/core/create-worksites-bulk"},{"group":"Insurance Details","pages":[{"title":"Get Worksite Insurance Details","deprecated":null,"version":null,"openapi":"/api-reference/preview.json get /organizations/{organization_id}/worksites/{worksite_id}/insurance-details","href":"/api-reference/preview/core/get-worksite-insurance-details"},{"title":"Create Worksite Insurance Details","deprecated":null,"version":null,"openapi":"/api-reference/preview.json post /organizations/{organization_id}/worksites/{worksite_id}/insurance-details","href":"/api-reference/preview/core/create-worksite-insurance-details"},{"title":"Update Worksite Insurance Details","deprecated":null,"version":null,"openapi":"/api-reference/preview.json patch /organizations/{organization_id}/worksites/{worksite_id}/insurance-details/{insurance_details_id}","href":"/api-reference/preview/core/update-worksite-insurance-details"}]},{"group":"Tax Details","pages":[{"title":"Get Worksite Tax Identifiers","deprecated":null,"version":null,"openapi":"/api-reference/preview.json get /organizations/{organization_id}/worksites/{worksite_id}/tax-identifiers","href":"/api-reference/preview/core/get-worksite-tax-identifiers"},{"title":"Create Worksite Tax Identifier","deprecated":null,"version":null,"openapi":"/api-reference/preview.json post /organizations/{organization_id}/worksites/{worksite_id}/tax-identifiers","href":"/api-reference/preview/core/create-worksite-tax-identifier"},{"title":"Update Worksite Tax Identifier","deprecated":null,"version":null,"openapi":"/api-reference/preview.json patch /organizations/{organization_id}/worksites/{worksite_id}/tax-identifiers/{tax_identifier_id}","href":"/api-reference/preview/core/update-worksite-tax-identifier"}]},{"group":"Contacts","pages":[{"title":"Get Worksite Contacts","deprecated":null,"version":null,"openapi":"/api-reference/preview.json get /organizations/{organization_id}/worksites/{worksite_id}/contacts","href":"/api-reference/preview/core/get-worksite-contacts"},{"title":"Create Worksite Contact","deprecated":null,"version":null,"openapi":"/api-reference/preview.json post /organizations/{organization_id}/worksites/{worksite_id}/contacts","href":"/api-reference/preview/core/create-worksite-contact"},{"title":"Attach Contacts To Worksite","deprecated":null,"version":null,"openapi":"/api-reference/preview.json put /organizations/{organization_id}/worksites/{worksite_id}/contacts","href":"/api-reference/preview/core/attach-contacts-to-worksite"},{"title":"Create Worksite Contacts Bulk","deprecated":null,"version":null,"openapi":"/api-reference/preview.json post /organizations/{organization_id}/worksites/{worksite_id}/contacts/list","href":"/api-reference/preview/core/create-worksite-contacts-bulk"},{"title":"Patch Worksite Contact","deprecated":null,"version":null,"openapi":"/api-reference/preview.json patch /organizations/{organization_id}/worksites/{worksite_id}/contacts/{contact_id}","href":"/api-reference/preview/core/patch-worksite-contact"}]}]},{"group":"Contacts","pages":[{"title":"List Contacts","deprecated":null,"version":null,"openapi":"/api-reference/preview.json get /contacts","href":"/api-reference/preview/core/list-contacts"},{"title":"Patch Contact","deprecated":null,"version":null,"openapi":"/api-reference/preview.json patch /contacts/{contact_id}","href":"/api-reference/preview/core/patch-contact"}]},{"group":"Addresses","pages":[{"title":"Get Address","deprecated":null,"version":null,"openapi":"/api-reference/preview.json get /organizations/{organization_id}/addresses/{address_id}","href":"/api-reference/preview/core/get-address"},{"title":"Update Addresss","deprecated":null,"version":null,"openapi":"/api-reference/preview.json put /organizations/{organization_id}/addresses/{address_id}","href":"/api-reference/preview/core/update-addresss"},{"title":"Create Addresss","deprecated":null,"version":null,"openapi":"/api-reference/preview.json post /organizations/{organization_id}/addresses","href":"/api-reference/preview/core/create-addresss"}]},{"group":"Webhooks","pages":[{"title":"Setup Partner Webhook","deprecated":null,"version":null,"openapi":"/api-reference/preview.json put /webhooks/{category}","href":"/api-reference/preview/core/setup-partner-webhook"},{"title":"Rotate Partner Webhook","deprecated":null,"version":null,"openapi":"/api-reference/preview.json post /webhooks/{category}/rotate","href":"/api-reference/preview/core/rotate-partner-webhook"},{"title":"Revoke Partner Webhook","deprecated":null,"version":null,"openapi":"/api-reference/preview.json post /webhooks/{category}/revoke","href":"/api-reference/preview/core/revoke-partner-webhook"},{"title":"List Partner Webhooks","deprecated":null,"version":null,"openapi":"/api-reference/preview.json get /webhooks","href":"/api-reference/preview/core/list-partner-webhooks"},{"title":"List Partner Webhook Deliveries","deprecated":null,"version":null,"openapi":"/api-reference/preview.json get /webhooks/deliveries","href":"/api-reference/preview/core/list-partner-webhook-deliveries"}]},{"group":"Payrolls","pages":[{"title":"Approve Payroll","deprecated":null,"version":null,"openapi":"/api-reference/preview.json post /organizations/{organization_id}/payrolls/{payroll_status_id}/approve","href":"/api-reference/preview/core/approve-payroll"},{"title":"List Payruns","deprecated":null,"version":null,"openapi":"/api-reference/preview.json get /organizations/{organization_id}/payrolls","href":"/api-reference/preview/core/list-payruns"},{"title":"Get Payroll Status","deprecated":null,"version":null,"openapi":"/api-reference/preview.json get /organizations/{organization_id}/payrolls/{payroll_status_id}/status","href":"/api-reference/preview/core/get-payroll-status"},{"title":"Get Payroll Status History","deprecated":null,"version":null,"openapi":"/api-reference/preview.json get /organizations/{organization_id}/payrolls/{payroll_status_id}/status/history","href":"/api-reference/preview/core/get-payroll-status-history"},{"title":"List Payroll Statuses","deprecated":null,"version":null,"openapi":"/api-reference/preview.json get /organizations/{organization_id}/payrolls/statuses","href":"/api-reference/preview/core/list-payroll-statuses"},{"group":"Pay Calendars","pages":[{"title":"List Pay Calendars","deprecated":null,"version":null,"openapi":"/api-reference/preview.json get /organizations/{organization_id}/payrolls/pay-calendars","href":"/api-reference/preview/core/list-pay-calendars"},{"title":"Create Pay Calendar","deprecated":null,"version":null,"openapi":"/api-reference/preview.json post /organizations/{organization_id}/payrolls/pay-calendars","href":"/api-reference/preview/core/create-pay-calendar"}]},{"group":"Pay Groups","pages":[{"title":"List Pay Groups","deprecated":null,"version":null,"openapi":"/api-reference/preview.json get /organizations/{organization_id}/payrolls/pay-groups","href":"/api-reference/preview/core/list-pay-groups"},{"title":"Create Pay Group","deprecated":null,"version":null,"openapi":"/api-reference/preview.json post /organizations/{organization_id}/payrolls/pay-groups","href":"/api-reference/preview/core/create-pay-group"},{"title":"Get Pay Group","deprecated":null,"version":null,"openapi":"/api-reference/preview.json get /organizations/{organization_id}/payrolls/pay-groups/{pay_group_id}","href":"/api-reference/preview/core/get-pay-group"},{"title":"List Pay Group Employees","deprecated":null,"version":null,"openapi":"/api-reference/preview.json get /organizations/{organization_id}/payrolls/pay-groups/{pay_group_id}/employees","href":"/api-reference/preview/core/list-pay-group-employees"}]},{"group":"Payslips","pages":[{"title":"Get Payslips","deprecated":null,"version":null,"openapi":"/api-reference/preview.json get /organizations/{organization_id}/payrolls/{payroll_status_id}/payslips","href":"/api-reference/preview/core/get-payslips"},{"title":"Download Sample Payslip","deprecated":null,"version":null,"openapi":"/api-reference/preview.json get /organizations/{organization_id}/payrolls/{payroll_status_id}/payslips/{payslip_id}/download_sample","href":"/api-reference/preview/core/download-sample-payslip"}]}]},{"group":"Employees","pages":[{"group":"Documents","pages":[{"title":"Generate presigned upload URL","deprecated":null,"version":null,"openapi":"/api-reference/preview.json post /organizations/{organization_id}/employees/{employee_id}/documents/upload","href":"/api-reference/preview/core/generate-presigned-upload-url"},{"title":"Confirm upload completion","deprecated":null,"version":null,"openapi":"/api-reference/preview.json post /organizations/{organization_id}/employees/{employee_id}/documents/confirm","href":"/api-reference/preview/core/confirm-upload-completion"},{"title":"List employee documents","deprecated":null,"version":null,"openapi":"/api-reference/preview.json get /organizations/{organization_id}/employees/{employee_id}/documents","href":"/api-reference/preview/core/list-employee-documents"},{"title":"Generate presigned download URL","deprecated":null,"version":null,"openapi":"/api-reference/preview.json get /organizations/{organization_id}/employees/{employee_id}/documents/{document_id}/download","href":"/api-reference/preview/core/generate-presigned-download-url"},{"title":"Delete a document","deprecated":null,"version":null,"openapi":"/api-reference/preview.json delete /organizations/{organization_id}/employees/{employee_id}/documents/{document_id}","href":"/api-reference/preview/core/delete-a-document"}]},{"group":"Absences","pages":[{"title":"Create Absence","deprecated":null,"version":null,"openapi":"/api-reference/preview.json post /organizations/{organization_id}/employees/{employee_id}/absences","href":"/api-reference/preview/core/create-absence"},{"title":"List Absences","deprecated":null,"version":null,"openapi":"/api-reference/preview.json get /organizations/{organization_id}/employees/{employee_id}/absences","href":"/api-reference/preview/core/list-absences"},{"title":"Get Absence","deprecated":null,"version":null,"openapi":"/api-reference/preview.json get /organizations/{organization_id}/employees/{employee_id}/absences/{absence_id}","href":"/api-reference/preview/core/get-absence"},{"title":"Amend Absence","deprecated":null,"version":null,"openapi":"/api-reference/preview.json patch /organizations/{organization_id}/employees/{employee_id}/absences/{absence_id}","href":"/api-reference/preview/core/amend-absence"},{"title":"Cancel Absence","deprecated":null,"version":null,"openapi":"/api-reference/preview.json delete /organizations/{organization_id}/employees/{employee_id}/absences/{absence_id}","href":"/api-reference/preview/core/cancel-absence"},{"title":"Get Absence History","deprecated":null,"version":null,"openapi":"/api-reference/preview.json get /organizations/{organization_id}/employees/{employee_id}/absences/{absence_id}/history","href":"/api-reference/preview/core/get-absence-history"}]}]}]},{"group":"Great Britain","pages":[{"group":"Employees","pages":[{"title":"Create Employee","deprecated":null,"version":null,"openapi":"/api-reference/preview.json post /gb/organizations/{organization_id}/employees","href":"/api-reference/preview/great-britain/create-employee"},{"title":"List Employees","deprecated":null,"version":null,"openapi":"/api-reference/preview.json get /gb/organizations/{organization_id}/employees","href":"/api-reference/preview/great-britain/list-employees"},{"title":"Create Employees","deprecated":null,"version":null,"openapi":"/api-reference/preview.json post /gb/organizations/{organization_id}/employees/list","href":"/api-reference/preview/great-britain/create-employees"},{"title":"Get Employee","deprecated":null,"version":null,"openapi":"/api-reference/preview.json get /gb/organizations/{organization_id}/employees/{employee_id}","href":"/api-reference/preview/great-britain/get-employee"},{"title":"Close Employee","deprecated":null,"version":null,"openapi":"/api-reference/preview.json post /gb/organizations/{organization_id}/employees/{employee_id}/close","href":"/api-reference/preview/great-britain/close-employee"},{"title":"Get Employee Status","deprecated":null,"version":null,"openapi":"/api-reference/preview.json get /gb/organizations/{organization_id}/employees/{employee_id}/status","href":"/api-reference/preview/great-britain/get-employee-status"},{"group":"Core","pages":[{"title":"Get Core","deprecated":null,"version":null,"openapi":"/api-reference/preview.json get /gb/organizations/{organization_id}/employees/{employee_id}/core","href":"/api-reference/preview/great-britain/get-core"},{"title":"Create Core Edition","deprecated":null,"version":null,"openapi":"/api-reference/preview.json put /gb/organizations/{organization_id}/employees/{employee_id}/core","href":"/api-reference/preview/great-britain/create-core-edition"},{"title":"Get Core Editions","deprecated":null,"version":null,"openapi":"/api-reference/preview.json get /gb/organizations/{organization_id}/employees/{employee_id}/core/editions","href":"/api-reference/preview/great-britain/get-core-editions"},{"title":"Get Core Protocol","deprecated":null,"version":null,"openapi":"/api-reference/preview.json get /gb/organizations/{organization_id}/employees/{employee_id}/core/protocol","href":"/api-reference/preview/great-britain/get-core-protocol"}]},{"group":"Address","pages":[{"title":"Get Address","deprecated":null,"version":null,"openapi":"/api-reference/preview.json get /gb/organizations/{organization_id}/employees/{employee_id}/address","href":"/api-reference/preview/great-britain/get-address"},{"title":"Create Address Edition","deprecated":null,"version":null,"openapi":"/api-reference/preview.json put /gb/organizations/{organization_id}/employees/{employee_id}/address","href":"/api-reference/preview/great-britain/create-address-edition"},{"title":"Get Address Editions","deprecated":null,"version":null,"openapi":"/api-reference/preview.json get /gb/organizations/{organization_id}/employees/{employee_id}/address/editions","href":"/api-reference/preview/great-britain/get-address-editions"},{"title":"Get Address Protocol","deprecated":null,"version":null,"openapi":"/api-reference/preview.json get /gb/organizations/{organization_id}/employees/{employee_id}/address/protocol","href":"/api-reference/preview/great-britain/get-address-protocol"}]},{"group":"Job","pages":[{"title":"Get Job","deprecated":null,"version":null,"openapi":"/api-reference/preview.json get /gb/organizations/{organization_id}/employees/{employee_id}/job","href":"/api-reference/preview/great-britain/get-job"},{"title":"Create Job Edition","deprecated":null,"version":null,"openapi":"/api-reference/preview.json put /gb/organizations/{organization_id}/employees/{employee_id}/job","href":"/api-reference/preview/great-britain/create-job-edition"},{"title":"Get Job Editions","deprecated":null,"version":null,"openapi":"/api-reference/preview.json get /gb/organizations/{organization_id}/employees/{employee_id}/job/editions","href":"/api-reference/preview/great-britain/get-job-editions"},{"title":"Get Job Protocol","deprecated":null,"version":null,"openapi":"/api-reference/preview.json get /gb/organizations/{organization_id}/employees/{employee_id}/job/protocol","href":"/api-reference/preview/great-britain/get-job-protocol"}]},{"group":"Tax","pages":[{"title":"Get Tax","deprecated":null,"version":null,"openapi":"/api-reference/preview.json get /gb/organizations/{organization_id}/employees/{employee_id}/tax","href":"/api-reference/preview/great-britain/get-tax"},{"title":"Create Tax Edition","deprecated":null,"version":null,"openapi":"/api-reference/preview.json put /gb/organizations/{organization_id}/employees/{employee_id}/tax","href":"/api-reference/preview/great-britain/create-tax-edition"},{"title":"Get Tax Editions","deprecated":null,"version":null,"openapi":"/api-reference/preview.json get /gb/organizations/{organization_id}/employees/{employee_id}/tax/editions","href":"/api-reference/preview/great-britain/get-tax-editions"},{"title":"Get Tax Protocol","deprecated":null,"version":null,"openapi":"/api-reference/preview.json get /gb/organizations/{organization_id}/employees/{employee_id}/tax/protocol","href":"/api-reference/preview/great-britain/get-tax-protocol"}]},{"group":"Insurance","pages":[{"title":"Get Insurance","deprecated":null,"version":null,"openapi":"/api-reference/preview.json get /gb/organizations/{organization_id}/employees/{employee_id}/insurance","href":"/api-reference/preview/great-britain/get-insurance"},{"title":"Create Insurance Edition","deprecated":null,"version":null,"openapi":"/api-reference/preview.json put /gb/organizations/{organization_id}/employees/{employee_id}/insurance","href":"/api-reference/preview/great-britain/create-insurance-edition"},{"title":"Get Insurance Editions","deprecated":null,"version":null,"openapi":"/api-reference/preview.json get /gb/organizations/{organization_id}/employees/{employee_id}/insurance/editions","href":"/api-reference/preview/great-britain/get-insurance-editions"},{"title":"Get Insurance Protocol","deprecated":null,"version":null,"openapi":"/api-reference/preview.json get /gb/organizations/{organization_id}/employees/{employee_id}/insurance/protocol","href":"/api-reference/preview/great-britain/get-insurance-protocol"}]},{"group":"Compensation","pages":[{"title":"Get Compensation","deprecated":null,"version":null,"openapi":"/api-reference/preview.json get /gb/organizations/{organization_id}/employees/{employee_id}/compensation","href":"/api-reference/preview/great-britain/get-compensation"},{"title":"Create Compensation Edition","deprecated":null,"version":null,"openapi":"/api-reference/preview.json put /gb/organizations/{organization_id}/employees/{employee_id}/compensation","href":"/api-reference/preview/great-britain/create-compensation-edition"},{"title":"Get Compensation Editions","deprecated":null,"version":null,"openapi":"/api-reference/preview.json get /gb/organizations/{organization_id}/employees/{employee_id}/compensation/editions","href":"/api-reference/preview/great-britain/get-compensation-editions"},{"title":"Get Compensation Protocol","deprecated":null,"version":null,"openapi":"/api-reference/preview.json get /gb/organizations/{organization_id}/employees/{employee_id}/compensation/protocol","href":"/api-reference/preview/great-britain/get-compensation-protocol"}]},{"group":"Bank","pages":[{"title":"Get Bank","deprecated":null,"version":null,"openapi":"/api-reference/preview.json get /gb/organizations/{organization_id}/employees/{employee_id}/bank","href":"/api-reference/preview/great-britain/get-bank"},{"title":"Create Bank Edition","deprecated":null,"version":null,"openapi":"/api-reference/preview.json put /gb/organizations/{organization_id}/employees/{employee_id}/bank","href":"/api-reference/preview/great-britain/create-bank-edition"},{"title":"Get Bank Editions","deprecated":null,"version":null,"openapi":"/api-reference/preview.json get /gb/organizations/{organization_id}/employees/{employee_id}/bank/editions","href":"/api-reference/preview/great-britain/get-bank-editions"},{"title":"Get Bank Protocol","deprecated":null,"version":null,"openapi":"/api-reference/preview.json get /gb/organizations/{organization_id}/employees/{employee_id}/bank/protocol","href":"/api-reference/preview/great-britain/get-bank-protocol"}]}]},{"group":"Absences","pages":[{"title":"Add Kit Day","deprecated":null,"version":null,"openapi":"/api-reference/preview.json post /gb/organizations/{organization_id}/employees/{employee_id}/absences/{absence_id}/kit-days","href":"/api-reference/preview/great-britain/add-kit-day"},{"title":"Record Birth","deprecated":null,"version":null,"openapi":"/api-reference/preview.json post /gb/organizations/{organization_id}/employees/{employee_id}/absences/{absence_id}/birth","href":"/api-reference/preview/great-britain/record-birth"},{"title":"Record Evidence","deprecated":null,"version":null,"openapi":"/api-reference/preview.json post /gb/organizations/{organization_id}/employees/{employee_id}/absences/{absence_id}/evidence","href":"/api-reference/preview/great-britain/record-evidence"},{"title":"Get Family Pay Claim","deprecated":null,"version":null,"openapi":"/api-reference/preview.json get /gb/organizations/{organization_id}/employees/{employee_id}/absences/{absence_id}/claim","href":"/api-reference/preview/great-britain/get-family-pay-claim"},{"title":"Override Claim Awe","deprecated":null,"version":null,"openapi":"/api-reference/preview.json post /gb/organizations/{organization_id}/employees/{employee_id}/absences/{absence_id}/claim/awe-override","href":"/api-reference/preview/great-britain/override-claim-awe"}]},{"group":"Absence Schemes","pages":[{"title":"Create Absence Scheme","deprecated":null,"version":null,"openapi":"/api-reference/preview.json post /gb/organizations/{organization_id}/absence-schemes","href":"/api-reference/preview/great-britain/create-absence-scheme"},{"title":"List Absence Schemes","description":"The organization's schemes, latest terms edition of each.","deprecated":null,"version":null,"openapi":"/api-reference/preview.json get /gb/organizations/{organization_id}/absence-schemes","href":"/api-reference/preview/great-britain/list-absence-schemes"},{"title":"Get Absence Scheme","deprecated":null,"version":null,"openapi":"/api-reference/preview.json get /gb/organizations/{organization_id}/absence-schemes/{scheme_id}","href":"/api-reference/preview/great-britain/get-absence-scheme"},{"title":"Update Absence Scheme","description":"Append a new terms edition effective from `valid_from`; earlier\neditions are kept, so past periods re-derive identically.","deprecated":null,"version":null,"openapi":"/api-reference/preview.json put /gb/organizations/{organization_id}/absence-schemes/{scheme_id}","href":"/api-reference/preview/great-britain/update-absence-scheme"},{"title":"Delete Absence Scheme","deprecated":null,"version":null,"openapi":"/api-reference/preview.json delete /gb/organizations/{organization_id}/absence-schemes/{scheme_id}","href":"/api-reference/preview/great-britain/delete-absence-scheme"},{"title":"List Absence Scheme Editions","deprecated":null,"version":null,"openapi":"/api-reference/preview.json get /gb/organizations/{organization_id}/absence-schemes/{scheme_id}/editions","href":"/api-reference/preview/great-britain/list-absence-scheme-editions"},{"title":"Create Absence Scheme Assignment","deprecated":null,"version":null,"openapi":"/api-reference/preview.json post /gb/organizations/{organization_id}/absence-scheme-assignments","href":"/api-reference/preview/great-britain/create-absence-scheme-assignment"},{"title":"List Absence Scheme Assignments","deprecated":null,"version":null,"openapi":"/api-reference/preview.json get /gb/organizations/{organization_id}/absence-scheme-assignments","href":"/api-reference/preview/great-britain/list-absence-scheme-assignments"},{"title":"End Absence Scheme Assignment","deprecated":null,"version":null,"openapi":"/api-reference/preview.json delete /gb/organizations/{organization_id}/absence-scheme-assignments/{assignment_id}","href":"/api-reference/preview/great-britain/end-absence-scheme-assignment"}]},{"group":"AWE","pages":[{"title":"Get Awe","deprecated":null,"version":null,"openapi":"/api-reference/preview.json get /gb/organizations/{organization_id}/employees/{employee_id}/awe","href":"/api-reference/preview/great-britain/get-awe"},{"title":"List Earnings History","deprecated":null,"version":null,"openapi":"/api-reference/preview.json get /gb/organizations/{organization_id}/employees/{employee_id}/earnings-history","href":"/api-reference/preview/great-britain/list-earnings-history"}]},{"group":"Payroll","pages":[{"group":"Post Payroll","pages":[{"group":"HMRC Filing","pages":[{"title":"Submit Eps","deprecated":null,"version":null,"openapi":"/api-reference/preview.json post /gb/organizations/{organization_id}/eps","href":"/api-reference/preview/great-britain/submit-eps"},{"title":"List Eps Submissions","deprecated":null,"version":null,"openapi":"/api-reference/preview.json get /gb/organizations/{organization_id}/eps","href":"/api-reference/preview/great-britain/list-eps-submissions"},{"title":"Get Eps Submission","deprecated":null,"version":null,"openapi":"/api-reference/preview.json get /gb/organizations/{organization_id}/eps/{eps_id}","href":"/api-reference/preview/great-britain/get-eps-submission"},{"title":"Run Fps Test In Live","deprecated":null,"version":null,"openapi":"/api-reference/preview.json post /gb/organizations/{organization_id}/payrolls/{payroll_status_id}/fps/test-in-live","href":"/api-reference/preview/great-britain/run-fps-test-in-live"},{"title":"Get test-in-live FPS submission details","deprecated":null,"version":null,"openapi":"/api-reference/preview.json get /gb/organizations/{organization_id}/payrolls/{payroll_status_id}/fps/test-in-live","href":"/api-reference/preview/great-britain/get-test-in-live-fps-submission-details"},{"title":"Get FPS submission details","deprecated":null,"version":null,"openapi":"/api-reference/preview.json get /gb/organizations/{organization_id}/payrolls/{payroll_status_id}/fps","href":"/api-reference/preview/great-britain/get-fps-submission-details"}]},{"group":"Payments","pages":[{"title":"Get P32 for a full tax year","deprecated":null,"version":null,"openapi":"/api-reference/preview.json get /gb/organizations/{organization_id}/p32/{tax_year}","href":"/api-reference/preview/great-britain/get-p32-for-a-full-tax-year"},{"title":"Export P32 for a tax year with cumulative totals","deprecated":null,"version":null,"openapi":"/api-reference/preview.json get /gb/organizations/{organization_id}/p32/{tax_year}/export","href":"/api-reference/preview/great-britain/export-p32-for-a-tax-year-with-cumulative-totals"},{"title":"Get P32 for a single tax month","deprecated":null,"version":null,"openapi":"/api-reference/preview.json get /gb/organizations/{organization_id}/p32/{tax_year}/{tax_month}","href":"/api-reference/preview/great-britain/get-p32-for-a-single-tax-month"},{"title":"Manually trigger P32 recompute for a tax month","deprecated":null,"version":null,"openapi":"/api-reference/preview.json post /gb/organizations/{organization_id}/p32/{tax_year}/{tax_month}/recompute","href":"/api-reference/preview/great-britain/manually-trigger-p32-recompute-for-a-tax-month"},{"title":"Request repayment of a P32 surplus","deprecated":null,"version":null,"openapi":"/api-reference/preview.json post /gb/organizations/{organization_id}/p32/{tax_year}/{tax_month}/request-repayment","href":"/api-reference/preview/great-britain/request-repayment-of-a-p32-surplus"},{"title":"Download stored BACS file","deprecated":null,"version":null,"openapi":"/api-reference/preview.json get /gb/organizations/{organization_id}/payrolls/{payroll_status_id}/bacs-file/download","href":"/api-reference/preview/great-britain/download-stored-bacs-file"},{"title":"Get BACS file task status","deprecated":null,"version":null,"openapi":"/api-reference/preview.json get /gb/organizations/{organization_id}/payrolls/{payroll_status_id}/tasks/bacs-file/status","href":"/api-reference/preview/great-britain/get-bacs-file-task-status"},{"title":"Validate a BACS file","deprecated":null,"version":null,"openapi":"/api-reference/preview.json post /gb/organizations/{organization_id}/payrolls/bacs-file/validate","href":"/api-reference/preview/great-britain/validate-a-bacs-file"}]}]},{"group":"Run Payroll","pages":[{"title":"Run Payroll","deprecated":null,"version":null,"openapi":"/api-reference/preview.json post /gb/organizations/{organization_id}/payrolls","href":"/api-reference/preview/great-britain/run-payroll"},{"group":"Task Status \u0026 Results","pages":[{"title":"Get Payroll Task Status","deprecated":null,"version":null,"openapi":"/api-reference/preview.json get /gb/organizations/{organization_id}/payrolls/{payroll_status_id}/tasks/payroll-calculation/{task_id}/status","href":"/api-reference/preview/great-britain/get-payroll-task-status"},{"title":"Get Payroll Calculation Results By Status","deprecated":null,"version":null,"openapi":"/api-reference/preview.json get /gb/organizations/{organization_id}/payrolls/{payroll_status_id}/tasks/payroll-calculation/latest/results","href":"/api-reference/preview/great-britain/get-payroll-calculation-results-by-status"},{"title":"Get Payroll Calculation Task Results","deprecated":null,"version":null,"openapi":"/api-reference/preview.json get /gb/organizations/{organization_id}/payrolls/{payroll_status_id}/tasks/payroll-calculation/{task_id}/results","href":"/api-reference/preview/great-britain/get-payroll-calculation-task-results"},{"title":"Get Latest Pension Assessment Preview","deprecated":null,"version":null,"openapi":"/api-reference/preview.json get /gb/organizations/{organization_id}/payrolls/{payroll_status_id}/tasks/payroll-calculation/latest/pension-preview","href":"/api-reference/preview/great-britain/get-latest-pension-assessment-preview"},{"title":"Get Pension Assessment Preview","deprecated":null,"version":null,"openapi":"/api-reference/preview.json get /gb/organizations/{organization_id}/payrolls/{payroll_status_id}/tasks/payroll-calculation/{task_id}/pension-preview","href":"/api-reference/preview/great-britain/get-pension-assessment-preview"}]}]},{"group":"Approve Payroll","pages":[{"title":"Approve Payroll","deprecated":null,"version":null,"openapi":"/api-reference/preview.json post /gb/organizations/{organization_id}/payrolls/{payroll_status_id}/approve","href":"/api-reference/preview/great-britain/approve-payroll"}]}]},{"group":"Pay Items","pages":[{"title":"List Pay Items","deprecated":null,"version":null,"openapi":"/api-reference/preview.json get /gb/organizations/{organization_id}/payruns/{payrun_id}/pay-items","href":"/api-reference/preview/great-britain/list-pay-items"},{"title":"Delete Pay Items","deprecated":null,"version":null,"openapi":"/api-reference/preview.json post /gb/organizations/{organization_id}/payruns/{payrun_id}/pay-items/delete","href":"/api-reference/preview/great-britain/delete-pay-items"}]},{"group":"Pension","pages":[{"title":"List pension schemes","deprecated":null,"version":null,"openapi":"/api-reference/preview.json get /gb/organizations/{organization_id}/pension/schemes","href":"/api-reference/preview/great-britain/list-pension-schemes"},{"title":"Create pension scheme","deprecated":null,"version":null,"openapi":"/api-reference/preview.json post /gb/organizations/{organization_id}/pension/schemes","href":"/api-reference/preview/great-britain/create-pension-scheme"},{"title":"Get pension scheme","deprecated":null,"version":null,"openapi":"/api-reference/preview.json get /gb/organizations/{organization_id}/pension/schemes/{scheme_id}","href":"/api-reference/preview/great-britain/get-pension-scheme"},{"title":"Update pension scheme","deprecated":null,"version":null,"openapi":"/api-reference/preview.json patch /gb/organizations/{organization_id}/pension/schemes/{scheme_id}","href":"/api-reference/preview/great-britain/update-pension-scheme"},{"title":"Get pension scheme history","deprecated":null,"version":null,"openapi":"/api-reference/preview.json get /gb/organizations/{organization_id}/pension/schemes/{scheme_id}/history","href":"/api-reference/preview/great-britain/get-pension-scheme-history"},{"title":"Get pension membership","deprecated":null,"version":null,"openapi":"/api-reference/preview.json get /gb/organizations/{organization_id}/employees/{employee_id}/pension/membership","href":"/api-reference/preview/great-britain/get-pension-membership"},{"title":"Get pension membership history","deprecated":null,"version":null,"openapi":"/api-reference/preview.json get /gb/organizations/{organization_id}/employees/{employee_id}/pension/membership/history","href":"/api-reference/preview/great-britain/get-pension-membership-history"},{"title":"Get auto-enrolment assessments","deprecated":null,"version":null,"openapi":"/api-reference/preview.json get /gb/organizations/{organization_id}/employees/{employee_id}/pension/assessments","href":"/api-reference/preview/great-britain/get-auto-enrolment-assessments"},{"title":"Enrol employee in pension scheme","deprecated":null,"version":null,"openapi":"/api-reference/preview.json post /gb/organizations/{organization_id}/employees/{employee_id}/pension/enrol","href":"/api-reference/preview/great-britain/enrol-employee-in-pension-scheme"},{"title":"Record employee opt-out","deprecated":null,"version":null,"openapi":"/api-reference/preview.json post /gb/organizations/{organization_id}/employees/{employee_id}/pension/opt-out","href":"/api-reference/preview/great-britain/record-employee-opt-out"},{"title":"Update per-employee pension rates","deprecated":null,"version":null,"openapi":"/api-reference/preview.json patch /gb/organizations/{organization_id}/employees/{employee_id}/pension/rates","href":"/api-reference/preview/great-britain/update-per-employee-pension-rates"},{"group":"NEST","pages":[{"title":"Register a new NEST employer","deprecated":null,"version":null,"openapi":"/api-reference/preview.json post /gb/organizations/{organization_id}/pension/nest/setup","href":"/api-reference/preview/great-britain/register-a-new-nest-employer"},{"title":"Connect to an existing NEST employer","deprecated":null,"version":null,"openapi":"/api-reference/preview.json post /gb/organizations/{organization_id}/pension/nest/link","href":"/api-reference/preview/great-britain/connect-to-an-existing-nest-employer"},{"title":"Re-check the NEST employer","deprecated":null,"version":null,"openapi":"/api-reference/preview.json post /gb/organizations/{organization_id}/pension/nest/verify","href":"/api-reference/preview/great-britain/re-check-the-nest-employer"},{"title":"Get NEST connection status","deprecated":null,"version":null,"openapi":"/api-reference/preview.json get /gb/organizations/{organization_id}/pension/nest/status","href":"/api-reference/preview/great-britain/get-nest-connection-status"}]}]},{"group":"Wage Types","pages":[{"title":"List wage types","deprecated":null,"version":null,"openapi":"/api-reference/preview.json get /gb/wage-types","href":"/api-reference/preview/great-britain/list-wage-types"},{"title":"Create wage type","deprecated":null,"version":null,"openapi":"/api-reference/preview.json post /gb/wage-types","href":"/api-reference/preview/great-britain/create-wage-type"},{"title":"Create wage type version","deprecated":null,"version":null,"openapi":"/api-reference/preview.json put /gb/wage-types/{wage_type_code}/versions","href":"/api-reference/preview/great-britain/create-wage-type-version"},{"title":"Get wage type versions","deprecated":null,"version":null,"openapi":"/api-reference/preview.json get /gb/wage-types/{wage_type_code}/versions","href":"/api-reference/preview/great-britain/get-wage-type-versions"},{"title":"Approve wage type","deprecated":null,"version":null,"openapi":"/api-reference/preview.json post /gb/wage-types/{wage_type_code}/approve","href":"/api-reference/preview/great-britain/approve-wage-type"},{"title":"Deprecate wage type","deprecated":null,"version":null,"openapi":"/api-reference/preview.json post /gb/wage-types/{wage_type_code}/deprecate","href":"/api-reference/preview/great-britain/deprecate-wage-type"},{"title":"Get wage types by category","deprecated":null,"version":null,"openapi":"/api-reference/preview.json get /gb/wage-types/categories/{category}","href":"/api-reference/preview/great-britain/get-wage-types-by-category"},{"title":"Get wage type by code","deprecated":null,"version":null,"openapi":"/api-reference/preview.json get /gb/wage-types/{wage_type_code}","href":"/api-reference/preview/great-britain/get-wage-type-by-code"}]},{"group":"Expenses and Benefits","pages":[{"group":"P11D","pages":[{"title":"List P11Ds","deprecated":null,"version":null,"openapi":"/api-reference/preview.json get /gb/organizations/{organization_id}/exb/p11ds","href":"/api-reference/preview/great-britain/list-p11ds"},{"title":"Create P11D Batch","deprecated":null,"version":null,"openapi":"/api-reference/preview.json post /gb/organizations/{organization_id}/exb/p11ds","href":"/api-reference/preview/great-britain/create-p11d-batch"},{"title":"Preview P11Db","deprecated":null,"version":null,"openapi":"/api-reference/preview.json get /gb/organizations/{organization_id}/exb/p11ds/submissions/p11db-preview","href":"/api-reference/preview/great-britain/preview-p11db"},{"title":"Submit P11D Exb","deprecated":null,"version":null,"openapi":"/api-reference/preview.json post /gb/organizations/{organization_id}/exb/p11ds/submissions","href":"/api-reference/preview/great-britain/submit-p11d-exb"},{"title":"List Exb Submissions","deprecated":null,"version":null,"openapi":"/api-reference/preview.json get /gb/organizations/{organization_id}/exb/p11ds/submissions","href":"/api-reference/preview/great-britain/list-exb-submissions"},{"title":"Get Exb Submission","deprecated":null,"version":null,"openapi":"/api-reference/preview.json get /gb/organizations/{organization_id}/exb/p11ds/submissions/{submission_id}","href":"/api-reference/preview/great-britain/get-exb-submission"},{"title":"Delete P11D Batch","deprecated":null,"version":null,"openapi":"/api-reference/preview.json post /gb/organizations/{organization_id}/exb/p11ds/batch-delete","href":"/api-reference/preview/great-britain/delete-p11d-batch"}]},{"group":"P46 Car","pages":[{"title":"Create P46 Car Batch","deprecated":null,"version":null,"openapi":"/api-reference/preview.json post /gb/organizations/{organization_id}/exb/p46cars","href":"/api-reference/preview/great-britain/create-p46-car-batch"},{"title":"List P46 Cars","deprecated":null,"version":null,"openapi":"/api-reference/preview.json get /gb/organizations/{organization_id}/exb/p46cars","href":"/api-reference/preview/great-britain/list-p46-cars"},{"title":"Get P46 Car","deprecated":null,"version":null,"openapi":"/api-reference/preview.json get /gb/organizations/{organization_id}/exb/p46cars/{car_id}","href":"/api-reference/preview/great-britain/get-p46-car"},{"title":"Patch P46 Car","deprecated":null,"version":null,"openapi":"/api-reference/preview.json patch /gb/organizations/{organization_id}/exb/p46cars/{car_id}","href":"/api-reference/preview/great-britain/patch-p46-car"},{"title":"Delete P46 Car Batch","deprecated":null,"version":null,"openapi":"/api-reference/preview.json post /gb/organizations/{organization_id}/exb/p46cars/batch-delete","href":"/api-reference/preview/great-britain/delete-p46-car-batch"}]}]},{"group":"Reports","pages":[{"title":"Generate Gtn Report","deprecated":null,"version":null,"openapi":"/api-reference/preview.json post /gb/organizations/{organization_id}/reports/gtn","href":"/api-reference/preview/great-britain/generate-gtn-report"},{"title":"Generate High Earners Report","deprecated":null,"version":null,"openapi":"/api-reference/preview.json post /gb/organizations/{organization_id}/reports/high-earners","href":"/api-reference/preview/great-britain/generate-high-earners-report"},{"title":"List High Earners","deprecated":null,"version":null,"openapi":"/api-reference/preview.json get /gb/organizations/{organization_id}/reports/high-earners/{tax_year}","href":"/api-reference/preview/great-britain/list-high-earners"},{"title":"Get High Earner Detail","deprecated":null,"version":null,"openapi":"/api-reference/preview.json get /gb/organizations/{organization_id}/reports/high-earners/{tax_year}/employees/{employee_id}","href":"/api-reference/preview/great-britain/get-high-earner-detail"},{"title":"Generate Pension Report","deprecated":null,"version":null,"openapi":"/api-reference/preview.json post /gb/organizations/{organization_id}/reports/pension","href":"/api-reference/preview/great-britain/generate-pension-report"},{"title":"Generate Variance Report","deprecated":null,"version":null,"openapi":"/api-reference/preview.json post /gb/organizations/{organization_id}/reports/variance","href":"/api-reference/preview/great-britain/generate-variance-report"},{"title":"Generate Fps Summary Report","deprecated":null,"version":null,"openapi":"/api-reference/preview.json post /gb/organizations/{organization_id}/reports/fps-summary","href":"/api-reference/preview/great-britain/generate-fps-summary-report"},{"title":"Generate Payroll Liability Report","deprecated":null,"version":null,"openapi":"/api-reference/preview.json post /gb/organizations/{organization_id}/reports/payroll-liability","href":"/api-reference/preview/great-britain/generate-payroll-liability-report"},{"title":"Generate Bank Detail Change Audit Report","deprecated":null,"version":null,"openapi":"/api-reference/preview.json post /gb/organizations/{organization_id}/reports/bank-detail-change-audit","href":"/api-reference/preview/great-britain/generate-bank-detail-change-audit-report"},{"title":"List Reports","deprecated":null,"version":null,"openapi":"/api-reference/preview.json get /gb/organizations/{organization_id}/reports","href":"/api-reference/preview/great-britain/list-reports"},{"title":"Download Report","deprecated":null,"version":null,"openapi":"/api-reference/preview.json get /gb/organizations/{organization_id}/reports/{report_id}/download","href":"/api-reference/preview/great-britain/download-report"},{"title":"Generate Ytd Report","deprecated":null,"version":null,"openapi":"/api-reference/preview.json post /gb/organizations/{organization_id}/employees/{employee_id}/reports/ytd","href":"/api-reference/preview/great-britain/generate-ytd-report"},{"group":"P60","pages":[{"title":"Generate P60","deprecated":null,"version":null,"openapi":"/api-reference/preview.json post /gb/organizations/{organization_id}/reports/p60/{tax_year}/generate","href":"/api-reference/preview/great-britain/generate-p60"},{"title":"List P60","deprecated":null,"version":null,"openapi":"/api-reference/preview.json get /gb/organizations/{organization_id}/reports/p60/{tax_year}","href":"/api-reference/preview/great-britain/list-p60"},{"title":"Get Employee P60","deprecated":null,"version":null,"openapi":"/api-reference/preview.json get /gb/organizations/{organization_id}/reports/p60/{tax_year}/employees/{employee_id}","href":"/api-reference/preview/great-britain/get-employee-p60"},{"title":"Get Employee P60 Pdf","deprecated":null,"version":null,"openapi":"/api-reference/preview.json get /gb/organizations/{organization_id}/reports/p60/{tax_year}/employees/{employee_id}/pdf","href":"/api-reference/preview/great-britain/get-employee-p60-pdf"}]},{"group":"P45","pages":[{"title":"Generate Employee P45","deprecated":null,"version":null,"openapi":"/api-reference/preview.json post /gb/organizations/{organization_id}/reports/p45/employees/{employee_id}/generate","href":"/api-reference/preview/great-britain/generate-employee-p45"},{"title":"Reissue Employee P45","deprecated":null,"version":null,"openapi":"/api-reference/preview.json post /gb/organizations/{organization_id}/reports/p45/employees/{employee_id}/reissue","href":"/api-reference/preview/great-britain/reissue-employee-p45"},{"title":"Get Employee P45","deprecated":null,"version":null,"openapi":"/api-reference/preview.json get /gb/organizations/{organization_id}/reports/p45/employees/{employee_id}","href":"/api-reference/preview/great-britain/get-employee-p45"},{"title":"Get Employee P45 Pdf","deprecated":null,"version":null,"openapi":"/api-reference/preview.json get /gb/organizations/{organization_id}/reports/p45/employees/{employee_id}/pdf","href":"/api-reference/preview/great-britain/get-employee-p45-pdf"},{"title":"Generate P45 Leavers","deprecated":null,"version":null,"openapi":"/api-reference/preview.json post /gb/organizations/{organization_id}/reports/p45-leavers/{tax_year}/generate","href":"/api-reference/preview/great-britain/generate-p45-leavers"}]}]}]}]}]}]},"basePath":"","title":"Get Absence Scheme - Intermezzo Docs","buildId":"dpl_DqYu5MPb49gWBBbUGgpHQUmCHY3P","deploymentId":"dpl_DqYu5MPb49gWBBbUGgpHQUmCHY3P","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-CybtLBIt.js","utils-BMLj2fvV.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-B6In562Y.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-Dr8Mfhp9.js","snippetPresets-2rmQvMVl.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-WMqJYdZj.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-CJ-MlPHu.js","shallow-dY3TMRCk.js","getApiPlaygroundDisplay-v-1B2bKm.js","CodeSnippet-BDhiTB7U.js","CodeSnippets-D9hnzQcS.js","Page-C4GwDT3_.js","getPastedJson-Th2V45jI.js","icon-BQXch1W9.js","MethodPill-BCqUneP3.js","DuplicateIcon-Q_-bhurZ.js","createIcon-DUjLHRqp.js","DynamicMarkdown-B-f2cqXQ.js","SectionHeading-Da5NsV4v.js","axios-vUo_bRtp.js","Markdown-D13FWkIM.js","clsx-D3Isdib3.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-C-XZBk9h.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink--qIqmmVG.js"]}