Valid-time date to read, past or future. Defaults to today, or to the first upcoming edition when nothing is valid yet.
Response
Successful Response
created_at
string<date-time>
required
read-only
created_by
string
required
read-only
Who wrote the edition: the acting user (X-Acting-User, else the access credential), system for our own writes, or <authority>:<notice> for a write on an authority's behalf, e.g. hmrc:P6.
edition
integer
required
read-only
valid_from
string<date>
required
valid_to
string<date>
required
birth_date
string<date> | null
Birth date
first_name
string
default:""
First forename
gender
enum<string> | null
Gender
Available options:
MALE,
FEMALE
last_name
string
default:""
Surname
maiden_name
string | null
Surname before marriage
marital_status
enum<string> | null
Marital status
Available options:
SINGLE,
MARRIED
middle_name
string | null
Second forename
personal_email
string<email> | null
phone_numbers
GBPhonesRead · object[]
Phone numbers
Show child attributes
title
string | null
Title
work_email
string<email> | null
Was this page helpful?
{"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":"6afdea29c82885eda0b9aea7","clientVersion":"0.0.4205","searchFilterCounts":[{"language":"default","tag":"API Reference","count":227},{"language":"default","tag":"Great Britain","count":204},{"language":"default","tag":"Employees","count":52},{"language":"default","tag":"Core","count":43},{"language":"default","tag":"Organizations","count":33},{"language":"default","tag":"Wage Types","count":26},{"language":"default","tag":"Pension","count":25},{"language":"default","tag":"Payroll","count":23},{"language":"default","tag":"Reports","count":22},{"language":"default","tag":"Guides","count":15}]},"assistantConfig":{},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/preview/great-britain/get-core-1","slug":"/api-reference/preview/great-britain/get-core-1","pageMetadata":{"title":"Get Core","description":"`ETag` is the edition read: send it as `If-Match` on the next PUT.","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-1","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_components.p, {\n children: [_jsx(_components.code, {\n children: \"ETag\"\n }), \" is the edition read: send it as \", _jsx(_components.code, {\n children: \"If-Match\"\n }), \" on the next PUT.\"]\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 Core","description":"`ETag` is the edition read: send it as `If-Match` on the next PUT.","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-1","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"description":"`ETag` is the edition read: send it as `If-Match` on the next PUT.","operationId":"gb_employee_core_get","parameters":["b95415ff-cd85-4125-8a77-ffaf56175a46","b6039c5e-bc44-46f6-a4dc-295f3beaf0d3","dc1b77a4-6344-40e8-b8a6-e0c9bcfc4b77"],"responses":{"200":"0b765347-e191-4e48-a822-9b792fe4855d","400":"5181ecaa-e06b-4e07-b2bb-5d027739d410","404":"13aefbe5-c92c-4308-9d14-3ef86ca1cc29","422":"0932f596-6974-4511-92d5-fed17da50469"},"security":["7af97c58-88c6-4ff2-bd7c-1bfeaf27f7fd"],"summary":"Get Core","tags":["Great Britain","Employees","Core"],"method":"get","type":"path","servers":["0a0251d4-b9ef-4650-8cdc-c27a2b5fe346"],"path":"/gb/organizations/{organization_id}/employees/{employee_id}/core","baseUrlOptions":["https://preview.intermezzo.ai"],"title":"Get Core","codeSamples":[],"requiredOnlyExamples":true,"requestExampleType":"generated","responseExampleType":"generated","prefillPlaygroundWithExample":true,"prefillPlaygroundExamples":[]},"dependencies":{"parameters":{"b95415ff-cd85-4125-8a77-ffaf56175a46":{"in":"path","name":"organization_id","required":true,"schema":{"title":"Organization Id","type":"string","isRequired":true,"uniqueKey":"","typeLabel":"string"}},"b6039c5e-bc44-46f6-a4dc-295f3beaf0d3":{"in":"path","name":"employee_id","required":true,"schema":{"title":"Employee Id","type":"string","isRequired":true,"uniqueKey":"","typeLabel":"string"}},"dc1b77a4-6344-40e8-b8a6-e0c9bcfc4b77":{"description":"Valid-time date to read, past or future. Defaults to today, or to the first upcoming edition when nothing is valid yet.","in":"query","name":"valid_at","required":false,"schema":{"oneOf":[{"type":"string","title":"Valid At","description":"Valid-time date to read, past or future. Defaults to today, or to the first upcoming edition when nothing is valid yet.","format":"date","uniqueKey":"oneOf.0","typeLabel":"string\u003cdate>"},{"type":"null","title":"Valid At","description":"Valid-time date to read, past or future. Defaults to today, or to the first upcoming edition when nothing is valid yet.","uniqueKey":"oneOf.1","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"string\u003cdate> | null"}}},"responses":{"0b765347-e191-4e48-a822-9b792fe4855d":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"created_at":{"format":"date-time","readOnly":true,"title":"Created At","type":"string","isRequired":true,"uniqueKey":"created_at","typeLabel":"string\u003cdate-time>"},"created_by":{"description":"Who wrote the edition: the acting user (`X-Acting-User`, else the access credential), `system` for our own writes, or `\u003cauthority>:\u003cnotice>` for a write on an authority's behalf, e.g. `hmrc:P6`.","readOnly":true,"title":"Created By","type":"string","isRequired":true,"uniqueKey":"created_by","typeLabel":"string"},"edition":{"readOnly":true,"title":"Edition","type":"integer","isRequired":true,"uniqueKey":"edition","typeLabel":"integer"},"valid_from":{"format":"date","title":"Valid From","type":"string","isRequired":true,"uniqueKey":"valid_from","typeLabel":"string\u003cdate>"},"valid_to":{"format":"date","title":"Valid To","type":"string","isRequired":true,"uniqueKey":"valid_to","typeLabel":"string\u003cdate>"},"birth_date":{"oneOf":[{"type":"string","title":"Birth Date","description":"Birth date","format":"date","uniqueKey":"birth_date.oneOf.0","typeLabel":"string\u003cdate>"},{"type":"null","title":"Birth Date","description":"Birth date","uniqueKey":"birth_date.oneOf.1","typeLabel":"null"}],"uniqueKey":"birth_date","typeLabel":"string\u003cdate> | null"},"first_name":{"default":"","description":"First forename","title":"First Name","type":"string","uniqueKey":"first_name","typeLabel":"string"},"gender":{"oneOf":[{"type":"string","title":"EmployeeGender","description":"Gender","enum":["MALE","FEMALE"],"uniqueKey":"gender.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","description":"Gender","uniqueKey":"gender.oneOf.1","typeLabel":"null"}],"uniqueKey":"gender","typeLabel":"enum\u003cstring> | null"},"last_name":{"default":"","description":"Surname","title":"Last Name","type":"string","uniqueKey":"last_name","typeLabel":"string"},"maiden_name":{"oneOf":[{"type":"string","title":"Maiden Name","description":"Surname before marriage","uniqueKey":"maiden_name.oneOf.0","typeLabel":"string"},{"type":"null","title":"Maiden Name","description":"Surname before marriage","uniqueKey":"maiden_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"maiden_name","typeLabel":"string | null"},"marital_status":{"oneOf":[{"type":"string","title":"MaritalStatus","description":"Marital status","enum":["SINGLE","MARRIED"],"uniqueKey":"marital_status.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","description":"Marital status","uniqueKey":"marital_status.oneOf.1","typeLabel":"null"}],"uniqueKey":"marital_status","typeLabel":"enum\u003cstring> | null"},"middle_name":{"oneOf":[{"type":"string","title":"Middle Name","description":"Second forename","uniqueKey":"middle_name.oneOf.0","typeLabel":"string"},{"type":"null","title":"Middle Name","description":"Second forename","uniqueKey":"middle_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"middle_name","typeLabel":"string | null"},"personal_email":{"oneOf":[{"type":"string","title":"Personal Email","format":"email","uniqueKey":"personal_email.oneOf.0","typeLabel":"string\u003cemail>"},{"type":"null","title":"Personal Email","uniqueKey":"personal_email.oneOf.1","typeLabel":"null"}],"uniqueKey":"personal_email","typeLabel":"string\u003cemail> | null"},"phone_numbers":{"description":"Phone numbers","items":{"additionalProperties":false,"properties":{"phone_number":{"format":"phone","title":"Phone Number","type":"string","isRequired":true,"uniqueKey":"phone_numbers.items.[INDEX].phone_number","typeLabel":"string\u003cphone>"},"phone_type":{"enum":["MOBILE","HOME","WORK"],"title":"PhoneType","type":"string","isRequired":true,"uniqueKey":"phone_numbers.items.[INDEX].phone_type","typeLabel":"enum\u003cstring>"},"is_primary":{"oneOf":[{"type":"boolean","title":"Is Primary","description":"Is this the primary phone number for the employee?","default":false,"uniqueKey":"phone_numbers.items.[INDEX].is_primary.oneOf.0","typeLabel":"boolean"},{"type":"null","title":"Is Primary","description":"Is this the primary phone number for the employee?","default":false,"uniqueKey":"phone_numbers.items.[INDEX].is_primary.oneOf.1","typeLabel":"null"}],"uniqueKey":"phone_numbers.items.[INDEX].is_primary","typeLabel":"boolean | null"}},"required":["phone_number","phone_type"],"title":"GBPhonesRead","type":"object","uniqueKey":"phone_numbers.items.[INDEX]","typeLabel":"GBPhonesRead · object"},"title":"Phone Numbers","type":"array","uniqueKey":"phone_numbers","typeLabel":"GBPhonesRead · object[]"},"title":{"oneOf":[{"type":"string","title":"Title","description":"Title","uniqueKey":"title.oneOf.0","typeLabel":"string"},{"type":"null","title":"Title","description":"Title","uniqueKey":"title.oneOf.1","typeLabel":"null"}],"uniqueKey":"title","typeLabel":"string | null"},"work_email":{"oneOf":[{"type":"string","title":"Work Email","format":"email","uniqueKey":"work_email.oneOf.0","typeLabel":"string\u003cemail>"},{"type":"null","title":"Work Email","uniqueKey":"work_email.oneOf.1","typeLabel":"null"}],"uniqueKey":"work_email","typeLabel":"string\u003cemail> | null"}},"required":["edition","valid_from","valid_to","created_at","created_by"],"title":"GBEmployeeCoreSatellite","type":"object","uniqueKey":"","typeLabel":"GBEmployeeCoreSatellite · object"},"examples":{"Example":{"title":"Example","value":{"created_at":"2023-11-07T05:31:56Z","created_by":"\u003cstring>","edition":123,"valid_from":"2023-12-25","valid_to":"2023-12-25","birth_date":"2023-12-25","first_name":"","gender":"MALE","last_name":"","maiden_name":"\u003cstring>","marital_status":"SINGLE","middle_name":"\u003cstring>","personal_email":"jsmith@example.com","phone_numbers":[{"phone_number":"\u003cstring>","phone_type":"MOBILE","is_primary":false}],"title":"\u003cstring>","work_email":"jsmith@example.com"}}},"exampleType":"generated"}},"description":"Successful Response","exampleType":"generated"},"5181ecaa-e06b-4e07-b2bb-5d027739d410":{"content":{"application/json":{"examples":{"ORG_BELONGS_TO_A_DIFFERENT_COUNTRY":{"title":"ORG_BELONGS_TO_A_DIFFERENT_COUNTRY","summary":"Raised when an organization belongs to a different country than the one in the path.","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."}]}}},"schema":{"properties":{"errors":{"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., \"HUB_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":{"description":"Unique error code for i18n lookup","enum":["ORG_BELONGS_TO_A_DIFFERENT_COUNTRY"],"title":"Code","type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].code","typeLabel":"enum\u003cstring>"},"message":{"description":"English fallback error message","title":"Message","type":"string","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"},"type":"array","isRequired":true,"uniqueKey":"errors","typeLabel":"ErrorDetail · object[]"}},"required":["errors"],"title":"ErrorResponse","type":"object","uniqueKey":"","typeLabel":"ErrorResponse · object"},"exampleType":"examples"}},"description":"- `ORG_BELONGS_TO_A_DIFFERENT_COUNTRY`: Raised when an organization belongs to a different country than the one in the path.","exampleType":"examples"},"13aefbe5-c92c-4308-9d14-3ef86ca1cc29":{"content":{"application/json":{"examples":{"HUB_NOT_FOUND":{"title":"HUB_NOT_FOUND","summary":"Raised when a hub does not exist under the parent named in the path.","value":{"errors":[{"code":"HUB_NOT_FOUND","message":"Raised when a hub does not exist under the parent named in the path."}]}},"SATELLITE_NOT_FOUND":{"title":"SATELLITE_NOT_FOUND","summary":"Raised on a read of a satellite that was never written: neither sent when its hub was created nor written by a PUT since.","value":{"errors":[{"code":"SATELLITE_NOT_FOUND","message":"Raised on a read of a satellite that was never written: neither sent when its hub was created nor written by a PUT since."}]}}},"schema":{"properties":{"errors":{"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., \"HUB_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":{"description":"Unique error code for i18n lookup","enum":["HUB_NOT_FOUND","SATELLITE_NOT_FOUND"],"title":"Code","type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].code","typeLabel":"enum\u003cstring>"},"message":{"description":"English fallback error message","title":"Message","type":"string","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"},"type":"array","isRequired":true,"uniqueKey":"errors","typeLabel":"ErrorDetail · object[]"}},"required":["errors"],"title":"ErrorResponse","type":"object","uniqueKey":"","typeLabel":"ErrorResponse · object"},"exampleType":"examples"}},"description":"- `HUB_NOT_FOUND`: Raised when a hub does not exist under the parent named in the path.\n- `HUB_NOT_FOUND`: Raised when a hub does not exist under the parent named in the path.\n- `SATELLITE_NOT_FOUND`: Raised on a read of a satellite that was never written: neither sent when its hub was created nor written by a PUT since.","exampleType":"examples"},"0932f596-6974-4511-92d5-fed17da50469":{"content":{"application/json":{"examples":{"VALUE_OUT_OF_RANGE":{"title":"VALUE_OUT_OF_RANGE","summary":"Raised when a date lies outside the satellite's coverage.","value":{"errors":[{"code":"VALUE_OUT_OF_RANGE","message":"Raised when a date lies outside the satellite's coverage."}]}}},"schema":{"properties":{"errors":{"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., \"HUB_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":{"description":"Unique error code for i18n lookup","enum":["VALUE_OUT_OF_RANGE","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","type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].code","typeLabel":"enum\u003cstring>"},"message":{"description":"English fallback error message","title":"Message","type":"string","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"},"type":"array","isRequired":true,"uniqueKey":"errors","typeLabel":"ErrorDetail · object[]"}},"required":["errors"],"title":"ErrorResponse","type":"object","uniqueKey":"","typeLabel":"ErrorResponse · object"},"exampleType":"examples"}},"description":"The request failed validation. Type and format errors use the generic FIELD_* codes.\n- `VALUE_OUT_OF_RANGE`: Raised when a date lies outside the satellite's coverage.","exampleType":"examples"}},"security":{"7af97c58-88c6-4ff2-bd7c-1bfeaf27f7fd":{"BearerToken":{"bearerFormat":"JWT","description":"Get token from Auth0 and paste it here","scheme":"bearer","type":"http","scopes":[],"schemeName":"BearerToken"}}},"servers":{"0a0251d4-b9ef-4650-8cdc-c27a2b5fe346":{"description":"Preview","url":"https://preview.intermezzo.ai"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"bearerFormat":"JWT","description":"Get token from Auth0 and paste it here","scheme":"bearer","type":"http","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 Core - Intermezzo Docs","navMaps":{"firstHrefInVersion":{"Preview":{"href":"/api-reference/preview/great-britain/get-core-1","matchLevel":0}},"firstHrefInLanguage":{}},"lastModified":"2026-11-18T18:11:01.148Z","originalFileLocation":"api-reference/preview/great-britain/get-core-1.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=\"ETag is the edition read: send it as If-Match on the next PUT.\">\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 Core - Intermezzo Docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"ETag is the edition read: send it as If-Match on the next PUT.\">\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-core-1\">\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=Core\u0026amp;title=Get+Core\u0026amp;description=%60ETag%60+is+the+edition+read%3A+send+it+as+%60If-Match%60+on+the+next+PUT.\u0026amp;theme=2cc41bc2d4d72760d1901e1b\u0026amp;signature=2473d23cb0dd161c3beec3bba7e56273f15c15afedb68a0d4ff72821b9b58453\">\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 Core - Intermezzo Docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"ETag is the edition read: send it as If-Match on the next PUT.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://intermezzo.mintlify.site/_mintlify/api/og/v2?division=Core\u0026amp;title=Get+Core\u0026amp;description=%60ETag%60+is+the+edition+read%3A+send+it+as+%60If-Match%60+on+the+next+PUT.\u0026amp;theme=2cc41bc2d4d72760d1901e1b\u0026amp;signature=2473d23cb0dd161c3beec3bba7e56273f15c15afedb68a0d4ff72821b9b58453\">\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-core-1\">\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-core-1.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-core-1#webpage\",\"url\":\"https://docs.intermezzo.ai/api-reference/preview/great-britain/get-core-1\",\"name\":\"Get Core\",\"description\":\"ETag is the edition read: send it as If-Match on the next PUT.\",\"dateModified\":\"2026-11-18T18:11:01.148Z\",\"isPartOf\":{\"@id\":\"https://docs.intermezzo.ai#website\"},\"breadcrumb\":{\"@id\":\"https://docs.intermezzo.ai/api-reference/preview/great-britain/get-core-1#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.intermezzo.ai/api-reference/preview/great-britain/get-core-1#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Great Britain\",\"item\":\"https://docs.intermezzo.ai/api-reference/preview/great-britain/list-organizations\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Employees\",\"item\":\"https://docs.intermezzo.ai/api-reference/preview/great-britain/list-employees\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Get Core\",\"item\":\"https://docs.intermezzo.ai/api-reference/preview/great-britain/get-core-1\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.intermezzo.ai/api-reference/preview/great-britain/get-core-1#apireference\",\"headline\":\"Get Core\",\"name\":\"Get Core\",\"description\":\"ETag is the edition read: send it as If-Match on the next PUT.\",\"url\":\"https://docs.intermezzo.ai/api-reference/preview/great-britain/get-core-1\",\"mainEntityOfPage\":{\"@id\":\"https://docs.intermezzo.ai/api-reference/preview/great-britain/get-core-1#webpage\"},\"dateModified\":\"2026-11-18T18:11:01.148Z\",\"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-core-1.md","siteName":"Intermezzo Docs","nav":{"global":null,"versions":[{"version":"Preview","tabs":[{"tab":"Guides","pages":[{"title":"Guides","href":""}]},{"tab":"API Reference","groups":[{"group":"Great Britain","pages":[{"group":"Organizations","pages":[{"title":"List Organizations","deprecated":null,"version":null,"openapi":"/api-reference/preview.json get /gb/organizations","href":"/api-reference/preview/great-britain/list-organizations"},{"title":"Create Organization","deprecated":null,"version":null,"openapi":"/api-reference/preview.json post /gb/organizations","href":"/api-reference/preview/great-britain/create-organization"},{"title":"Create Organizations","deprecated":null,"version":null,"openapi":"/api-reference/preview.json post /gb/organizations/list","href":"/api-reference/preview/great-britain/create-organizations"},{"title":"Get Organization","deprecated":null,"version":null,"openapi":"/api-reference/preview.json get /gb/organizations/{organization_id}","href":"/api-reference/preview/great-britain/get-organization"},{"title":"Close Organization","deprecated":null,"version":null,"openapi":"/api-reference/preview.json post /gb/organizations/{organization_id}/close","href":"/api-reference/preview/great-britain/close-organization"},{"title":"Set HMRC Credentials","deprecated":null,"version":null,"openapi":"/api-reference/preview.json put /gb/organizations/{organization_id}/hmrc-credentials","href":"/api-reference/preview/great-britain/set-hmrc-credentials"},{"title":"Get Organization Status","deprecated":null,"version":null,"openapi":"/api-reference/preview.json get /gb/organizations/{organization_id}/status","href":"/api-reference/preview/great-britain/get-organization-status"},{"group":"Address","pages":[{"title":"Get Address","deprecated":null,"version":null,"openapi":"/api-reference/preview.json get /gb/organizations/{organization_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}/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}/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}/address/protocol","href":"/api-reference/preview/great-britain/get-address-protocol"}]},{"group":"Bank","pages":[{"title":"Get Bank","deprecated":null,"version":null,"openapi":"/api-reference/preview.json get /gb/organizations/{organization_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}/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}/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}/bank/protocol","href":"/api-reference/preview/great-britain/get-bank-protocol"}]},{"group":"Contact","pages":[{"title":"Get Contact","deprecated":null,"version":null,"openapi":"/api-reference/preview.json get /gb/organizations/{organization_id}/contact","href":"/api-reference/preview/great-britain/get-contact"},{"title":"Create Contact Edition","deprecated":null,"version":null,"openapi":"/api-reference/preview.json put /gb/organizations/{organization_id}/contact","href":"/api-reference/preview/great-britain/create-contact-edition"},{"title":"Get Contact Editions","deprecated":null,"version":null,"openapi":"/api-reference/preview.json get /gb/organizations/{organization_id}/contact/editions","href":"/api-reference/preview/great-britain/get-contact-editions"},{"title":"Get Contact Protocol","deprecated":null,"version":null,"openapi":"/api-reference/preview.json get /gb/organizations/{organization_id}/contact/protocol","href":"/api-reference/preview/great-britain/get-contact-protocol"}]},{"group":"Core","pages":[{"title":"Get Core","deprecated":null,"version":null,"openapi":"/api-reference/preview.json get /gb/organizations/{organization_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}/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}/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}/core/protocol","href":"/api-reference/preview/great-britain/get-core-protocol"}]},{"group":"Insurance","pages":[{"title":"Get Insurance","deprecated":null,"version":null,"openapi":"/api-reference/preview.json get /gb/organizations/{organization_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}/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}/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}/insurance/protocol","href":"/api-reference/preview/great-britain/get-insurance-protocol"}]},{"group":"Tax","pages":[{"title":"Get Tax","deprecated":null,"version":null,"openapi":"/api-reference/preview.json get /gb/organizations/{organization_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}/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}/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}/tax/protocol","href":"/api-reference/preview/great-britain/get-tax-protocol"}]}]},{"group":"Absence Schemes","pages":[{"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":"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":"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"},{"title":"List Absence Schemes","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":"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":"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":"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","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":"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"}]},{"group":"Employees","pages":[{"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 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":"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":"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-1"},{"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-1"},{"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-1"},{"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-1"}]},{"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-1"},{"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-1"},{"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-1"},{"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-1"}]},{"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","description":"Every edition ever written, cancellations included, ordered by `edition`: the order they were written in, or newest first with `order=desc`.","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":"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-1"},{"title":"Create Core Edition","description":"`If-Match` carries the `edition` of the slice the range starts in, as read. A satellite not yet written is created by a PUT with `If-None-Match: *` instead, on a range that runs to `9999-12-31`. The response's `ETag` is the edition written.","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-1"},{"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-1"},{"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-1"}]},{"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-1"},{"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-1"},{"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-1"},{"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-1"}]},{"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-1"},{"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-1"},{"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-1"},{"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-1"}]}]},{"group":"Absences","pages":[{"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":"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"},{"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":"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"}]},{"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":"Pension","pages":[{"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":"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":"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"},{"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"},{"group":"NEST","pages":[{"title":"Record members already in NEST","deprecated":null,"version":null,"openapi":"/api-reference/preview.json post /gb/organizations/{organization_id}/pension/nest/baseline","href":"/api-reference/preview/great-britain/record-members-already-in-nest"},{"title":"Set the NEST employer for file upload","deprecated":null,"version":null,"openapi":"/api-reference/preview.json put /gb/organizations/{organization_id}/pension/nest/file-employer","href":"/api-reference/preview/great-britain/set-the-nest-employer-for-file-upload"},{"title":"List NEST files","deprecated":null,"version":null,"openapi":"/api-reference/preview.json get /gb/organizations/{organization_id}/pension/nest/files","href":"/api-reference/preview/great-britain/list-nest-files"},{"title":"Generate a NEST contribution schedule (CS) file","deprecated":null,"version":null,"openapi":"/api-reference/preview.json post /gb/organizations/{organization_id}/pension/nest/files/cs","href":"/api-reference/preview/great-britain/generate-a-nest-contribution-schedule-cs-file"},{"title":"Generate a NEST enrol workers (ME) file","deprecated":null,"version":null,"openapi":"/api-reference/preview.json post /gb/organizations/{organization_id}/pension/nest/files/me","href":"/api-reference/preview/great-britain/generate-a-nest-enrol-workers-me-file"},{"title":"Get a NEST file","deprecated":null,"version":null,"openapi":"/api-reference/preview.json get /gb/organizations/{organization_id}/pension/nest/files/{file_id}","href":"/api-reference/preview/great-britain/get-a-nest-file"},{"title":"Download a NEST file","deprecated":null,"version":null,"openapi":"/api-reference/preview.json get /gb/organizations/{organization_id}/pension/nest/files/{file_id}/download","href":"/api-reference/preview/great-britain/download-a-nest-file"},{"title":"Report that a contribution schedule was approved in NEST","deprecated":null,"version":null,"openapi":"/api-reference/preview.json post /gb/organizations/{organization_id}/pension/nest/files/{file_id}/mark-approved","href":"/api-reference/preview/great-britain/report-that-a-contribution-schedule-was-approved-in-nest"},{"title":"Report that a NEST file was uploaded","deprecated":null,"version":null,"openapi":"/api-reference/preview.json post /gb/organizations/{organization_id}/pension/nest/files/{file_id}/mark-uploaded","href":"/api-reference/preview/great-britain/report-that-a-nest-file-was-uploaded"},{"title":"Report that a rejected member was fixed in NEST","deprecated":null,"version":null,"openapi":"/api-reference/preview.json post /gb/organizations/{organization_id}/pension/nest/files/{file_id}/members/{employee_id}/mark-resolved","href":"/api-reference/preview/great-britain/report-that-a-rejected-member-was-fixed-in-nest"},{"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":"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":"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"},{"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"}]}]},{"group":"Reports","pages":[{"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"},{"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":"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":"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 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 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 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 Statutory Payments Report","deprecated":null,"version":null,"openapi":"/api-reference/preview.json post /gb/organizations/{organization_id}/reports/statutory-payments","href":"/api-reference/preview/great-britain/generate-statutory-payments-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":"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"},{"group":"P45","pages":[{"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"},{"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":"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":"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":"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"}]},{"group":"P60","pages":[{"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"},{"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"}]}]},{"group":"Payroll","pages":[{"title":"Request a payslip bundle","deprecated":null,"version":null,"openapi":"/api-reference/preview.json post /gb/organizations/{organization_id}/payrolls/payslips/bundles","href":"/api-reference/preview/great-britain/request-a-payslip-bundle"},{"title":"Poll a payslip bundle","deprecated":null,"version":null,"openapi":"/api-reference/preview.json get /gb/organizations/{organization_id}/payrolls/payslips/bundles/{bundle_id}","href":"/api-reference/preview/great-britain/poll-a-payslip-bundle"},{"group":"Post Payroll","pages":[{"group":"HMRC Filing","pages":[{"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":"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":"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":"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"},{"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":"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"}]},{"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":"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"},{"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"}]}]},{"group":"Run Payroll","pages":[{"title":"Run Payroll","deprecated":true,"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 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 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 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"},{"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 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"}]}]},{"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":"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":"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"},{"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":"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":"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":"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"}]},{"group":"P46 Car","pages":[{"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":"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":"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"},{"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"}]}]},{"group":"Pay Runs","pages":[{"title":"Create Payrun","deprecated":null,"version":null,"openapi":"/api-reference/preview.json post /gb/organizations/{organization_id}/payruns","href":"/api-reference/preview/great-britain/create-payrun"},{"title":"Calculate Payrun","deprecated":null,"version":null,"openapi":"/api-reference/preview.json post /gb/organizations/{organization_id}/payruns/{payrun_id}/calculate","href":"/api-reference/preview/great-britain/calculate-payrun"},{"title":"Cancel Payrun","deprecated":null,"version":null,"openapi":"/api-reference/preview.json post /gb/organizations/{organization_id}/payruns/{payrun_id}/cancel","href":"/api-reference/preview/great-britain/cancel-payrun"},{"title":"Move Employees","deprecated":null,"version":null,"openapi":"/api-reference/preview.json post /gb/organizations/{organization_id}/payruns/{payrun_id}/employees/move","href":"/api-reference/preview/great-britain/move-employees"}]},{"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":"Add Pay Items","deprecated":null,"version":null,"openapi":"/api-reference/preview.json post /gb/organizations/{organization_id}/payruns/{payrun_id}/pay-items","href":"/api-reference/preview/great-britain/add-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":"Wage Types","pages":[{"title":"List Wage Types","deprecated":null,"version":null,"openapi":"/api-reference/preview.json get /gb/organizations/{organization_id}/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/organizations/{organization_id}/wage-types","href":"/api-reference/preview/great-britain/create-wage-type"},{"title":"Create Wage Types","deprecated":null,"version":null,"openapi":"/api-reference/preview.json post /gb/organizations/{organization_id}/wage-types/list","href":"/api-reference/preview/great-britain/create-wage-types"},{"title":"Get Wage Type","deprecated":null,"version":null,"openapi":"/api-reference/preview.json get /gb/organizations/{organization_id}/wage-types/{wage_type_id}","href":"/api-reference/preview/great-britain/get-wage-type"},{"title":"Approve Wage Type","deprecated":null,"version":null,"openapi":"/api-reference/preview.json post /gb/organizations/{organization_id}/wage-types/{wage_type_id}/approve","href":"/api-reference/preview/great-britain/approve-wage-type"},{"title":"Close Wage Type","deprecated":null,"version":null,"openapi":"/api-reference/preview.json post /gb/organizations/{organization_id}/wage-types/{wage_type_id}/close","href":"/api-reference/preview/great-britain/close-wage-type"},{"title":"Deprecate Wage Type","deprecated":null,"version":null,"openapi":"/api-reference/preview.json post /gb/organizations/{organization_id}/wage-types/{wage_type_id}/deprecate","href":"/api-reference/preview/great-britain/deprecate-wage-type"},{"title":"Dry-Run Wage Type Computation","deprecated":null,"version":null,"openapi":"/api-reference/preview.json post /gb/organizations/{organization_id}/wage-types/{wage_type_id}/dry-run","href":"/api-reference/preview/great-britain/dry-run-wage-type-computation"},{"title":"Explain Wage Type Computation","deprecated":null,"version":null,"openapi":"/api-reference/preview.json get /gb/organizations/{organization_id}/wage-types/{wage_type_id}/explain","href":"/api-reference/preview/great-britain/explain-wage-type-computation"},{"title":"List Catalog Wage Types","deprecated":null,"version":null,"openapi":"/api-reference/preview.json get /gb/wage-types","href":"/api-reference/preview/great-britain/list-catalog-wage-types"},{"title":"Get Catalog Wage Type","deprecated":null,"version":null,"openapi":"/api-reference/preview.json get /gb/wage-types/{wage_type_id}","href":"/api-reference/preview/great-britain/get-catalog-wage-type"},{"group":"Computation","pages":[{"title":"Get Computation","deprecated":null,"version":null,"openapi":"/api-reference/preview.json get /gb/organizations/{organization_id}/wage-types/{wage_type_id}/computation","href":"/api-reference/preview/great-britain/get-computation"},{"title":"Create Computation Edition","deprecated":null,"version":null,"openapi":"/api-reference/preview.json put /gb/organizations/{organization_id}/wage-types/{wage_type_id}/computation","href":"/api-reference/preview/great-britain/create-computation-edition"},{"title":"Get Computation Editions","deprecated":null,"version":null,"openapi":"/api-reference/preview.json get /gb/organizations/{organization_id}/wage-types/{wage_type_id}/computation/editions","href":"/api-reference/preview/great-britain/get-computation-editions"},{"title":"Get Computation Protocol","deprecated":null,"version":null,"openapi":"/api-reference/preview.json get /gb/organizations/{organization_id}/wage-types/{wage_type_id}/computation/protocol","href":"/api-reference/preview/great-britain/get-computation-protocol"}]},{"group":"Core","pages":[{"title":"Get Core","deprecated":null,"version":null,"openapi":"/api-reference/preview.json get /gb/organizations/{organization_id}/wage-types/{wage_type_id}/core","href":"/api-reference/preview/great-britain/get-core-2"},{"title":"Create Core Edition","deprecated":null,"version":null,"openapi":"/api-reference/preview.json put /gb/organizations/{organization_id}/wage-types/{wage_type_id}/core","href":"/api-reference/preview/great-britain/create-core-edition-2"},{"title":"Get Core Editions","deprecated":null,"version":null,"openapi":"/api-reference/preview.json get /gb/organizations/{organization_id}/wage-types/{wage_type_id}/core/editions","href":"/api-reference/preview/great-britain/get-core-editions-2"},{"title":"Get Core Protocol","deprecated":null,"version":null,"openapi":"/api-reference/preview.json get /gb/organizations/{organization_id}/wage-types/{wage_type_id}/core/protocol","href":"/api-reference/preview/great-britain/get-core-protocol-2"}]},{"group":"Lifecycle","pages":[{"title":"Get Lifecycle","deprecated":null,"version":null,"openapi":"/api-reference/preview.json get /gb/organizations/{organization_id}/wage-types/{wage_type_id}/lifecycle","href":"/api-reference/preview/great-britain/get-lifecycle"},{"title":"Get Lifecycle Editions","deprecated":null,"version":null,"openapi":"/api-reference/preview.json get /gb/organizations/{organization_id}/wage-types/{wage_type_id}/lifecycle/editions","href":"/api-reference/preview/great-britain/get-lifecycle-editions"},{"title":"Get Lifecycle Protocol","deprecated":null,"version":null,"openapi":"/api-reference/preview.json get /gb/organizations/{organization_id}/wage-types/{wage_type_id}/lifecycle/protocol","href":"/api-reference/preview/great-britain/get-lifecycle-protocol"}]},{"group":"Treatment","pages":[{"title":"Get Treatment","deprecated":null,"version":null,"openapi":"/api-reference/preview.json get /gb/organizations/{organization_id}/wage-types/{wage_type_id}/treatment","href":"/api-reference/preview/great-britain/get-treatment"},{"title":"Create Treatment Edition","deprecated":null,"version":null,"openapi":"/api-reference/preview.json put /gb/organizations/{organization_id}/wage-types/{wage_type_id}/treatment","href":"/api-reference/preview/great-britain/create-treatment-edition"},{"title":"Get Treatment Editions","deprecated":null,"version":null,"openapi":"/api-reference/preview.json get /gb/organizations/{organization_id}/wage-types/{wage_type_id}/treatment/editions","href":"/api-reference/preview/great-britain/get-treatment-editions"},{"title":"Get Treatment Protocol","deprecated":null,"version":null,"openapi":"/api-reference/preview.json get /gb/organizations/{organization_id}/wage-types/{wage_type_id}/treatment/protocol","href":"/api-reference/preview/great-britain/get-treatment-protocol"}]}]}]},{"group":"Core","pages":[{"group":"Employees","pages":[{"group":"Absences","pages":[{"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":"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":"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","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":"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"},{"title":"Take Over Absence Calculation","deprecated":null,"version":null,"openapi":"/api-reference/preview.json post /organizations/{organization_id}/employees/{employee_id}/absences/{absence_id}/lifecycle/take-over-calculation","href":"/api-reference/preview/core/take-over-absence-calculation"}]},{"group":"Documents","pages":[{"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":"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":"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":"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"},{"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"}]}]},{"group":"Organizations","pages":[{"group":"Logo","pages":[{"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"},{"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"}]}]},{"group":"Payrolls","pages":[{"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":"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"},{"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"},{"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":"Webhooks","pages":[{"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"},{"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":"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":"Rotate Partner Webhook","deprecated":null,"version":null,"openapi":"/api-reference/preview.json post /webhooks/{category}/rotate","href":"/api-reference/preview/core/rotate-partner-webhook"}]}]}]}]}]},"basePath":"","title":"Get Core - Intermezzo Docs","deploymentId":"dpl_FZMKUpaaKiVETbfqhoUe4sPFDTmY","buildId":"dpl_FZMKUpaaKiVETbfqhoUe4sPFDTmY","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-B6WFFOBL.js","utils-BN5um1KA.js","cloneDeep-C3md22mN.js","_Uint8Array-DLlL8L26.js","isObject-FP1Yky1u.js","utils-BSmbkXJR.js","addUniqueKeysToSchema-2tqcVnUE.js","snippetPresets-CtWfvr2J.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-DkKHBy30.js","isEqual-O3q7y6pq.js","usePlaygroundInputsStore-Brc5H9UJ.js","shallow-C4L4xvbs.js","getApiPlaygroundDisplay-2bxyq_aI.js","CodeSnippet-BJu8ddd5.js","CodeSnippets-dazWmoqB.js","Page-CnLhKuUV.js","getPastedJson-Chy3Qa1S.js","icon-CyO7h3jh.js","MethodPill-Dle0_91v.js","DuplicateIcon-CVvWAf4a.js","createIcon-Di07A27B.js","DynamicMarkdown-C4w9kavL.js","SectionHeading-XiBebVYC.js","axios-vUo_bRtp.js","Markdown-DTeL0SpS.js","dist-OCScizqf.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","katex-YMM-FMeD.js","html-void-elements-mCSPHezU.js","marked.esm-CZWythHk.js","AssistantPageLink-KcneGfMY.js"]}