The person acting through the access credential, recorded as created_by of what the request writes. Audit only: access is checked on the credential.
Required string length: 1 - 255
Path Parameters
organization_id
string
required
Body
application/json
Creating an employee: the hub, valid_from, core, and any other satellites.
Each satellite sent starts on [valid_from, 9999-12-31). One not sent is not
created: it reads as null until a PUT writes it, so an employee created without
job is in no pay group until then.
core
GBEmployeeCore · object
required
Identity of the person, as payroll and filing need it.
Each name field holds one name: a person with several middle names sends the one that
should appear on HMRC returns. If only initials are known, they go one per field
(first_name "J", middle_name "M"). An optional name the person does not have is
null.
Show child attributes
valid_from
string<date>
required
The first day every satellite's data is valid at
address
GBEmployeeAddress · object
The person's residence address, as filed to HMRC.
Show child attributes
bank
GBEmployeeBank · object
Show child attributes
compensation
GBEmployeeCompensation · object
Standing pay elements.
Show child attributes
external_ref
string
The integrator's own key, unique within the parent and never changed. A path may name the hub as ext:{external_ref}.
Required string length: 1 - 255
Pattern: ^[A-Za-z0-9._~-]+$
insurance
GBEmployeeInsurance · object
Show child attributes
job
GBEmployeeJob · object
The terms of the employment as a client writes them.
Show child attributes
tax
GBEmployeeTax · object
Show child attributes
Response
Successful Response
The employee with every satellite as it reads on one date. A satellite never
written, or with no slice on an explicit date, is null.
created_at
string<date-time>
required
read-only
created_by
string
required
read-only
Who created the hub: 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.
deleted_at
string<date-time> | null
required
When the hub was closed
external_ref
string | null
required
id
string
required
organization_id
string
required
status
GBEmployeeStatus · object
required
The read-only status satellite. It carries no fields; it exists so that every
employee read has a status object.
address
GBEmployeeAddressSatellite · object | null
Show child attributes
bank
GBEmployeeBankSatellite · object | null
Show child attributes
compensation
GBEmployeeCompensationSatellite · object | null
Show child attributes
core
GBEmployeeCoreSatellite · object | null
Show child attributes
insurance
GBEmployeeInsuranceSatellite · object | null
Show child attributes
job
GBEmployeeJobSatellite · object | null
Show child attributes
tax
GBEmployeeTaxSatellite · object | null
Show child attributes
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.4270","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":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"site-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"starter-pricing","enabled":true,"variant":{"name":"treatment","enabled":true,"payload":{"type":"string","value":"treatment"},"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"wildcard-email-auth","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[]}
{"page":{"pagePath":"api-reference/preview/great-britain/create-employee","slug":"/api-reference/preview/great-britain/create-employee","pageMetadata":{"title":"Create Employee","description":null,"deprecated":null,"version":null,"openapi":"/api-reference/preview.json post /gb/organizations/{organization_id}/employees","href":"/api-reference/preview/great-britain/create-employee","autogeneratedByOpenApi":true},"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":"Create Employee","description":null,"deprecated":null,"version":null,"openapi":"/api-reference/preview.json post /gb/organizations/{organization_id}/employees","href":"/api-reference/preview/great-britain/create-employee","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"gb_employee_create","parameters":["e98d3441-3b32-4375-ae6f-a1f682da2c07","392d15a2-2e42-478c-8606-47d0ddf4ade2"],"requestBody":"494dd647-2e69-44c7-9d11-c3c5058ea386","responses":{"201":"f25cab16-ed54-481d-bf07-00257c33ac8a","400":"31c8bec5-edf3-472c-b003-d40992fc66be","404":"d9f87012-cc09-4c70-aeda-89fea6981d57","409":"f63c5b86-5fd3-43eb-928f-e4e488f9bd41","422":"ba1e03ba-1a12-4994-9281-04955350c096"},"security":["66b3ff6d-9c33-4dbf-b8d8-5244c035f4c7"],"summary":"Create Employee","tags":["Great Britain","Employees"],"method":"post","type":"path","servers":["0a0251d4-b9ef-4650-8cdc-c27a2b5fe346"],"path":"/gb/organizations/{organization_id}/employees","baseUrlOptions":["https://preview.intermezzo.ai"],"title":"Create Employee","description":"","codeSamples":[],"requiredOnlyExamples":true,"requestExampleType":"generated","responseExampleType":"generated","prefillPlaygroundWithExample":true,"prefillPlaygroundExamples":[{"body.core.birth_date":"2023-12-25","body.core.first_name":"Sarah","body.core.last_name":"van der Vaart","body.core.maiden_name.oneOf.0":"\u003cstring>","body.core.middle_name.oneOf.0":"Anne","body.core.personal_email.oneOf.0":"jsmith@example.com","body.core.phone_numbers.items.0.is_primary":true,"body.core.phone_numbers.items.0.phone_number":"\u003cstring>","body.core.title.oneOf.0":"Mr","body.core.work_email.oneOf.0":"jsmith@example.com","body.valid_from":"2023-12-25","body.external_ref":"\u003cstring>"}]},"dependencies":{"parameters":{"e98d3441-3b32-4375-ae6f-a1f682da2c07":{"in":"path","name":"organization_id","required":true,"schema":{"title":"Organization Id","type":"string","isRequired":true,"uniqueKey":"","typeLabel":"string"}},"392d15a2-2e42-478c-8606-47d0ddf4ade2":{"description":"The person acting through the access credential, recorded as `created_by` of what the request writes. Audit only: access is checked on the credential.","in":"header","name":"X-Acting-User","required":false,"schema":{"oneOf":[{"type":"string","title":"X-Acting-User","description":"The person acting through the access credential, recorded as `created_by` of what the request writes. Audit only: access is checked on the credential.","maxLength":255,"minLength":1,"uniqueKey":"oneOf.0","typeLabel":"string"},{"type":"null","title":"X-Acting-User","description":"The person acting through the access credential, recorded as `created_by` of what the request writes. Audit only: access is checked on the credential.","uniqueKey":"oneOf.1","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"string | null"}}},"requestBody":{"content":{"application/json":{"schema":{"additionalProperties":false,"description":"Creating an employee: the hub, `valid_from`, `core`, and any other satellites.\nEach satellite sent starts on `[valid_from, 9999-12-31)`. One not sent is not\ncreated: it reads as null until a PUT writes it, so an employee created without\n`job` is in no pay group until then.","properties":{"core":{"additionalProperties":false,"description":"Identity of the person, as payroll and filing need it.\n\nEach name field holds one name: a person with several middle names sends the one that\nshould appear on HMRC returns. If only initials are known, they go one per field\n(`first_name` \"J\", `middle_name` \"M\"). An optional name the person does not have is\nnull.","properties":{"birth_date":{"description":"Birth date","format":"date","title":"Birth Date","type":"string","isRequired":true,"uniqueKey":"core.birth_date","typeLabel":"string\u003cdate>"},"first_name":{"description":"First forename, no spaces","examples":["Sarah"],"maxLength":35,"minLength":1,"pattern":"^[A-Za-z]([A-Za-z'-]*[A-Za-z'-])?$","title":"First Name","type":"string","isRequired":true,"uniqueKey":"core.first_name","typeLabel":"string"},"gender":{"description":"Gender","enum":["MALE","FEMALE"],"title":"EmployeeGender","type":"string","isRequired":true,"uniqueKey":"core.gender","typeLabel":"enum\u003cstring>"},"last_name":{"description":"Surname","examples":["van der Vaart"],"maxLength":35,"minLength":1,"pattern":"^[A-Za-z]([A-Za-z' -]*[A-Za-z'-])?$","title":"Last Name","type":"string","isRequired":true,"uniqueKey":"core.last_name","typeLabel":"string"},"maiden_name":{"oneOf":[{"type":"string","title":"Maiden Name","description":"Surname before marriage; null when none","maxLength":35,"minLength":1,"pattern":"^[A-Za-z]([A-Za-z' -]*[A-Za-z'-])?$","isRequired":true,"uniqueKey":"core.maiden_name.oneOf.0","typeLabel":"string"},{"type":"null","title":"Maiden Name","description":"Surname before marriage; null when none","isRequired":true,"uniqueKey":"core.maiden_name.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"core.maiden_name","typeLabel":"string | null"},"marital_status":{"oneOf":[{"type":"string","title":"MaritalStatus","description":"Marital status; null when unknown","enum":["SINGLE","MARRIED"],"isRequired":true,"uniqueKey":"core.marital_status.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","description":"Marital status; null when unknown","isRequired":true,"uniqueKey":"core.marital_status.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"core.marital_status","typeLabel":"enum\u003cstring> | null"},"middle_name":{"oneOf":[{"type":"string","title":"Middle Name","description":"Second forename, no spaces; null when none","maxLength":35,"minLength":1,"pattern":"^[A-Za-z]([A-Za-z'-]*[A-Za-z'-])?$","example":"Anne","isRequired":true,"uniqueKey":"core.middle_name.oneOf.0","typeLabel":"string"},{"type":"null","title":"Middle Name","description":"Second forename, no spaces; null when none","example":"Anne","isRequired":true,"uniqueKey":"core.middle_name.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"core.middle_name","typeLabel":"string | null"},"personal_email":{"oneOf":[{"type":"string","title":"Personal Email","description":"Personal email; null when none. Required by pension provider as contact option after employment ends.","format":"email","isRequired":true,"uniqueKey":"core.personal_email.oneOf.0","typeLabel":"string\u003cemail>"},{"type":"null","title":"Personal Email","description":"Personal email; null when none. Required by pension provider as contact option after employment ends.","isRequired":true,"uniqueKey":"core.personal_email.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"core.personal_email","typeLabel":"string\u003cemail> | null"},"phone_numbers":{"description":"Phone numbers; empty when none. Required by pension provider.","items":{"additionalProperties":false,"properties":{"is_primary":{"description":"Is this the primary phone number for the employee?","title":"Is Primary","type":"boolean","isRequired":true,"uniqueKey":"core.phone_numbers.items.[INDEX].is_primary","typeLabel":"boolean"},"phone_number":{"format":"phone","title":"Phone Number","type":"string","isRequired":true,"uniqueKey":"core.phone_numbers.items.[INDEX].phone_number","typeLabel":"string\u003cphone>"},"phone_type":{"enum":["MOBILE","HOME","WORK"],"title":"PhoneType","type":"string","isRequired":true,"uniqueKey":"core.phone_numbers.items.[INDEX].phone_type","typeLabel":"enum\u003cstring>"}},"required":["phone_number","phone_type","is_primary"],"title":"Phones","type":"object","uniqueKey":"core.phone_numbers.items.[INDEX]","typeLabel":"Phones · object"},"title":"Phone Numbers","type":"array","isRequired":true,"uniqueKey":"core.phone_numbers","typeLabel":"Phones · object[]"},"title":{"oneOf":[{"type":"string","title":"Title","description":"Title, at most 4 characters (P11D limit); null when none","maxLength":4,"minLength":1,"pattern":"^[A-Za-z]([A-Za-z'-]*[A-Za-z'-])?$","example":"Mr","isRequired":true,"uniqueKey":"core.title.oneOf.0","typeLabel":"string"},{"type":"null","title":"Title","description":"Title, at most 4 characters (P11D limit); null when none","example":"Mr","isRequired":true,"uniqueKey":"core.title.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"core.title","typeLabel":"string | null"},"work_email":{"oneOf":[{"type":"string","title":"Work Email","description":"Work email; null when none. Required by pension provider.","format":"email","isRequired":true,"uniqueKey":"core.work_email.oneOf.0","typeLabel":"string\u003cemail>"},{"type":"null","title":"Work Email","description":"Work email; null when none. Required by pension provider.","isRequired":true,"uniqueKey":"core.work_email.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"core.work_email","typeLabel":"string\u003cemail> | null"}},"required":["title","first_name","middle_name","last_name","maiden_name","gender","marital_status","birth_date","personal_email","work_email","phone_numbers"],"title":"GBEmployeeCore","type":"object","isRequired":true,"uniqueKey":"core","typeLabel":"GBEmployeeCore · object"},"valid_from":{"description":"The first day every satellite's data is valid at","format":"date","title":"Valid From","type":"string","isRequired":true,"uniqueKey":"valid_from","typeLabel":"string\u003cdate>"},"address":{"additionalProperties":false,"description":"The person's residence address, as filed to HMRC.","properties":{"address_line_1":{"description":"First address line","examples":["10 Downing Street"],"maxLength":35,"minLength":1,"title":"Address Line 1","type":"string","isRequired":true,"uniqueKey":"address.address_line_1","typeLabel":"string"},"address_line_2":{"description":"Second address line","examples":["Westminster"],"maxLength":35,"minLength":1,"title":"Address Line 2","type":"string","isRequired":true,"uniqueKey":"address.address_line_2","typeLabel":"string"},"address_line_3":{"oneOf":[{"type":"string","title":"Address Line 3","description":"Third address line; null when none","maxLength":35,"minLength":1,"isRequired":true,"uniqueKey":"address.address_line_3.oneOf.0","typeLabel":"string"},{"type":"null","title":"Address Line 3","description":"Third address line; null when none","isRequired":true,"uniqueKey":"address.address_line_3.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"address.address_line_3","typeLabel":"string | null"},"address_line_4":{"oneOf":[{"type":"string","title":"Address Line 4","description":"Fourth address line; null when none","maxLength":35,"minLength":1,"isRequired":true,"uniqueKey":"address.address_line_4.oneOf.0","typeLabel":"string"},{"type":"null","title":"Address Line 4","description":"Fourth address line; null when none","isRequired":true,"uniqueKey":"address.address_line_4.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"address.address_line_4","typeLabel":"string | null"},"country":{"description":"Country of residence, ISO 3166-1 alpha-2 code","examples":["GB"],"pattern":"^\\w{2}$","title":"Country","type":"string","isRequired":true,"uniqueKey":"address.country","typeLabel":"string"},"county":{"oneOf":[{"type":"string","title":"County","description":"County, at most 35 characters, as an address line: filed to HMRC after the town when one of the four is free; null when none","maxLength":35,"minLength":1,"isRequired":true,"uniqueKey":"address.county.oneOf.0","typeLabel":"string"},{"type":"null","title":"County","description":"County, at most 35 characters, as an address line: filed to HMRC after the town when one of the four is free; null when none","isRequired":true,"uniqueKey":"address.county.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"address.county","typeLabel":"string | null"},"postcode":{"oneOf":[{"type":"string","title":"Postcode","description":"Postcode. Required for GB, JE, GG and IM and stored in canonical form (`SW1A 2AA`); optional for other countries, where it is kept as sent","example":"SW1A 2AA","isRequired":true,"uniqueKey":"address.postcode.oneOf.0","typeLabel":"string"},{"type":"null","title":"Postcode","description":"Postcode. Required for GB, JE, GG and IM and stored in canonical form (`SW1A 2AA`); optional for other countries, where it is kept as sent","example":"SW1A 2AA","isRequired":true,"uniqueKey":"address.postcode.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"address.postcode","typeLabel":"string | null"},"town":{"description":"Town or city, at most 35 characters, as an address line: filed to HMRC after the lines when one of the four is free","examples":["London"],"maxLength":35,"minLength":1,"title":"Town","type":"string","isRequired":true,"uniqueKey":"address.town","typeLabel":"string"}},"required":["address_line_1","address_line_2","address_line_3","address_line_4","town","county","postcode","country"],"title":"GBEmployeeAddress","type":"object","uniqueKey":"address","typeLabel":"GBEmployeeAddress · object"},"bank":{"additionalProperties":false,"properties":{"accounts":{"description":"Accounts; empty when none","items":{"additionalProperties":false,"description":"A UK account an employee is paid into by BACS.","properties":{"account_number":{"examples":["31926819"],"pattern":"^\\d{8}$","title":"Account Number","type":"string","isRequired":true,"uniqueKey":"bank.accounts.items.[INDEX].account_number","typeLabel":"string"},"allocation_percentage":{"oneOf":[{"type":"number","title":"Allocation Percentage","description":"Share of net pay paid into this account. Set on every active account that receives a share; the shares sum to 100. Null when the account takes no share.","maximum":100,"minimum":0,"exclusiveMinimum":true,"isRequired":true,"uniqueKey":"bank.accounts.items.[INDEX].allocation_percentage.oneOf.0","typeLabel":"number"},{"type":"string","title":"Allocation Percentage","description":"Share of net pay paid into this account. Set on every active account that receives a share; the shares sum to 100. Null when the account takes no share.","isRequired":true,"uniqueKey":"bank.accounts.items.[INDEX].allocation_percentage.oneOf.1","typeLabel":"string"},{"type":"null","title":"Allocation Percentage","description":"Share of net pay paid into this account. Set on every active account that receives a share; the shares sum to 100. Null when the account takes no share.","isRequired":true,"uniqueKey":"bank.accounts.items.[INDEX].allocation_percentage.oneOf.2","typeLabel":"null"}],"isRequired":true,"uniqueKey":"bank.accounts.items.[INDEX].allocation_percentage","typeLabel":"number | string | null"},"financial_institution_name":{"oneOf":[{"type":"string","title":"Financial Institution Name","example":"Lloyds Bank","isRequired":true,"uniqueKey":"bank.accounts.items.[INDEX].financial_institution_name.oneOf.0","typeLabel":"string"},{"type":"null","title":"Financial Institution Name","example":"Lloyds Bank","isRequired":true,"uniqueKey":"bank.accounts.items.[INDEX].financial_institution_name.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"bank.accounts.items.[INDEX].financial_institution_name","typeLabel":"string | null"},"is_active":{"description":"Inactive accounts are not paid into","title":"Is Active","type":"boolean","isRequired":true,"uniqueKey":"bank.accounts.items.[INDEX].is_active","typeLabel":"boolean"},"is_primary":{"description":"Receives the whole net pay when no account has an allocation","title":"Is Primary","type":"boolean","isRequired":true,"uniqueKey":"bank.accounts.items.[INDEX].is_primary","typeLabel":"boolean"},"sort_code":{"description":"Six digits; dashes and spaces are removed.","examples":["200015"],"title":"Sort Code","type":"string","isRequired":true,"uniqueKey":"bank.accounts.items.[INDEX].sort_code","typeLabel":"string"}},"required":["account_number","sort_code","financial_institution_name","is_primary","is_active","allocation_percentage"],"title":"GBBankAccount","type":"object","uniqueKey":"bank.accounts.items.[INDEX]","typeLabel":"GBBankAccount · object"},"title":"Accounts","type":"array","isRequired":true,"uniqueKey":"bank.accounts","typeLabel":"GBBankAccount · object[]"}},"required":["accounts"],"title":"GBEmployeeBank","type":"object","uniqueKey":"bank","typeLabel":"GBEmployeeBank · object"},"compensation":{"additionalProperties":false,"description":"Standing pay elements.","properties":{"benefits":{"description":"Benefits; empty when none","items":{"additionalProperties":false,"description":"A benefit line as the compensation satellite takes it.","properties":{"amount":{"oneOf":[{"type":"number","title":"Amount","description":"Amount of benefit","minimum":0,"example":"0.00","isRequired":true,"uniqueKey":"compensation.benefits.items.[INDEX].amount.oneOf.0","typeLabel":"number"},{"type":"string","title":"Amount","description":"Amount of benefit","example":"0.00","isRequired":true,"uniqueKey":"compensation.benefits.items.[INDEX].amount.oneOf.1","typeLabel":"string"},{"type":"null","title":"Amount","description":"Amount of benefit","example":"0.00","isRequired":true,"uniqueKey":"compensation.benefits.items.[INDEX].amount.oneOf.2","typeLabel":"null"}],"isRequired":true,"uniqueKey":"compensation.benefits.items.[INDEX].amount","typeLabel":"number | string | null"},"cash_alternative_amount":{"oneOf":[{"type":"number","title":"Cash Alternative Amount","description":"Cash alternative declined in favour of this benefit (Type B OpRA)","minimum":0,"example":"0.00","isRequired":true,"uniqueKey":"compensation.benefits.items.[INDEX].cash_alternative_amount.oneOf.0","typeLabel":"number"},{"type":"string","title":"Cash Alternative Amount","description":"Cash alternative declined in favour of this benefit (Type B OpRA)","example":"0.00","isRequired":true,"uniqueKey":"compensation.benefits.items.[INDEX].cash_alternative_amount.oneOf.1","typeLabel":"string"},{"type":"null","title":"Cash Alternative Amount","description":"Cash alternative declined in favour of this benefit (Type B OpRA)","example":"0.00","isRequired":true,"uniqueKey":"compensation.benefits.items.[INDEX].cash_alternative_amount.oneOf.2","typeLabel":"null"}],"isRequired":true,"uniqueKey":"compensation.benefits.items.[INDEX].cash_alternative_amount","typeLabel":"number | string | null"},"external_ref":{"oneOf":[{"type":"string","title":"External Ref","description":"Caller-owned line key; null when none","isRequired":true,"uniqueKey":"compensation.benefits.items.[INDEX].external_ref.oneOf.0","typeLabel":"string"},{"type":"null","title":"External Ref","description":"Caller-owned line key; null when none","isRequired":true,"uniqueKey":"compensation.benefits.items.[INDEX].external_ref.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"compensation.benefits.items.[INDEX].external_ref","typeLabel":"string | null"},"foregone_amount":{"oneOf":[{"type":"number","title":"Foregone Amount","description":"If subject to OpRA, amount foregone","minimum":0,"example":"0.00","isRequired":true,"uniqueKey":"compensation.benefits.items.[INDEX].foregone_amount.oneOf.0","typeLabel":"number"},{"type":"string","title":"Foregone Amount","description":"If subject to OpRA, amount foregone","example":"0.00","isRequired":true,"uniqueKey":"compensation.benefits.items.[INDEX].foregone_amount.oneOf.1","typeLabel":"string"},{"type":"null","title":"Foregone Amount","description":"If subject to OpRA, amount foregone","example":"0.00","isRequired":true,"uniqueKey":"compensation.benefits.items.[INDEX].foregone_amount.oneOf.2","typeLabel":"null"}],"isRequired":true,"uniqueKey":"compensation.benefits.items.[INDEX].foregone_amount","typeLabel":"number | string | null"},"make_good_amount":{"oneOf":[{"type":"number","title":"Make Good Amount","description":"Amount paid by employee for the benefit","minimum":0,"example":"0.00","isRequired":true,"uniqueKey":"compensation.benefits.items.[INDEX].make_good_amount.oneOf.0","typeLabel":"number"},{"type":"string","title":"Make Good Amount","description":"Amount paid by employee for the benefit","example":"0.00","isRequired":true,"uniqueKey":"compensation.benefits.items.[INDEX].make_good_amount.oneOf.1","typeLabel":"string"},{"type":"null","title":"Make Good Amount","description":"Amount paid by employee for the benefit","example":"0.00","isRequired":true,"uniqueKey":"compensation.benefits.items.[INDEX].make_good_amount.oneOf.2","typeLabel":"null"}],"isRequired":true,"uniqueKey":"compensation.benefits.items.[INDEX].make_good_amount","typeLabel":"number | string | null"},"wage_type_code":{"description":"Wage type code from catalog (e.g. UK-B-001)","title":"Wage Type Code","type":"string","isRequired":true,"uniqueKey":"compensation.benefits.items.[INDEX].wage_type_code","typeLabel":"string"}},"required":["external_ref","wage_type_code","amount","make_good_amount","foregone_amount","cash_alternative_amount"],"title":"StandingBenefit","type":"object","uniqueKey":"compensation.benefits.items.[INDEX]","typeLabel":"StandingBenefit · object"},"title":"Benefits","type":"array","isRequired":true,"uniqueKey":"compensation.benefits","typeLabel":"StandingBenefit · object[]"},"deductions":{"description":"Deductions; empty when none","items":{"additionalProperties":false,"description":"A deduction line as the compensation satellite takes it.","properties":{"amount":{"oneOf":[{"type":"number","title":"Amount","minimum":0,"isRequired":true,"uniqueKey":"compensation.deductions.items.[INDEX].amount.oneOf.0","typeLabel":"number"},{"type":"string","title":"Amount","isRequired":true,"uniqueKey":"compensation.deductions.items.[INDEX].amount.oneOf.1","typeLabel":"string"}],"isRequired":true,"uniqueKey":"compensation.deductions.items.[INDEX].amount","typeLabel":"number | string"},"external_ref":{"oneOf":[{"type":"string","title":"External Ref","description":"Caller-owned line key; null when none","isRequired":true,"uniqueKey":"compensation.deductions.items.[INDEX].external_ref.oneOf.0","typeLabel":"string"},{"type":"null","title":"External Ref","description":"Caller-owned line key; null when none","isRequired":true,"uniqueKey":"compensation.deductions.items.[INDEX].external_ref.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"compensation.deductions.items.[INDEX].external_ref","typeLabel":"string | null"},"sacrificed_amount":{"oneOf":[{"type":"number","title":"Sacrificed Amount","description":"Pre-tax salary sacrifice part (Type A OpRA); null when none","minimum":0,"isRequired":true,"uniqueKey":"compensation.deductions.items.[INDEX].sacrificed_amount.oneOf.0","typeLabel":"number"},{"type":"string","title":"Sacrificed Amount","description":"Pre-tax salary sacrifice part (Type A OpRA); null when none","isRequired":true,"uniqueKey":"compensation.deductions.items.[INDEX].sacrificed_amount.oneOf.1","typeLabel":"string"},{"type":"null","title":"Sacrificed Amount","description":"Pre-tax salary sacrifice part (Type A OpRA); null when none","isRequired":true,"uniqueKey":"compensation.deductions.items.[INDEX].sacrificed_amount.oneOf.2","typeLabel":"null"}],"isRequired":true,"uniqueKey":"compensation.deductions.items.[INDEX].sacrificed_amount","typeLabel":"number | string | null"},"wage_type_code":{"description":"Wage type code from catalog (e.g. UK-D-001)","title":"Wage Type Code","type":"string","isRequired":true,"uniqueKey":"compensation.deductions.items.[INDEX].wage_type_code","typeLabel":"string"}},"required":["external_ref","wage_type_code","amount","sacrificed_amount"],"title":"StandingDeduction","type":"object","uniqueKey":"compensation.deductions.items.[INDEX]","typeLabel":"StandingDeduction · object"},"title":"Deductions","type":"array","isRequired":true,"uniqueKey":"compensation.deductions","typeLabel":"StandingDeduction · object[]"},"earnings":{"description":"Earnings; empty when none","items":{"additionalProperties":false,"description":"An earning line as the compensation satellite takes it.","properties":{"amount":{"oneOf":[{"type":"number","title":"Amount","description":"Earnings amount (negative values represent period adjustments, e.g. leave reductions)","isRequired":true,"uniqueKey":"compensation.earnings.items.[INDEX].amount.oneOf.0","typeLabel":"number"},{"type":"string","title":"Amount","description":"Earnings amount (negative values represent period adjustments, e.g. leave reductions)","isRequired":true,"uniqueKey":"compensation.earnings.items.[INDEX].amount.oneOf.1","typeLabel":"string"}],"isRequired":true,"uniqueKey":"compensation.earnings.items.[INDEX].amount","typeLabel":"number | string"},"earning_frequency":{"oneOf":[{"type":"string","title":"PayCycle","description":"The frequency of a recurring earning; null when not recurring","enum":["YEAR","MONTH","WEEK","TWO_WEEK","FOUR_WEEK","QUARTER","BIANNUAL"],"example":"MONTH","isRequired":true,"uniqueKey":"compensation.earnings.items.[INDEX].earning_frequency.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","description":"The frequency of a recurring earning; null when not recurring","example":"MONTH","isRequired":true,"uniqueKey":"compensation.earnings.items.[INDEX].earning_frequency.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"compensation.earnings.items.[INDEX].earning_frequency","typeLabel":"enum\u003cstring> | null"},"earning_type":{"const":"AMOUNT","examples":["AMOUNT"],"title":"Earning Type","type":"string","isRequired":true,"uniqueKey":"compensation.earnings.items.[INDEX].earning_type","typeLabel":"string"},"external_ref":{"oneOf":[{"type":"string","title":"External Ref","description":"Caller-owned line key; null when none","isRequired":true,"uniqueKey":"compensation.earnings.items.[INDEX].external_ref.oneOf.0","typeLabel":"string"},{"type":"null","title":"External Ref","description":"Caller-owned line key; null when none","isRequired":true,"uniqueKey":"compensation.earnings.items.[INDEX].external_ref.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"compensation.earnings.items.[INDEX].external_ref","typeLabel":"string | null"},"is_lumpsum":{"description":"True if one-off","examples":[false],"title":"Is Lumpsum","type":"boolean","isRequired":true,"uniqueKey":"compensation.earnings.items.[INDEX].is_lumpsum","typeLabel":"boolean"},"sacrificed_amount":{"oneOf":[{"type":"number","title":"Sacrificed Amount","description":"Amount sacrificed (Type A OpRA); null when nothing is sacrificed","minimum":0,"isRequired":true,"uniqueKey":"compensation.earnings.items.[INDEX].sacrificed_amount.oneOf.0","typeLabel":"number"},{"type":"string","title":"Sacrificed Amount","description":"Amount sacrificed (Type A OpRA); null when nothing is sacrificed","isRequired":true,"uniqueKey":"compensation.earnings.items.[INDEX].sacrificed_amount.oneOf.1","typeLabel":"string"},{"type":"null","title":"Sacrificed Amount","description":"Amount sacrificed (Type A OpRA); null when nothing is sacrificed","isRequired":true,"uniqueKey":"compensation.earnings.items.[INDEX].sacrificed_amount.oneOf.2","typeLabel":"null"}],"isRequired":true,"uniqueKey":"compensation.earnings.items.[INDEX].sacrificed_amount","typeLabel":"number | string | null"},"wage_type_code":{"description":"Wage type code from catalog (e.g. UK-E-001)","title":"Wage Type Code","type":"string","isRequired":true,"uniqueKey":"compensation.earnings.items.[INDEX].wage_type_code","typeLabel":"string"}},"required":["external_ref","earning_type","wage_type_code","amount","earning_frequency","is_lumpsum","sacrificed_amount"],"title":"StandingEarning","type":"object","uniqueKey":"compensation.earnings.items.[INDEX]","typeLabel":"StandingEarning · object"},"title":"Earnings","type":"array","isRequired":true,"uniqueKey":"compensation.earnings","typeLabel":"StandingEarning · object[]"},"reimbursements":{"description":"Reimbursements; empty when none","items":{"additionalProperties":false,"description":"A reimbursement line as the compensation satellite takes it.","properties":{"amount":{"oneOf":[{"type":"number","title":"Amount","minimum":0,"isRequired":true,"uniqueKey":"compensation.reimbursements.items.[INDEX].amount.oneOf.0","typeLabel":"number"},{"type":"string","title":"Amount","isRequired":true,"uniqueKey":"compensation.reimbursements.items.[INDEX].amount.oneOf.1","typeLabel":"string"}],"isRequired":true,"uniqueKey":"compensation.reimbursements.items.[INDEX].amount","typeLabel":"number | string"},"external_ref":{"oneOf":[{"type":"string","title":"External Ref","description":"Caller-owned line key; null when none","isRequired":true,"uniqueKey":"compensation.reimbursements.items.[INDEX].external_ref.oneOf.0","typeLabel":"string"},{"type":"null","title":"External Ref","description":"Caller-owned line key; null when none","isRequired":true,"uniqueKey":"compensation.reimbursements.items.[INDEX].external_ref.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"compensation.reimbursements.items.[INDEX].external_ref","typeLabel":"string | null"},"wage_type_code":{"description":"Wage type code from catalog (e.g. UK-R-001)","title":"Wage Type Code","type":"string","isRequired":true,"uniqueKey":"compensation.reimbursements.items.[INDEX].wage_type_code","typeLabel":"string"}},"required":["external_ref","wage_type_code","amount"],"title":"StandingReimbursement","type":"object","uniqueKey":"compensation.reimbursements.items.[INDEX]","typeLabel":"StandingReimbursement · object"},"title":"Reimbursements","type":"array","isRequired":true,"uniqueKey":"compensation.reimbursements","typeLabel":"StandingReimbursement · object[]"}},"required":["earnings","benefits","deductions","reimbursements"],"title":"GBEmployeeCompensation","type":"object","uniqueKey":"compensation","typeLabel":"GBEmployeeCompensation · object"},"external_ref":{"description":"The integrator's own key, unique within the parent and never changed. A path may name the hub as `ext:{external_ref}`.","maxLength":255,"minLength":1,"pattern":"^[A-Za-z0-9._~-]+$","title":"External Ref","type":"string","uniqueKey":"external_ref","typeLabel":"string"},"insurance":{"additionalProperties":false,"properties":{"national_insurance_number":{"oneOf":[{"type":"string","title":"National Insurance Number","description":"National Insurance number; null when not known","maxLength":9,"minLength":9,"isRequired":true,"uniqueKey":"insurance.national_insurance_number.oneOf.0","typeLabel":"string"},{"type":"null","title":"National Insurance Number","description":"National Insurance number; null when not known","isRequired":true,"uniqueKey":"insurance.national_insurance_number.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"insurance.national_insurance_number","typeLabel":"string | null"},"nic_category":{"description":"NIC category letter","enum":["A","B","C","D","E","F","H","I","J","K","L","M","N","S","V","X","Z"],"title":"NICCategory","type":"string","isRequired":true,"uniqueKey":"insurance.nic_category","typeLabel":"enum\u003cstring>"},"overseas_national_awaiting_nino":{"oneOf":[{"type":"boolean","title":"Overseas National Awaiting Nino","description":"Overseas national waiting for a National Insurance number; asked by NEST when there is no number, and decides whether NEST claims tax relief. Null when not answered","uniqueKey":"insurance.overseas_national_awaiting_nino.oneOf.0","typeLabel":"boolean"},{"type":"null","title":"Overseas National Awaiting Nino","description":"Overseas national waiting for a National Insurance number; asked by NEST when there is no number, and decides whether NEST claims tax relief. Null when not answered","uniqueKey":"insurance.overseas_national_awaiting_nino.oneOf.1","typeLabel":"null"}],"uniqueKey":"insurance.overseas_national_awaiting_nino","typeLabel":"boolean | null"}},"required":["national_insurance_number","nic_category"],"title":"GBEmployeeInsurance","type":"object","uniqueKey":"insurance","typeLabel":"GBEmployeeInsurance · object"},"job":{"additionalProperties":false,"description":"The terms of the employment as a client writes them.","properties":{"apprenticeship":{"oneOf":[{"type":"object","title":"Apprenticeship","description":"Apprenticeship details; null when not an apprentice","required":["start_date","expected_end_date","level"],"properties":{"expected_end_date":{"oneOf":[{"type":"string","title":"Expected End Date","description":"Expected end date (informational); null when not known","format":"date","isRequired":true,"uniqueKey":"job.apprenticeship.oneOf.0.expected_end_date.oneOf.0","typeLabel":"string\u003cdate>"},{"type":"null","title":"Expected End Date","description":"Expected end date (informational); null when not known","isRequired":true,"uniqueKey":"job.apprenticeship.oneOf.0.expected_end_date.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"job.apprenticeship.oneOf.0.expected_end_date","typeLabel":"string\u003cdate> | null"},"level":{"description":"UK apprenticeship level (2-7)","maximum":7,"minimum":2,"title":"Level","type":"integer","isRequired":true,"uniqueKey":"job.apprenticeship.oneOf.0.level","typeLabel":"integer"},"start_date":{"description":"Start date of current apprenticeship agreement","format":"date","title":"Start Date","type":"string","isRequired":true,"uniqueKey":"job.apprenticeship.oneOf.0.start_date","typeLabel":"string\u003cdate>"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"job.apprenticeship.oneOf.0","typeLabel":"Apprenticeship · object"},{"type":"null","description":"Apprenticeship details; null when not an apprentice","isRequired":true,"uniqueKey":"job.apprenticeship.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"job.apprenticeship","typeLabel":"Apprenticeship · object | null"},"contracted_weekdays":{"description":"Contracted working days of the week","items":{"description":"Days of the week.","enum":["MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY","SUNDAY"],"title":"Weekday","type":"string","uniqueKey":"job.contracted_weekdays.items.[INDEX]","typeLabel":"enum\u003cstring>"},"maxItems":7,"minItems":1,"title":"Contracted Weekdays","type":"array","isRequired":true,"uniqueKey":"job.contracted_weekdays","typeLabel":"enum\u003cstring>[]"},"contracted_weekly_hours":{"description":"Contracted weekly hours","examples":[40],"title":"Contracted Weekly Hours","type":"integer","isRequired":true,"uniqueKey":"job.contracted_weekly_hours","typeLabel":"integer"},"department":{"oneOf":[{"type":"string","title":"Department","description":"Department, will be shown on the pension report; null when none","isRequired":true,"uniqueKey":"job.department.oneOf.0","typeLabel":"string"},{"type":"null","title":"Department","description":"Department, will be shown on the pension report; null when none","isRequired":true,"uniqueKey":"job.department.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"job.department","typeLabel":"string | null"},"director_since":{"oneOf":[{"type":"string","title":"Director Since","description":"Date appointed as director; null when not a director","format":"date","isRequired":true,"uniqueKey":"job.director_since.oneOf.0","typeLabel":"string\u003cdate>"},{"type":"null","title":"Director Since","description":"Date appointed as director; null when not a director","isRequired":true,"uniqueKey":"job.director_since.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"job.director_since","typeLabel":"string\u003cdate> | null"},"irregular_payment_pattern":{"description":"True for casual staff and anyone else not paid every pay period (seasonal, annual director pay). Reported to HMRC as IrrEmp so the employment is not treated as ceased after a run of periods without payment.","title":"Irregular Payment Pattern","type":"boolean","isRequired":true,"uniqueKey":"job.irregular_payment_pattern","typeLabel":"boolean"},"ordinarily_works_in_uk":{"description":"Whether the worker's ordinary place of work under their contract is in the UK (per TPR Detailed Guidance No. 1). If False, the employer has no statutory auto-enrolment duties for this worker. Employees on temporary overseas secondment who remain on UK payroll and whose ordinary place of work is the UK stay True: this flag reflects the contractual base, not the employee's current physical location.","title":"Ordinarily Works In Uk","type":"boolean","isRequired":true,"uniqueKey":"job.ordinarily_works_in_uk","typeLabel":"boolean"},"p45_issued":{"description":"True once a P45 has been issued for this employment (post-cessation). Drives the weekly NIC earnings period for post-P45 payments. Distinct from the inbound-starter p45_gross_pay/p45_tax_amount in tax, which carry a new joiner's prior-employer figures.","title":"P45 Issued","type":"boolean","isRequired":true,"uniqueKey":"job.p45_issued","typeLabel":"boolean"},"pay_basis":{"description":"How pay and hours are determined","enum":["SALARIED","HOURLY"],"title":"PayBasis","type":"string","isRequired":true,"uniqueKey":"job.pay_basis","typeLabel":"enum\u003cstring>"},"pay_group_id":{"description":"The pay group the employee is paid in. Every job write names one: moving to another group is a job write naming it.","title":"Pay Group Id","type":"string","isRequired":true,"uniqueKey":"job.pay_group_id","typeLabel":"string"},"proration_basis":{"oneOf":[{"type":"object","title":"EmployeeProrationBasis","description":"Null to inherit the pay group's basis; set it only to override that basis for this employee.","required":["mode","business_days_per_year"],"properties":{"business_days_per_year":{"oneOf":[{"type":"number","title":"Business Days Per Year","description":"Annual working-day divisor; null for CALENDAR_DAY","example":"260","isRequired":true,"uniqueKey":"job.proration_basis.oneOf.0.business_days_per_year.oneOf.0","typeLabel":"number"},{"type":"string","title":"Business Days Per Year","description":"Annual working-day divisor; null for CALENDAR_DAY","example":"260","isRequired":true,"uniqueKey":"job.proration_basis.oneOf.0.business_days_per_year.oneOf.1","typeLabel":"string"},{"type":"null","title":"Business Days Per Year","description":"Annual working-day divisor; null for CALENDAR_DAY","example":"260","isRequired":true,"uniqueKey":"job.proration_basis.oneOf.0.business_days_per_year.oneOf.2","typeLabel":"null"}],"isRequired":true,"uniqueKey":"job.proration_basis.oneOf.0.business_days_per_year","typeLabel":"number | string | null"},"mode":{"description":"Salary-apportionment basis for proration.","enum":["CALENDAR_DAY","CONTRACTED_DAY","CONTRACTED_HOURS"],"title":"BasisMode","type":"string","isRequired":true,"uniqueKey":"job.proration_basis.oneOf.0.mode","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"job.proration_basis.oneOf.0","typeLabel":"EmployeeProrationBasis · object"},{"type":"null","description":"Null to inherit the pay group's basis; set it only to override that basis for this employee.","isRequired":true,"uniqueKey":"job.proration_basis.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"job.proration_basis","typeLabel":"EmployeeProrationBasis · object | null"},"start_date":{"description":"Employment start date","format":"date","title":"Start Date","type":"string","isRequired":true,"uniqueKey":"job.start_date","typeLabel":"string\u003cdate>"},"uk_work_exclusion_reason":{"description":"Why the worker does not ordinarily work in the UK. Required, and other than NOT_APPLICABLE, when ordinarily_works_in_uk is False; must be NOT_APPLICABLE when it is True.","enum":["NOT_APPLICABLE","OVERSEAS_CONTRACT","OUTBOUND_POSTING","INBOUND_TEMPORARY_POSTING","MOBILE_WORKER_OVERSEAS_BASE","OTHER"],"title":"UKWorkExclusionReason","type":"string","examples":["NOT_APPLICABLE"],"isRequired":true,"uniqueKey":"job.uk_work_exclusion_reason","typeLabel":"enum\u003cstring>"},"worker_type":{"description":"UK employment status: employee or director","enum":["EMPLOYEE","DIRECTOR"],"title":"WorkerType","type":"string","isRequired":true,"uniqueKey":"job.worker_type","typeLabel":"enum\u003cstring>"},"engagement_type":{"description":"How the worker is engaged. EMPLOYEE: a direct employee under PAYE. OFF_PAYROLL: subject to the off-payroll working rules (IR35, Chapter 10 ITEPA 2003), with this employer as the deemed employer; reported to HMRC as OffPayrollWorker, and no student or postgraduate loan is deducted. Independent of worker_type: a director can be off-payroll. Changing it within a tax year after a payment is not supported yet: the next FPS fails. More values will be added; accept values you do not know.","enum":["EMPLOYEE","OFF_PAYROLL"],"title":"EngagementType","type":"string","default":"EMPLOYEE","uniqueKey":"job.engagement_type","typeLabel":"enum\u003cstring>"},"workplace_postcode":{"oneOf":[{"type":"string","title":"Workplace Postcode","description":"UK postcode of the Freeport or Investment Zone special tax site where the employee works, e.g. \"SW1A 1AA\". Reported to HMRC while a Freeport or Investment Zone NI category letter (F, I, L, S, N, E, D, K) applies in the tax year; approving a payrun that needs it and has none is refused. Whether the postcode lies inside a special tax site is not checked. Null when none.","uniqueKey":"job.workplace_postcode.oneOf.0","typeLabel":"string"},{"type":"null","title":"Workplace Postcode","description":"UK postcode of the Freeport or Investment Zone special tax site where the employee works, e.g. \"SW1A 1AA\". Reported to HMRC while a Freeport or Investment Zone NI category letter (F, I, L, S, N, E, D, K) applies in the tax year; approving a payrun that needs it and has none is refused. Whether the postcode lies inside a special tax site is not checked. Null when none.","uniqueKey":"job.workplace_postcode.oneOf.1","typeLabel":"null"}],"uniqueKey":"job.workplace_postcode","typeLabel":"string | null"}},"required":["start_date","contracted_weekly_hours","department","pay_group_id","contracted_weekdays","worker_type","director_since","pay_basis","apprenticeship","p45_issued","irregular_payment_pattern","ordinarily_works_in_uk","uk_work_exclusion_reason","proration_basis"],"title":"GBEmployeeJob","type":"object","uniqueKey":"job","typeLabel":"GBEmployeeJob · object"},"tax":{"additionalProperties":false,"properties":{"p45_gross_pay":{"oneOf":[{"type":"number","title":"P45 Gross Pay","description":"P45 gross pay","example":"0.00","isRequired":true,"uniqueKey":"tax.p45_gross_pay.oneOf.0","typeLabel":"number"},{"type":"string","title":"P45 Gross Pay","description":"P45 gross pay","example":"0.00","isRequired":true,"uniqueKey":"tax.p45_gross_pay.oneOf.1","typeLabel":"string"}],"isRequired":true,"uniqueKey":"tax.p45_gross_pay","typeLabel":"number | string"},"p45_tax_amount":{"oneOf":[{"type":"number","title":"P45 Tax Amount","description":"P45 tax amount","example":"0.00","isRequired":true,"uniqueKey":"tax.p45_tax_amount.oneOf.0","typeLabel":"number"},{"type":"string","title":"P45 Tax Amount","description":"P45 tax amount","example":"0.00","isRequired":true,"uniqueKey":"tax.p45_tax_amount.oneOf.1","typeLabel":"string"}],"isRequired":true,"uniqueKey":"tax.p45_tax_amount","typeLabel":"number | string"},"postgraduate_loan":{"description":"Postgraduate loan?","title":"Postgraduate Loan","type":"boolean","isRequired":true,"uniqueKey":"tax.postgraduate_loan","typeLabel":"boolean"},"rti_id":{"oneOf":[{"type":"string","title":"Rti Id","description":"RTI Payroll ID, unique for this employee in HMRC submissions. Null to keep the current one, or generate one on the first write; never generated for EXISTING_EMPLOYMENT.","maxLength":35,"minLength":1,"isRequired":true,"uniqueKey":"tax.rti_id.oneOf.0","typeLabel":"string"},{"type":"null","title":"Rti Id","description":"RTI Payroll ID, unique for this employee in HMRC submissions. Null to keep the current one, or generate one on the first write; never generated for EXISTING_EMPLOYMENT.","isRequired":true,"uniqueKey":"tax.rti_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"tax.rti_id","typeLabel":"string | null"},"starter_details":{"oneOf":[{"type":"object","title":"StarterDetailsDeclaration","description":"A new employee who completed the starter checklist.","required":["basis","declaration"],"properties":{"basis":{"const":"DECLARATION","title":"Basis","type":"string","isRequired":true,"uniqueKey":"tax.starter_details.oneOf.0.basis","typeLabel":"string"},"declaration":{"description":"Starter checklist statement A, B or C","enum":["A","B","C"],"title":"StarterDeclaration","type":"string","isRequired":true,"uniqueKey":"tax.starter_details.oneOf.0.declaration","typeLabel":"enum\u003cstring>"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"tax.starter_details.oneOf.0","typeLabel":"StarterDetailsDeclaration · object"},{"type":"object","title":"StarterDetailsSeconded","description":"An employee seconded to work in the UK, who completed the expatriate checklist.","required":["basis","stay","eea_citizen","epm6","declaration"],"properties":{"basis":{"const":"SECONDED","title":"Basis","type":"string","isRequired":true,"uniqueKey":"tax.starter_details.oneOf.1.basis","typeLabel":"string"},"declaration":{"oneOf":[{"type":"string","title":"StarterDeclaration","description":"Starter checklist statement; required without a stay, null with one","enum":["A","B","C"],"isRequired":true,"uniqueKey":"tax.starter_details.oneOf.1.declaration.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","description":"Starter checklist statement; required without a stay, null with one","isRequired":true,"uniqueKey":"tax.starter_details.oneOf.1.declaration.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"tax.starter_details.oneOf.1.declaration","typeLabel":"enum\u003cstring> | null"},"eea_citizen":{"description":"EEA citizen; only with a stay","title":"Eea Citizen","type":"boolean","isRequired":true,"uniqueKey":"tax.starter_details.oneOf.1.eea_citizen","typeLabel":"boolean"},"epm6":{"description":"In HMRC's modified PAYE scheme for tax-equalised expatriates","title":"Epm6","type":"boolean","isRequired":true,"uniqueKey":"tax.starter_details.oneOf.1.epm6","typeLabel":"boolean"},"stay":{"oneOf":[{"type":"string","title":"SecondedStay","description":"How long the employee intends to stay; null when not known, which needs epm6 and a declaration","enum":["STAY_183_DAYS_OR_MORE","STAY_LESS_THAN_183_DAYS","IN_AND_OUT_OF_UK"],"isRequired":true,"uniqueKey":"tax.starter_details.oneOf.1.stay.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","description":"How long the employee intends to stay; null when not known, which needs epm6 and a declaration","isRequired":true,"uniqueKey":"tax.starter_details.oneOf.1.stay.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"tax.starter_details.oneOf.1.stay","typeLabel":"enum\u003cstring> | null"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"tax.starter_details.oneOf.1","typeLabel":"StarterDetailsSeconded · object"},{"type":"object","title":"StarterDetailsExistingEmployment","description":"An employee already employed under this PAYE reference, moved from another\npayroll provider: HMRC already has the employment, so no starter block is filed.","required":["basis"],"properties":{"basis":{"const":"EXISTING_EMPLOYMENT","title":"Basis","type":"string","isRequired":true,"uniqueKey":"tax.starter_details.oneOf.2.basis","typeLabel":"string"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"tax.starter_details.oneOf.2","typeLabel":"StarterDetailsExistingEmployment · object"}],"isRequired":true,"uniqueKey":"tax.starter_details","typeLabel":"StarterDetailsDeclaration · object | StarterDetailsSeconded · object | StarterDetailsExistingEmployment · object"},"student_loan_type":{"oneOf":[{"type":"string","title":"StudentLoanPlanType","description":"Student loan type; null when none","enum":["PLAN_1","PLAN_2","PLAN_4","PLAN_5"],"isRequired":true,"uniqueKey":"tax.student_loan_type.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","description":"Student loan type; null when none","isRequired":true,"uniqueKey":"tax.student_loan_type.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"tax.student_loan_type","typeLabel":"enum\u003cstring> | null"},"tax_code":{"description":"HMRC tax code (e.g. '1257L', 'K475', 'BR')","examples":["1257L"],"type":"string","isRequired":true,"uniqueKey":"tax.tax_code","typeLabel":"string"}},"required":["rti_id","tax_code","student_loan_type","postgraduate_loan","p45_gross_pay","p45_tax_amount","starter_details"],"title":"GBEmployeeTax","type":"object","uniqueKey":"tax","typeLabel":"GBEmployeeTax · object"}},"required":["valid_from","core"],"title":"GBEmployeeCreateRequest","type":"object","uniqueKey":"","typeLabel":"GBEmployeeCreateRequest · object"},"examples":{"Example":{"title":"Example","value":{"core":{"birth_date":"2023-12-25","first_name":"Sarah","last_name":"van der Vaart","maiden_name":"\u003cstring>","middle_name":"Anne","personal_email":"jsmith@example.com","phone_numbers":[{"is_primary":true,"phone_number":"\u003cstring>"}],"title":"Mr","work_email":"jsmith@example.com"},"valid_from":"2023-12-25","external_ref":"\u003cstring>"}}},"exampleType":"generated"}},"required":true,"exampleType":"generated"},"responses":{"f25cab16-ed54-481d-bf07-00257c33ac8a":{"content":{"application/json":{"schema":{"additionalProperties":false,"description":"The employee with every satellite as it reads on one date. A satellite never\nwritten, or with no slice on an explicit date, is null.","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 created the hub: 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"},"deleted_at":{"oneOf":[{"type":"string","title":"Deleted At","description":"When the hub was closed","format":"date-time","isRequired":true,"uniqueKey":"deleted_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","title":"Deleted At","description":"When the hub was closed","isRequired":true,"uniqueKey":"deleted_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"deleted_at","typeLabel":"string\u003cdate-time> | null"},"external_ref":{"oneOf":[{"type":"string","title":"External Ref","isRequired":true,"uniqueKey":"external_ref.oneOf.0","typeLabel":"string"},{"type":"null","title":"External Ref","isRequired":true,"uniqueKey":"external_ref.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"external_ref","typeLabel":"string | null"},"id":{"title":"Id","type":"string","isRequired":true,"uniqueKey":"id","typeLabel":"string"},"organization_id":{"title":"Organization Id","type":"string","isRequired":true,"uniqueKey":"organization_id","typeLabel":"string"},"status":{"additionalProperties":false,"description":"The read-only status satellite. It carries no fields; it exists so that every\nemployee read has a `status` object.","properties":{},"title":"GBEmployeeStatus","type":"object","isRequired":true,"uniqueKey":"status","typeLabel":"GBEmployeeStatus · object"},"address":{"oneOf":[{"type":"object","title":"GBEmployeeAddressSatellite","required":["edition","valid_from","valid_to","created_at","created_by"],"properties":{"created_at":{"format":"date-time","readOnly":true,"title":"Created At","type":"string","isRequired":true,"uniqueKey":"address.oneOf.0.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":"address.oneOf.0.created_by","typeLabel":"string"},"edition":{"readOnly":true,"title":"Edition","type":"integer","isRequired":true,"uniqueKey":"address.oneOf.0.edition","typeLabel":"integer"},"valid_from":{"format":"date","title":"Valid From","type":"string","isRequired":true,"uniqueKey":"address.oneOf.0.valid_from","typeLabel":"string\u003cdate>"},"valid_to":{"format":"date","title":"Valid To","type":"string","isRequired":true,"uniqueKey":"address.oneOf.0.valid_to","typeLabel":"string\u003cdate>"},"address_line_1":{"oneOf":[{"type":"string","title":"Address Line 1","uniqueKey":"address.oneOf.0.address_line_1.oneOf.0","typeLabel":"string"},{"type":"null","title":"Address Line 1","uniqueKey":"address.oneOf.0.address_line_1.oneOf.1","typeLabel":"null"}],"uniqueKey":"address.oneOf.0.address_line_1","typeLabel":"string | null"},"address_line_2":{"oneOf":[{"type":"string","title":"Address Line 2","uniqueKey":"address.oneOf.0.address_line_2.oneOf.0","typeLabel":"string"},{"type":"null","title":"Address Line 2","uniqueKey":"address.oneOf.0.address_line_2.oneOf.1","typeLabel":"null"}],"uniqueKey":"address.oneOf.0.address_line_2","typeLabel":"string | null"},"address_line_3":{"oneOf":[{"type":"string","title":"Address Line 3","uniqueKey":"address.oneOf.0.address_line_3.oneOf.0","typeLabel":"string"},{"type":"null","title":"Address Line 3","uniqueKey":"address.oneOf.0.address_line_3.oneOf.1","typeLabel":"null"}],"uniqueKey":"address.oneOf.0.address_line_3","typeLabel":"string | null"},"address_line_4":{"oneOf":[{"type":"string","title":"Address Line 4","uniqueKey":"address.oneOf.0.address_line_4.oneOf.0","typeLabel":"string"},{"type":"null","title":"Address Line 4","uniqueKey":"address.oneOf.0.address_line_4.oneOf.1","typeLabel":"null"}],"uniqueKey":"address.oneOf.0.address_line_4","typeLabel":"string | null"},"country":{"oneOf":[{"type":"string","title":"Country","uniqueKey":"address.oneOf.0.country.oneOf.0","typeLabel":"string"},{"type":"null","title":"Country","uniqueKey":"address.oneOf.0.country.oneOf.1","typeLabel":"null"}],"uniqueKey":"address.oneOf.0.country","typeLabel":"string | null"},"county":{"oneOf":[{"type":"string","title":"County","uniqueKey":"address.oneOf.0.county.oneOf.0","typeLabel":"string"},{"type":"null","title":"County","uniqueKey":"address.oneOf.0.county.oneOf.1","typeLabel":"null"}],"uniqueKey":"address.oneOf.0.county","typeLabel":"string | null"},"postcode":{"oneOf":[{"type":"string","title":"Postcode","uniqueKey":"address.oneOf.0.postcode.oneOf.0","typeLabel":"string"},{"type":"null","title":"Postcode","uniqueKey":"address.oneOf.0.postcode.oneOf.1","typeLabel":"null"}],"uniqueKey":"address.oneOf.0.postcode","typeLabel":"string | null"},"town":{"oneOf":[{"type":"string","title":"Town","uniqueKey":"address.oneOf.0.town.oneOf.0","typeLabel":"string"},{"type":"null","title":"Town","uniqueKey":"address.oneOf.0.town.oneOf.1","typeLabel":"null"}],"uniqueKey":"address.oneOf.0.town","typeLabel":"string | null"}},"uniqueKey":"address.oneOf.0","typeLabel":"GBEmployeeAddressSatellite · object"},{"type":"null","uniqueKey":"address.oneOf.1","typeLabel":"null"}],"uniqueKey":"address","typeLabel":"GBEmployeeAddressSatellite · object | null"},"bank":{"oneOf":[{"type":"object","title":"GBEmployeeBankSatellite","required":["edition","valid_from","valid_to","created_at","created_by"],"properties":{"created_at":{"format":"date-time","readOnly":true,"title":"Created At","type":"string","isRequired":true,"uniqueKey":"bank.oneOf.0.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":"bank.oneOf.0.created_by","typeLabel":"string"},"edition":{"readOnly":true,"title":"Edition","type":"integer","isRequired":true,"uniqueKey":"bank.oneOf.0.edition","typeLabel":"integer"},"valid_from":{"format":"date","title":"Valid From","type":"string","isRequired":true,"uniqueKey":"bank.oneOf.0.valid_from","typeLabel":"string\u003cdate>"},"valid_to":{"format":"date","title":"Valid To","type":"string","isRequired":true,"uniqueKey":"bank.oneOf.0.valid_to","typeLabel":"string\u003cdate>"},"accounts":{"items":{"additionalProperties":false,"description":"An account as stored. Accounts moved from before the bank satellite were not\nchecked against the UK formats, so a read does not check them either.","properties":{"account_number":{"oneOf":[{"type":"string","title":"Account Number","uniqueKey":"bank.oneOf.0.accounts.items.[INDEX].account_number.oneOf.0","typeLabel":"string"},{"type":"null","title":"Account Number","uniqueKey":"bank.oneOf.0.accounts.items.[INDEX].account_number.oneOf.1","typeLabel":"null"}],"uniqueKey":"bank.oneOf.0.accounts.items.[INDEX].account_number","typeLabel":"string | null"},"allocation_percentage":{"oneOf":[{"type":"string","title":"Allocation Percentage","uniqueKey":"bank.oneOf.0.accounts.items.[INDEX].allocation_percentage.oneOf.0","typeLabel":"string"},{"type":"null","title":"Allocation Percentage","uniqueKey":"bank.oneOf.0.accounts.items.[INDEX].allocation_percentage.oneOf.1","typeLabel":"null"}],"uniqueKey":"bank.oneOf.0.accounts.items.[INDEX].allocation_percentage","typeLabel":"string | null"},"financial_institution_name":{"oneOf":[{"type":"string","title":"Financial Institution Name","uniqueKey":"bank.oneOf.0.accounts.items.[INDEX].financial_institution_name.oneOf.0","typeLabel":"string"},{"type":"null","title":"Financial Institution Name","uniqueKey":"bank.oneOf.0.accounts.items.[INDEX].financial_institution_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"bank.oneOf.0.accounts.items.[INDEX].financial_institution_name","typeLabel":"string | null"},"is_active":{"default":true,"description":"Inactive accounts are not paid into","title":"Is Active","type":"boolean","uniqueKey":"bank.oneOf.0.accounts.items.[INDEX].is_active","typeLabel":"boolean"},"is_primary":{"default":false,"description":"Receives the whole net pay when no account has an allocation","title":"Is Primary","type":"boolean","uniqueKey":"bank.oneOf.0.accounts.items.[INDEX].is_primary","typeLabel":"boolean"},"sort_code":{"oneOf":[{"type":"string","title":"Sort Code","uniqueKey":"bank.oneOf.0.accounts.items.[INDEX].sort_code.oneOf.0","typeLabel":"string"},{"type":"null","title":"Sort Code","uniqueKey":"bank.oneOf.0.accounts.items.[INDEX].sort_code.oneOf.1","typeLabel":"null"}],"uniqueKey":"bank.oneOf.0.accounts.items.[INDEX].sort_code","typeLabel":"string | null"}},"title":"GBBankAccountRead","type":"object","uniqueKey":"bank.oneOf.0.accounts.items.[INDEX]","typeLabel":"GBBankAccountRead · object"},"title":"Accounts","type":"array","uniqueKey":"bank.oneOf.0.accounts","typeLabel":"GBBankAccountRead · object[]"}},"additionalProperties":false,"uniqueKey":"bank.oneOf.0","typeLabel":"GBEmployeeBankSatellite · object"},{"type":"null","uniqueKey":"bank.oneOf.1","typeLabel":"null"}],"uniqueKey":"bank","typeLabel":"GBEmployeeBankSatellite · object | null"},"compensation":{"oneOf":[{"type":"object","title":"GBEmployeeCompensationSatellite","required":["edition","valid_from","valid_to","created_at","created_by"],"properties":{"created_at":{"format":"date-time","readOnly":true,"title":"Created At","type":"string","isRequired":true,"uniqueKey":"compensation.oneOf.0.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":"compensation.oneOf.0.created_by","typeLabel":"string"},"edition":{"readOnly":true,"title":"Edition","type":"integer","isRequired":true,"uniqueKey":"compensation.oneOf.0.edition","typeLabel":"integer"},"valid_from":{"format":"date","title":"Valid From","type":"string","isRequired":true,"uniqueKey":"compensation.oneOf.0.valid_from","typeLabel":"string\u003cdate>"},"valid_to":{"format":"date","title":"Valid To","type":"string","isRequired":true,"uniqueKey":"compensation.oneOf.0.valid_to","typeLabel":"string\u003cdate>"},"benefits":{"oneOf":[{"type":"array","items":{"additionalProperties":false,"properties":{"wage_type_code":{"description":"Wage type code from catalog (e.g. UK-B-001)","title":"Wage Type Code","type":"string","isRequired":true,"uniqueKey":"compensation.oneOf.0.benefits.oneOf.0.items.[INDEX].wage_type_code","typeLabel":"string"},"amount":{"oneOf":[{"type":"string","title":"Amount","description":"Amount of benefit","default":"0.00","uniqueKey":"compensation.oneOf.0.benefits.oneOf.0.items.[INDEX].amount.oneOf.0","typeLabel":"string"},{"type":"null","title":"Amount","description":"Amount of benefit","default":"0.00","uniqueKey":"compensation.oneOf.0.benefits.oneOf.0.items.[INDEX].amount.oneOf.1","typeLabel":"null"}],"uniqueKey":"compensation.oneOf.0.benefits.oneOf.0.items.[INDEX].amount","typeLabel":"string | null"},"cash_alternative_amount":{"oneOf":[{"type":"string","title":"Cash Alternative Amount","description":"Cash alternative the employee declined in favour of this benefit (Type B OpRA). Contributes to BIK higher-of valuation only; does NOT reduce gross. The wage type's is_salary_sacrifice_allowed must be true.","default":"0.00","uniqueKey":"compensation.oneOf.0.benefits.oneOf.0.items.[INDEX].cash_alternative_amount.oneOf.0","typeLabel":"string"},{"type":"null","title":"Cash Alternative Amount","description":"Cash alternative the employee declined in favour of this benefit (Type B OpRA). Contributes to BIK higher-of valuation only; does NOT reduce gross. The wage type's is_salary_sacrifice_allowed must be true.","default":"0.00","uniqueKey":"compensation.oneOf.0.benefits.oneOf.0.items.[INDEX].cash_alternative_amount.oneOf.1","typeLabel":"null"}],"uniqueKey":"compensation.oneOf.0.benefits.oneOf.0.items.[INDEX].cash_alternative_amount","typeLabel":"string | null"},"external_ref":{"oneOf":[{"type":"string","title":"External Ref","description":"Caller-owned line key, scoped to (payrun, employee, wage_type). Re-send with the same value to patch that line in place. Omit for the single default line of the wage type (also patched in place on re-send). Use distinct values to carry multiple lines of one wage type.","uniqueKey":"compensation.oneOf.0.benefits.oneOf.0.items.[INDEX].external_ref.oneOf.0","typeLabel":"string"},{"type":"null","title":"External Ref","description":"Caller-owned line key, scoped to (payrun, employee, wage_type). Re-send with the same value to patch that line in place. Omit for the single default line of the wage type (also patched in place on re-send). Use distinct values to carry multiple lines of one wage type.","uniqueKey":"compensation.oneOf.0.benefits.oneOf.0.items.[INDEX].external_ref.oneOf.1","typeLabel":"null"}],"uniqueKey":"compensation.oneOf.0.benefits.oneOf.0.items.[INDEX].external_ref","typeLabel":"string | null"},"foregone_amount":{"oneOf":[{"type":"string","title":"Foregone Amount","description":"If subject to OpRa, amount foregone","default":"0.00","uniqueKey":"compensation.oneOf.0.benefits.oneOf.0.items.[INDEX].foregone_amount.oneOf.0","typeLabel":"string"},{"type":"null","title":"Foregone Amount","description":"If subject to OpRa, amount foregone","default":"0.00","uniqueKey":"compensation.oneOf.0.benefits.oneOf.0.items.[INDEX].foregone_amount.oneOf.1","typeLabel":"null"}],"uniqueKey":"compensation.oneOf.0.benefits.oneOf.0.items.[INDEX].foregone_amount","typeLabel":"string | null"},"make_good_amount":{"oneOf":[{"type":"string","title":"Make Good Amount","description":"Amount paid by employee for the benefit","default":"0.00","uniqueKey":"compensation.oneOf.0.benefits.oneOf.0.items.[INDEX].make_good_amount.oneOf.0","typeLabel":"string"},{"type":"null","title":"Make Good Amount","description":"Amount paid by employee for the benefit","default":"0.00","uniqueKey":"compensation.oneOf.0.benefits.oneOf.0.items.[INDEX].make_good_amount.oneOf.1","typeLabel":"null"}],"uniqueKey":"compensation.oneOf.0.benefits.oneOf.0.items.[INDEX].make_good_amount","typeLabel":"string | null"}},"required":["wage_type_code"],"title":"Benefits","type":"object","uniqueKey":"compensation.oneOf.0.benefits.oneOf.0.items.[INDEX]","typeLabel":"Benefits · object"},"title":"Benefits","uniqueKey":"compensation.oneOf.0.benefits.oneOf.0","typeLabel":"Benefits · object[]"},{"type":"null","title":"Benefits","uniqueKey":"compensation.oneOf.0.benefits.oneOf.1","typeLabel":"null"}],"uniqueKey":"compensation.oneOf.0.benefits","typeLabel":"Benefits · object[] | null"},"deductions":{"oneOf":[{"type":"array","items":{"additionalProperties":false,"properties":{"amount":{"title":"Amount","type":"string","isRequired":true,"uniqueKey":"compensation.oneOf.0.deductions.oneOf.0.items.[INDEX].amount","typeLabel":"string"},"wage_type_code":{"description":"Wage type code from catalog (e.g. UK-D-001)","title":"Wage Type Code","type":"string","isRequired":true,"uniqueKey":"compensation.oneOf.0.deductions.oneOf.0.items.[INDEX].wage_type_code","typeLabel":"string"},"external_ref":{"oneOf":[{"type":"string","title":"External Ref","description":"Caller-owned line key, scoped to (payrun, employee, wage_type). Re-send with the same value to patch that line in place. Omit for the single default line of the wage type (also patched in place on re-send). Use distinct values to carry multiple lines of one wage type.","uniqueKey":"compensation.oneOf.0.deductions.oneOf.0.items.[INDEX].external_ref.oneOf.0","typeLabel":"string"},{"type":"null","title":"External Ref","description":"Caller-owned line key, scoped to (payrun, employee, wage_type). Re-send with the same value to patch that line in place. Omit for the single default line of the wage type (also patched in place on re-send). Use distinct values to carry multiple lines of one wage type.","uniqueKey":"compensation.oneOf.0.deductions.oneOf.0.items.[INDEX].external_ref.oneOf.1","typeLabel":"null"}],"uniqueKey":"compensation.oneOf.0.deductions.oneOf.0.items.[INDEX].external_ref","typeLabel":"string | null"},"sacrificed_amount":{"oneOf":[{"type":"string","title":"Sacrificed Amount","description":"Portion of this deduction that is pre-tax salary sacrifice (Type A OpRA). Must be > 0 and \u003c= amount when set. The wage type's is_salary_sacrifice_allowed must be true.","uniqueKey":"compensation.oneOf.0.deductions.oneOf.0.items.[INDEX].sacrificed_amount.oneOf.0","typeLabel":"string"},{"type":"null","title":"Sacrificed Amount","description":"Portion of this deduction that is pre-tax salary sacrifice (Type A OpRA). Must be > 0 and \u003c= amount when set. The wage type's is_salary_sacrifice_allowed must be true.","uniqueKey":"compensation.oneOf.0.deductions.oneOf.0.items.[INDEX].sacrificed_amount.oneOf.1","typeLabel":"null"}],"uniqueKey":"compensation.oneOf.0.deductions.oneOf.0.items.[INDEX].sacrificed_amount","typeLabel":"string | null"}},"required":["wage_type_code","amount"],"title":"Deductions","type":"object","uniqueKey":"compensation.oneOf.0.deductions.oneOf.0.items.[INDEX]","typeLabel":"Deductions · object"},"title":"Deductions","uniqueKey":"compensation.oneOf.0.deductions.oneOf.0","typeLabel":"Deductions · object[]"},{"type":"null","title":"Deductions","uniqueKey":"compensation.oneOf.0.deductions.oneOf.1","typeLabel":"null"}],"uniqueKey":"compensation.oneOf.0.deductions","typeLabel":"Deductions · object[] | null"},"earnings":{"oneOf":[{"type":"array","items":{"additionalProperties":false,"description":"Fixed-amount earnings (salary, bonus, allowance). Amount + frequency.","properties":{"amount":{"description":"Earnings amount (negative values represent period adjustments, e.g. leave reductions)","title":"Amount","type":"string","isRequired":true,"uniqueKey":"compensation.oneOf.0.earnings.oneOf.0.items.[INDEX].amount","typeLabel":"string"},"wage_type_code":{"description":"Wage type code from catalog (e.g. UK-E-001)","title":"Wage Type Code","type":"string","isRequired":true,"uniqueKey":"compensation.oneOf.0.earnings.oneOf.0.items.[INDEX].wage_type_code","typeLabel":"string"},"earning_frequency":{"oneOf":[{"type":"string","title":"PayCycle","description":"If recurring, specify the frequency","default":"MONTH","enum":["YEAR","MONTH","WEEK","TWO_WEEK","FOUR_WEEK","QUARTER","BIANNUAL"],"uniqueKey":"compensation.oneOf.0.earnings.oneOf.0.items.[INDEX].earning_frequency.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","description":"If recurring, specify the frequency","default":"MONTH","uniqueKey":"compensation.oneOf.0.earnings.oneOf.0.items.[INDEX].earning_frequency.oneOf.1","typeLabel":"null"}],"uniqueKey":"compensation.oneOf.0.earnings.oneOf.0.items.[INDEX].earning_frequency","typeLabel":"enum\u003cstring> | null"},"earning_type":{"const":"AMOUNT","default":"AMOUNT","title":"Earning Type","type":"string","uniqueKey":"compensation.oneOf.0.earnings.oneOf.0.items.[INDEX].earning_type","typeLabel":"string"},"external_ref":{"oneOf":[{"type":"string","title":"External Ref","description":"Caller-owned line key, scoped to (payrun, employee, wage_type). Re-send with the same value to patch that line in place. Omit for the single default line of the wage type (also patched in place on re-send). Use distinct values to carry multiple lines of one wage type.","uniqueKey":"compensation.oneOf.0.earnings.oneOf.0.items.[INDEX].external_ref.oneOf.0","typeLabel":"string"},{"type":"null","title":"External Ref","description":"Caller-owned line key, scoped to (payrun, employee, wage_type). Re-send with the same value to patch that line in place. Omit for the single default line of the wage type (also patched in place on re-send). Use distinct values to carry multiple lines of one wage type.","uniqueKey":"compensation.oneOf.0.earnings.oneOf.0.items.[INDEX].external_ref.oneOf.1","typeLabel":"null"}],"uniqueKey":"compensation.oneOf.0.earnings.oneOf.0.items.[INDEX].external_ref","typeLabel":"string | null"},"is_lumpsum":{"default":false,"description":"True if onetime. Defaults to False","title":"Is Lumpsum","type":"boolean","uniqueKey":"compensation.oneOf.0.earnings.oneOf.0.items.[INDEX].is_lumpsum","typeLabel":"boolean"},"sacrificed_amount":{"oneOf":[{"type":"string","title":"Sacrificed Amount","description":"Amount of this earning the employee has sacrificed (Type A OpRA). Pre-tax. Must be > 0 when set. The wage type's is_salary_sacrifice_allowed must be true","uniqueKey":"compensation.oneOf.0.earnings.oneOf.0.items.[INDEX].sacrificed_amount.oneOf.0","typeLabel":"string"},{"type":"null","title":"Sacrificed Amount","description":"Amount of this earning the employee has sacrificed (Type A OpRA). Pre-tax. Must be > 0 when set. The wage type's is_salary_sacrifice_allowed must be true","uniqueKey":"compensation.oneOf.0.earnings.oneOf.0.items.[INDEX].sacrificed_amount.oneOf.1","typeLabel":"null"}],"uniqueKey":"compensation.oneOf.0.earnings.oneOf.0.items.[INDEX].sacrificed_amount","typeLabel":"string | null"}},"required":["wage_type_code","amount"],"title":"AmountEarnings","type":"object","uniqueKey":"compensation.oneOf.0.earnings.oneOf.0.items.[INDEX]","typeLabel":"AmountEarnings · object"},"title":"Earnings","uniqueKey":"compensation.oneOf.0.earnings.oneOf.0","typeLabel":"AmountEarnings · object[]"},{"type":"null","title":"Earnings","uniqueKey":"compensation.oneOf.0.earnings.oneOf.1","typeLabel":"null"}],"uniqueKey":"compensation.oneOf.0.earnings","typeLabel":"AmountEarnings · object[] | null"},"reimbursements":{"oneOf":[{"type":"array","items":{"additionalProperties":false,"properties":{"amount":{"title":"Amount","type":"string","isRequired":true,"uniqueKey":"compensation.oneOf.0.reimbursements.oneOf.0.items.[INDEX].amount","typeLabel":"string"},"wage_type_code":{"description":"Wage type code from catalog (e.g. UK-R-001)","title":"Wage Type Code","type":"string","isRequired":true,"uniqueKey":"compensation.oneOf.0.reimbursements.oneOf.0.items.[INDEX].wage_type_code","typeLabel":"string"},"external_ref":{"oneOf":[{"type":"string","title":"External Ref","description":"Caller-owned line key, scoped to (payrun, employee, wage_type). Re-send with the same value to patch that line in place. Omit for the single default line of the wage type (also patched in place on re-send). Use distinct values to carry multiple lines of one wage type.","uniqueKey":"compensation.oneOf.0.reimbursements.oneOf.0.items.[INDEX].external_ref.oneOf.0","typeLabel":"string"},{"type":"null","title":"External Ref","description":"Caller-owned line key, scoped to (payrun, employee, wage_type). Re-send with the same value to patch that line in place. Omit for the single default line of the wage type (also patched in place on re-send). Use distinct values to carry multiple lines of one wage type.","uniqueKey":"compensation.oneOf.0.reimbursements.oneOf.0.items.[INDEX].external_ref.oneOf.1","typeLabel":"null"}],"uniqueKey":"compensation.oneOf.0.reimbursements.oneOf.0.items.[INDEX].external_ref","typeLabel":"string | null"}},"required":["wage_type_code","amount"],"title":"Reimbursement","type":"object","uniqueKey":"compensation.oneOf.0.reimbursements.oneOf.0.items.[INDEX]","typeLabel":"Reimbursement · object"},"title":"Reimbursements","uniqueKey":"compensation.oneOf.0.reimbursements.oneOf.0","typeLabel":"Reimbursement · object[]"},{"type":"null","title":"Reimbursements","uniqueKey":"compensation.oneOf.0.reimbursements.oneOf.1","typeLabel":"null"}],"uniqueKey":"compensation.oneOf.0.reimbursements","typeLabel":"Reimbursement · object[] | null"}},"additionalProperties":false,"uniqueKey":"compensation.oneOf.0","typeLabel":"GBEmployeeCompensationSatellite · object"},{"type":"null","uniqueKey":"compensation.oneOf.1","typeLabel":"null"}],"uniqueKey":"compensation","typeLabel":"GBEmployeeCompensationSatellite · object | null"},"core":{"oneOf":[{"type":"object","title":"GBEmployeeCoreSatellite","required":["edition","valid_from","valid_to","created_at","created_by"],"properties":{"created_at":{"format":"date-time","readOnly":true,"title":"Created At","type":"string","isRequired":true,"uniqueKey":"core.oneOf.0.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":"core.oneOf.0.created_by","typeLabel":"string"},"edition":{"readOnly":true,"title":"Edition","type":"integer","isRequired":true,"uniqueKey":"core.oneOf.0.edition","typeLabel":"integer"},"valid_from":{"format":"date","title":"Valid From","type":"string","isRequired":true,"uniqueKey":"core.oneOf.0.valid_from","typeLabel":"string\u003cdate>"},"valid_to":{"format":"date","title":"Valid To","type":"string","isRequired":true,"uniqueKey":"core.oneOf.0.valid_to","typeLabel":"string\u003cdate>"},"birth_date":{"oneOf":[{"type":"string","title":"Birth Date","description":"Birth date","format":"date","uniqueKey":"core.oneOf.0.birth_date.oneOf.0","typeLabel":"string\u003cdate>"},{"type":"null","title":"Birth Date","description":"Birth date","uniqueKey":"core.oneOf.0.birth_date.oneOf.1","typeLabel":"null"}],"uniqueKey":"core.oneOf.0.birth_date","typeLabel":"string\u003cdate> | null"},"first_name":{"default":"","description":"First forename","title":"First Name","type":"string","uniqueKey":"core.oneOf.0.first_name","typeLabel":"string"},"gender":{"oneOf":[{"type":"string","title":"EmployeeGender","description":"Gender","enum":["MALE","FEMALE"],"uniqueKey":"core.oneOf.0.gender.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","description":"Gender","uniqueKey":"core.oneOf.0.gender.oneOf.1","typeLabel":"null"}],"uniqueKey":"core.oneOf.0.gender","typeLabel":"enum\u003cstring> | null"},"last_name":{"default":"","description":"Surname","title":"Last Name","type":"string","uniqueKey":"core.oneOf.0.last_name","typeLabel":"string"},"maiden_name":{"oneOf":[{"type":"string","title":"Maiden Name","description":"Surname before marriage","uniqueKey":"core.oneOf.0.maiden_name.oneOf.0","typeLabel":"string"},{"type":"null","title":"Maiden Name","description":"Surname before marriage","uniqueKey":"core.oneOf.0.maiden_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"core.oneOf.0.maiden_name","typeLabel":"string | null"},"marital_status":{"oneOf":[{"type":"string","title":"MaritalStatus","description":"Marital status","enum":["SINGLE","MARRIED"],"uniqueKey":"core.oneOf.0.marital_status.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","description":"Marital status","uniqueKey":"core.oneOf.0.marital_status.oneOf.1","typeLabel":"null"}],"uniqueKey":"core.oneOf.0.marital_status","typeLabel":"enum\u003cstring> | null"},"middle_name":{"oneOf":[{"type":"string","title":"Middle Name","description":"Second forename","uniqueKey":"core.oneOf.0.middle_name.oneOf.0","typeLabel":"string"},{"type":"null","title":"Middle Name","description":"Second forename","uniqueKey":"core.oneOf.0.middle_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"core.oneOf.0.middle_name","typeLabel":"string | null"},"personal_email":{"oneOf":[{"type":"string","title":"Personal Email","format":"email","uniqueKey":"core.oneOf.0.personal_email.oneOf.0","typeLabel":"string\u003cemail>"},{"type":"null","title":"Personal Email","uniqueKey":"core.oneOf.0.personal_email.oneOf.1","typeLabel":"null"}],"uniqueKey":"core.oneOf.0.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":"core.oneOf.0.phone_numbers.items.[INDEX].phone_number","typeLabel":"string\u003cphone>"},"phone_type":{"enum":["MOBILE","HOME","WORK"],"title":"PhoneType","type":"string","isRequired":true,"uniqueKey":"core.oneOf.0.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":"core.oneOf.0.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":"core.oneOf.0.phone_numbers.items.[INDEX].is_primary.oneOf.1","typeLabel":"null"}],"uniqueKey":"core.oneOf.0.phone_numbers.items.[INDEX].is_primary","typeLabel":"boolean | null"}},"required":["phone_number","phone_type"],"title":"GBPhonesRead","type":"object","uniqueKey":"core.oneOf.0.phone_numbers.items.[INDEX]","typeLabel":"GBPhonesRead · object"},"title":"Phone Numbers","type":"array","uniqueKey":"core.oneOf.0.phone_numbers","typeLabel":"GBPhonesRead · object[]"},"title":{"oneOf":[{"type":"string","title":"Title","description":"Title","uniqueKey":"core.oneOf.0.title.oneOf.0","typeLabel":"string"},{"type":"null","title":"Title","description":"Title","uniqueKey":"core.oneOf.0.title.oneOf.1","typeLabel":"null"}],"uniqueKey":"core.oneOf.0.title","typeLabel":"string | null"},"work_email":{"oneOf":[{"type":"string","title":"Work Email","format":"email","uniqueKey":"core.oneOf.0.work_email.oneOf.0","typeLabel":"string\u003cemail>"},{"type":"null","title":"Work Email","uniqueKey":"core.oneOf.0.work_email.oneOf.1","typeLabel":"null"}],"uniqueKey":"core.oneOf.0.work_email","typeLabel":"string\u003cemail> | null"}},"additionalProperties":false,"uniqueKey":"core.oneOf.0","typeLabel":"GBEmployeeCoreSatellite · object"},{"type":"null","uniqueKey":"core.oneOf.1","typeLabel":"null"}],"uniqueKey":"core","typeLabel":"GBEmployeeCoreSatellite · object | null"},"insurance":{"oneOf":[{"type":"object","title":"GBEmployeeInsuranceSatellite","required":["edition","valid_from","valid_to","created_at","created_by"],"properties":{"created_at":{"format":"date-time","readOnly":true,"title":"Created At","type":"string","isRequired":true,"uniqueKey":"insurance.oneOf.0.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":"insurance.oneOf.0.created_by","typeLabel":"string"},"edition":{"readOnly":true,"title":"Edition","type":"integer","isRequired":true,"uniqueKey":"insurance.oneOf.0.edition","typeLabel":"integer"},"valid_from":{"format":"date","title":"Valid From","type":"string","isRequired":true,"uniqueKey":"insurance.oneOf.0.valid_from","typeLabel":"string\u003cdate>"},"valid_to":{"format":"date","title":"Valid To","type":"string","isRequired":true,"uniqueKey":"insurance.oneOf.0.valid_to","typeLabel":"string\u003cdate>"},"national_insurance_number":{"oneOf":[{"type":"string","title":"National Insurance Number","description":"National Insurance number","uniqueKey":"insurance.oneOf.0.national_insurance_number.oneOf.0","typeLabel":"string"},{"type":"null","title":"National Insurance Number","description":"National Insurance number","uniqueKey":"insurance.oneOf.0.national_insurance_number.oneOf.1","typeLabel":"null"}],"uniqueKey":"insurance.oneOf.0.national_insurance_number","typeLabel":"string | null"},"nic_category":{"oneOf":[{"type":"string","title":"NICCategory","description":"NIC Letter Categories","enum":["A","B","C","D","E","F","H","I","J","K","L","M","N","S","V","X","Z"],"uniqueKey":"insurance.oneOf.0.nic_category.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","uniqueKey":"insurance.oneOf.0.nic_category.oneOf.1","typeLabel":"null"}],"uniqueKey":"insurance.oneOf.0.nic_category","typeLabel":"enum\u003cstring> | null"},"overseas_national_awaiting_nino":{"oneOf":[{"type":"boolean","title":"Overseas National Awaiting Nino","description":"Overseas national waiting for a National Insurance number; asked by NEST when there is no number, and decides whether NEST claims tax relief. Null when not answered","uniqueKey":"insurance.oneOf.0.overseas_national_awaiting_nino.oneOf.0","typeLabel":"boolean"},{"type":"null","title":"Overseas National Awaiting Nino","description":"Overseas national waiting for a National Insurance number; asked by NEST when there is no number, and decides whether NEST claims tax relief. Null when not answered","uniqueKey":"insurance.oneOf.0.overseas_national_awaiting_nino.oneOf.1","typeLabel":"null"}],"uniqueKey":"insurance.oneOf.0.overseas_national_awaiting_nino","typeLabel":"boolean | null"}},"additionalProperties":false,"uniqueKey":"insurance.oneOf.0","typeLabel":"GBEmployeeInsuranceSatellite · object"},{"type":"null","uniqueKey":"insurance.oneOf.1","typeLabel":"null"}],"uniqueKey":"insurance","typeLabel":"GBEmployeeInsuranceSatellite · object | null"},"job":{"oneOf":[{"type":"object","title":"GBEmployeeJobSatellite","required":["edition","valid_from","valid_to","created_at","created_by"],"properties":{"created_at":{"format":"date-time","readOnly":true,"title":"Created At","type":"string","isRequired":true,"uniqueKey":"job.oneOf.0.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":"job.oneOf.0.created_by","typeLabel":"string"},"edition":{"readOnly":true,"title":"Edition","type":"integer","isRequired":true,"uniqueKey":"job.oneOf.0.edition","typeLabel":"integer"},"valid_from":{"format":"date","title":"Valid From","type":"string","isRequired":true,"uniqueKey":"job.oneOf.0.valid_from","typeLabel":"string\u003cdate>"},"valid_to":{"format":"date","title":"Valid To","type":"string","isRequired":true,"uniqueKey":"job.oneOf.0.valid_to","typeLabel":"string\u003cdate>"},"apprenticeship":{"oneOf":[{"type":"object","title":"Apprenticeship","description":"Apprenticeship details","required":["start_date","expected_end_date","level"],"properties":{"expected_end_date":{"oneOf":[{"type":"string","title":"Expected End Date","description":"Expected end date (informational); null when not known","format":"date","isRequired":true,"uniqueKey":"job.oneOf.0.apprenticeship.oneOf.0.expected_end_date.oneOf.0","typeLabel":"string\u003cdate>"},{"type":"null","title":"Expected End Date","description":"Expected end date (informational); null when not known","isRequired":true,"uniqueKey":"job.oneOf.0.apprenticeship.oneOf.0.expected_end_date.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"job.oneOf.0.apprenticeship.oneOf.0.expected_end_date","typeLabel":"string\u003cdate> | null"},"level":{"description":"UK apprenticeship level (2-7)","maximum":7,"minimum":2,"title":"Level","type":"integer","isRequired":true,"uniqueKey":"job.oneOf.0.apprenticeship.oneOf.0.level","typeLabel":"integer"},"start_date":{"description":"Start date of current apprenticeship agreement","format":"date","title":"Start Date","type":"string","isRequired":true,"uniqueKey":"job.oneOf.0.apprenticeship.oneOf.0.start_date","typeLabel":"string\u003cdate>"}},"additionalProperties":false,"uniqueKey":"job.oneOf.0.apprenticeship.oneOf.0","typeLabel":"Apprenticeship · object"},{"type":"null","description":"Apprenticeship details","uniqueKey":"job.oneOf.0.apprenticeship.oneOf.1","typeLabel":"null"}],"uniqueKey":"job.oneOf.0.apprenticeship","typeLabel":"Apprenticeship · object | null"},"contracted_weekdays":{"oneOf":[{"type":"array","items":{"description":"Days of the week.","enum":["MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY","SUNDAY"],"title":"Weekday","type":"string","uniqueKey":"job.oneOf.0.contracted_weekdays.oneOf.0.items.[INDEX]","typeLabel":"enum\u003cstring>"},"title":"Contracted Weekdays","description":"Contracted working days of the week","uniqueKey":"job.oneOf.0.contracted_weekdays.oneOf.0","typeLabel":"enum\u003cstring>[]"},{"type":"null","title":"Contracted Weekdays","description":"Contracted working days of the week","uniqueKey":"job.oneOf.0.contracted_weekdays.oneOf.1","typeLabel":"null"}],"uniqueKey":"job.oneOf.0.contracted_weekdays","typeLabel":"enum\u003cstring>[] | null"},"contracted_weekly_hours":{"oneOf":[{"type":"integer","title":"Contracted Weekly Hours","description":"Contracted weekly hours","default":40,"uniqueKey":"job.oneOf.0.contracted_weekly_hours.oneOf.0","typeLabel":"integer"},{"type":"null","title":"Contracted Weekly Hours","description":"Contracted weekly hours","default":40,"uniqueKey":"job.oneOf.0.contracted_weekly_hours.oneOf.1","typeLabel":"null"}],"uniqueKey":"job.oneOf.0.contracted_weekly_hours","typeLabel":"integer | null"},"department":{"oneOf":[{"type":"string","title":"Department","description":"Department","uniqueKey":"job.oneOf.0.department.oneOf.0","typeLabel":"string"},{"type":"null","title":"Department","description":"Department","uniqueKey":"job.oneOf.0.department.oneOf.1","typeLabel":"null"}],"uniqueKey":"job.oneOf.0.department","typeLabel":"string | null"},"director_since":{"oneOf":[{"type":"string","title":"Director Since","description":"Date appointed as director","format":"date","uniqueKey":"job.oneOf.0.director_since.oneOf.0","typeLabel":"string\u003cdate>"},{"type":"null","title":"Director Since","description":"Date appointed as director","uniqueKey":"job.oneOf.0.director_since.oneOf.1","typeLabel":"null"}],"uniqueKey":"job.oneOf.0.director_since","typeLabel":"string\u003cdate> | null"},"end_date":{"oneOf":[{"type":"string","title":"End Date","description":"Last day of employment","format":"date","uniqueKey":"job.oneOf.0.end_date.oneOf.0","typeLabel":"string\u003cdate>"},{"type":"null","title":"End Date","description":"Last day of employment","uniqueKey":"job.oneOf.0.end_date.oneOf.1","typeLabel":"null"}],"uniqueKey":"job.oneOf.0.end_date","typeLabel":"string\u003cdate> | null"},"engagement_type":{"description":"How the worker is engaged. EMPLOYEE: a direct employee under PAYE. OFF_PAYROLL: subject to the off-payroll working rules (IR35, Chapter 10 ITEPA 2003), with this employer as the deemed employer; reported to HMRC as OffPayrollWorker, and no student or postgraduate loan is deducted. Independent of worker_type: a director can be off-payroll. Changing it within a tax year after a payment is not supported yet: the next FPS fails. More values will be added; accept values you do not know.","enum":["EMPLOYEE","OFF_PAYROLL"],"title":"EngagementType","type":"string","default":"EMPLOYEE","uniqueKey":"job.oneOf.0.engagement_type","typeLabel":"enum\u003cstring>"},"irregular_payment_pattern":{"default":false,"description":"The employee is not paid every pay period","title":"Irregular Payment Pattern","type":"boolean","uniqueKey":"job.oneOf.0.irregular_payment_pattern","typeLabel":"boolean"},"ordinarily_works_in_uk":{"default":true,"description":"Whether the worker's ordinary place of work is in the UK","title":"Ordinarily Works In Uk","type":"boolean","uniqueKey":"job.oneOf.0.ordinarily_works_in_uk","typeLabel":"boolean"},"p45_issued":{"default":false,"description":"True once a P45 has been issued","title":"P45 Issued","type":"boolean","uniqueKey":"job.oneOf.0.p45_issued","typeLabel":"boolean"},"pay_basis":{"description":"How pay and hours are determined","enum":["SALARIED","HOURLY"],"title":"PayBasis","type":"string","default":"SALARIED","uniqueKey":"job.oneOf.0.pay_basis","typeLabel":"enum\u003cstring>"},"pay_group_id":{"oneOf":[{"type":"string","title":"Pay Group Id","description":"The pay group the employee is paid in","uniqueKey":"job.oneOf.0.pay_group_id.oneOf.0","typeLabel":"string"},{"type":"null","title":"Pay Group Id","description":"The pay group the employee is paid in","uniqueKey":"job.oneOf.0.pay_group_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"job.oneOf.0.pay_group_id","typeLabel":"string | null"},"proration_basis":{"oneOf":[{"type":"object","title":"ProrationBasis","description":"Employee-level override of the inherited proration basis","required":["mode"],"properties":{"mode":{"description":"Salary-apportionment basis for proration.","enum":["CALENDAR_DAY","CONTRACTED_DAY","CONTRACTED_HOURS"],"title":"BasisMode","type":"string","isRequired":true,"uniqueKey":"job.oneOf.0.proration_basis.oneOf.0.mode","typeLabel":"enum\u003cstring>"},"business_days_per_year":{"oneOf":[{"type":"string","title":"Business Days Per Year","uniqueKey":"job.oneOf.0.proration_basis.oneOf.0.business_days_per_year.oneOf.0","typeLabel":"string"},{"type":"null","title":"Business Days Per Year","uniqueKey":"job.oneOf.0.proration_basis.oneOf.0.business_days_per_year.oneOf.1","typeLabel":"null"}],"uniqueKey":"job.oneOf.0.proration_basis.oneOf.0.business_days_per_year","typeLabel":"string | null"}},"uniqueKey":"job.oneOf.0.proration_basis.oneOf.0","typeLabel":"ProrationBasis · object"},{"type":"null","description":"Employee-level override of the inherited proration basis","uniqueKey":"job.oneOf.0.proration_basis.oneOf.1","typeLabel":"null"}],"uniqueKey":"job.oneOf.0.proration_basis","typeLabel":"ProrationBasis · object | null"},"start_date":{"oneOf":[{"type":"string","title":"Start Date","description":"Employment start date","format":"date","uniqueKey":"job.oneOf.0.start_date.oneOf.0","typeLabel":"string\u003cdate>"},{"type":"null","title":"Start Date","description":"Employment start date","uniqueKey":"job.oneOf.0.start_date.oneOf.1","typeLabel":"null"}],"uniqueKey":"job.oneOf.0.start_date","typeLabel":"string\u003cdate> | null"},"uk_work_exclusion_reason":{"description":"Why the worker does not ordinarily work in the UK","enum":["NOT_APPLICABLE","OVERSEAS_CONTRACT","OUTBOUND_POSTING","INBOUND_TEMPORARY_POSTING","MOBILE_WORKER_OVERSEAS_BASE","OTHER"],"title":"UKWorkExclusionReason","type":"string","default":"NOT_APPLICABLE","uniqueKey":"job.oneOf.0.uk_work_exclusion_reason","typeLabel":"enum\u003cstring>"},"worker_type":{"description":"UK employment status","enum":["EMPLOYEE","DIRECTOR"],"title":"WorkerType","type":"string","default":"EMPLOYEE","uniqueKey":"job.oneOf.0.worker_type","typeLabel":"enum\u003cstring>"},"workplace_postcode":{"oneOf":[{"type":"string","title":"Workplace Postcode","description":"UK postcode of the Freeport or Investment Zone special tax site where the employee works, e.g. \"SW1A 1AA\". Reported to HMRC while a Freeport or Investment Zone NI category letter (F, I, L, S, N, E, D, K) applies in the tax year; approving a payrun that needs it and has none is refused. Whether the postcode lies inside a special tax site is not checked. Null when none.","pattern":"^[A-Z]([0-9]|[0-9]{2}|([A-HJ-Y][0-9]{1,2})|([0-9][A-Z])|([A-HJ-Y][0-9]?[A-Z])) [0-9][ABD-HJLNP-UW-Z]{2}$","uniqueKey":"job.oneOf.0.workplace_postcode.oneOf.0","typeLabel":"string"},{"type":"null","title":"Workplace Postcode","description":"UK postcode of the Freeport or Investment Zone special tax site where the employee works, e.g. \"SW1A 1AA\". Reported to HMRC while a Freeport or Investment Zone NI category letter (F, I, L, S, N, E, D, K) applies in the tax year; approving a payrun that needs it and has none is refused. Whether the postcode lies inside a special tax site is not checked. Null when none.","uniqueKey":"job.oneOf.0.workplace_postcode.oneOf.1","typeLabel":"null"}],"uniqueKey":"job.oneOf.0.workplace_postcode","typeLabel":"string | null"}},"additionalProperties":false,"uniqueKey":"job.oneOf.0","typeLabel":"GBEmployeeJobSatellite · object"},{"type":"null","uniqueKey":"job.oneOf.1","typeLabel":"null"}],"uniqueKey":"job","typeLabel":"GBEmployeeJobSatellite · object | null"},"tax":{"oneOf":[{"type":"object","title":"GBEmployeeTaxSatellite","required":["starter_details","edition","valid_from","valid_to","created_at","created_by"],"properties":{"created_at":{"format":"date-time","readOnly":true,"title":"Created At","type":"string","isRequired":true,"uniqueKey":"tax.oneOf.0.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":"tax.oneOf.0.created_by","typeLabel":"string"},"edition":{"readOnly":true,"title":"Edition","type":"integer","isRequired":true,"uniqueKey":"tax.oneOf.0.edition","typeLabel":"integer"},"starter_details":{"oneOf":[{"type":"object","title":"StarterDetailsDeclaration","description":"A new employee who completed the starter checklist.","required":["basis","declaration"],"properties":{"basis":{"const":"DECLARATION","title":"Basis","type":"string","isRequired":true,"uniqueKey":"tax.oneOf.0.starter_details.oneOf.0.basis","typeLabel":"string"},"declaration":{"description":"Starter checklist statement A, B or C","enum":["A","B","C"],"title":"StarterDeclaration","type":"string","isRequired":true,"uniqueKey":"tax.oneOf.0.starter_details.oneOf.0.declaration","typeLabel":"enum\u003cstring>"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"tax.oneOf.0.starter_details.oneOf.0","typeLabel":"StarterDetailsDeclaration · object"},{"type":"object","title":"StarterDetailsSeconded","description":"An employee seconded to work in the UK, who completed the expatriate checklist.","required":["basis","stay","eea_citizen","epm6","declaration"],"properties":{"basis":{"const":"SECONDED","title":"Basis","type":"string","isRequired":true,"uniqueKey":"tax.oneOf.0.starter_details.oneOf.1.basis","typeLabel":"string"},"declaration":{"oneOf":[{"type":"string","title":"StarterDeclaration","description":"Starter checklist statement; required without a stay, null with one","enum":["A","B","C"],"isRequired":true,"uniqueKey":"tax.oneOf.0.starter_details.oneOf.1.declaration.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","description":"Starter checklist statement; required without a stay, null with one","isRequired":true,"uniqueKey":"tax.oneOf.0.starter_details.oneOf.1.declaration.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"tax.oneOf.0.starter_details.oneOf.1.declaration","typeLabel":"enum\u003cstring> | null"},"eea_citizen":{"description":"EEA citizen; only with a stay","title":"Eea Citizen","type":"boolean","isRequired":true,"uniqueKey":"tax.oneOf.0.starter_details.oneOf.1.eea_citizen","typeLabel":"boolean"},"epm6":{"description":"In HMRC's modified PAYE scheme for tax-equalised expatriates","title":"Epm6","type":"boolean","isRequired":true,"uniqueKey":"tax.oneOf.0.starter_details.oneOf.1.epm6","typeLabel":"boolean"},"stay":{"oneOf":[{"type":"string","title":"SecondedStay","description":"How long the employee intends to stay; null when not known, which needs epm6 and a declaration","enum":["STAY_183_DAYS_OR_MORE","STAY_LESS_THAN_183_DAYS","IN_AND_OUT_OF_UK"],"isRequired":true,"uniqueKey":"tax.oneOf.0.starter_details.oneOf.1.stay.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","description":"How long the employee intends to stay; null when not known, which needs epm6 and a declaration","isRequired":true,"uniqueKey":"tax.oneOf.0.starter_details.oneOf.1.stay.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"tax.oneOf.0.starter_details.oneOf.1.stay","typeLabel":"enum\u003cstring> | null"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"tax.oneOf.0.starter_details.oneOf.1","typeLabel":"StarterDetailsSeconded · object"},{"type":"object","title":"StarterDetailsExistingEmployment","description":"An employee already employed under this PAYE reference, moved from another\npayroll provider: HMRC already has the employment, so no starter block is filed.","required":["basis"],"properties":{"basis":{"const":"EXISTING_EMPLOYMENT","title":"Basis","type":"string","isRequired":true,"uniqueKey":"tax.oneOf.0.starter_details.oneOf.2.basis","typeLabel":"string"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"tax.oneOf.0.starter_details.oneOf.2","typeLabel":"StarterDetailsExistingEmployment · object"}],"isRequired":true,"uniqueKey":"tax.oneOf.0.starter_details","typeLabel":"StarterDetailsDeclaration · object | StarterDetailsSeconded · object | StarterDetailsExistingEmployment · object"},"valid_from":{"format":"date","title":"Valid From","type":"string","isRequired":true,"uniqueKey":"tax.oneOf.0.valid_from","typeLabel":"string\u003cdate>"},"valid_to":{"format":"date","title":"Valid To","type":"string","isRequired":true,"uniqueKey":"tax.oneOf.0.valid_to","typeLabel":"string\u003cdate>"},"p45_gross_pay":{"oneOf":[{"type":"string","title":"P45 Gross Pay","description":"P45 gross pay","default":"0.00","uniqueKey":"tax.oneOf.0.p45_gross_pay.oneOf.0","typeLabel":"string"},{"type":"null","title":"P45 Gross Pay","description":"P45 gross pay","default":"0.00","uniqueKey":"tax.oneOf.0.p45_gross_pay.oneOf.1","typeLabel":"null"}],"uniqueKey":"tax.oneOf.0.p45_gross_pay","typeLabel":"string | null"},"p45_tax_amount":{"oneOf":[{"type":"string","title":"P45 Tax Amount","description":"P45 tax amount","default":"0.00","uniqueKey":"tax.oneOf.0.p45_tax_amount.oneOf.0","typeLabel":"string"},{"type":"null","title":"P45 Tax Amount","description":"P45 tax amount","default":"0.00","uniqueKey":"tax.oneOf.0.p45_tax_amount.oneOf.1","typeLabel":"null"}],"uniqueKey":"tax.oneOf.0.p45_tax_amount","typeLabel":"string | null"},"postgraduate_loan":{"default":false,"description":"Postgraduate loan?","title":"Postgraduate Loan","type":"boolean","uniqueKey":"tax.oneOf.0.postgraduate_loan","typeLabel":"boolean"},"rti_id":{"oneOf":[{"type":"string","title":"Rti Id","description":"RTI Payroll ID","uniqueKey":"tax.oneOf.0.rti_id.oneOf.0","typeLabel":"string"},{"type":"null","title":"Rti Id","description":"RTI Payroll ID","uniqueKey":"tax.oneOf.0.rti_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"tax.oneOf.0.rti_id","typeLabel":"string | null"},"student_loan_type":{"oneOf":[{"type":"string","title":"StudentLoanPlanType","description":"Student loan type","enum":["PLAN_1","PLAN_2","PLAN_4","PLAN_5"],"uniqueKey":"tax.oneOf.0.student_loan_type.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","description":"Student loan type","uniqueKey":"tax.oneOf.0.student_loan_type.oneOf.1","typeLabel":"null"}],"uniqueKey":"tax.oneOf.0.student_loan_type","typeLabel":"enum\u003cstring> | null"},"tax_code":{"oneOf":[{"type":"string","uniqueKey":"tax.oneOf.0.tax_code.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"tax.oneOf.0.tax_code.oneOf.1","typeLabel":"null"}],"uniqueKey":"tax.oneOf.0.tax_code","typeLabel":"string | null"}},"additionalProperties":false,"uniqueKey":"tax.oneOf.0","typeLabel":"GBEmployeeTaxSatellite · object"},{"type":"null","uniqueKey":"tax.oneOf.1","typeLabel":"null"}],"uniqueKey":"tax","typeLabel":"GBEmployeeTaxSatellite · object | null"}},"required":["id","external_ref","created_at","created_by","deleted_at","organization_id","status"],"title":"GBEmployeeResponse","type":"object","uniqueKey":"","typeLabel":"GBEmployeeResponse · object"},"examples":{"Example":{"title":"Example","value":{"created_at":"2023-11-07T05:31:56Z","created_by":"\u003cstring>","deleted_at":"2023-11-07T05:31:56Z","external_ref":"\u003cstring>","id":"\u003cstring>","organization_id":"\u003cstring>","status":{},"address":{"created_at":"2023-11-07T05:31:56Z","created_by":"\u003cstring>","edition":123,"valid_from":"2023-12-25","valid_to":"2023-12-25","address_line_1":"\u003cstring>","address_line_2":"\u003cstring>","address_line_3":"\u003cstring>","address_line_4":"\u003cstring>","country":"\u003cstring>","county":"\u003cstring>","postcode":"\u003cstring>","town":"\u003cstring>"},"bank":{"created_at":"2023-11-07T05:31:56Z","created_by":"\u003cstring>","edition":123,"valid_from":"2023-12-25","valid_to":"2023-12-25","accounts":[{"account_number":"\u003cstring>","allocation_percentage":"\u003cstring>","financial_institution_name":"\u003cstring>","is_active":true,"is_primary":false,"sort_code":"\u003cstring>"}]},"compensation":{"created_at":"2023-11-07T05:31:56Z","created_by":"\u003cstring>","edition":123,"valid_from":"2023-12-25","valid_to":"2023-12-25","benefits":[{"wage_type_code":"\u003cstring>","amount":"0.00","cash_alternative_amount":"0.00","external_ref":"\u003cstring>","foregone_amount":"0.00","make_good_amount":"0.00"}],"deductions":[{"amount":"\u003cstring>","wage_type_code":"\u003cstring>","external_ref":"\u003cstring>","sacrificed_amount":"\u003cstring>"}],"earnings":[{"amount":"\u003cstring>","wage_type_code":"\u003cstring>","earning_frequency":"MONTH","earning_type":"AMOUNT","external_ref":"\u003cstring>","is_lumpsum":false,"sacrificed_amount":"\u003cstring>"}],"reimbursements":[{"amount":"\u003cstring>","wage_type_code":"\u003cstring>","external_ref":"\u003cstring>"}]},"core":{"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"},"insurance":{"created_at":"2023-11-07T05:31:56Z","created_by":"\u003cstring>","edition":123,"valid_from":"2023-12-25","valid_to":"2023-12-25","national_insurance_number":"\u003cstring>","nic_category":"A","overseas_national_awaiting_nino":true},"job":{"created_at":"2023-11-07T05:31:56Z","created_by":"\u003cstring>","edition":123,"valid_from":"2023-12-25","valid_to":"2023-12-25","apprenticeship":{"expected_end_date":"2023-12-25","level":4,"start_date":"2023-12-25"},"contracted_weekdays":["MONDAY"],"contracted_weekly_hours":40,"department":"\u003cstring>","director_since":"2023-12-25","end_date":"2023-12-25","engagement_type":"EMPLOYEE","irregular_payment_pattern":false,"ordinarily_works_in_uk":true,"p45_issued":false,"pay_basis":"SALARIED","pay_group_id":"\u003cstring>","proration_basis":{"mode":"CALENDAR_DAY","business_days_per_year":"\u003cstring>"},"start_date":"2023-12-25","uk_work_exclusion_reason":"NOT_APPLICABLE","worker_type":"EMPLOYEE","workplace_postcode":"\u003cstring>"},"tax":{"created_at":"2023-11-07T05:31:56Z","created_by":"\u003cstring>","edition":123,"starter_details":{"basis":"DECLARATION","declaration":"A"},"valid_from":"2023-12-25","valid_to":"2023-12-25","p45_gross_pay":"0.00","p45_tax_amount":"0.00","postgraduate_loan":false,"rti_id":"\u003cstring>","student_loan_type":"PLAN_1","tax_code":"\u003cstring>"}}}},"exampleType":"generated"}},"description":"Successful Response","exampleType":"generated"},"31c8bec5-edf3-472c-b003-d40992fc66be":{"content":{"application/json":{"examples":{"ONE_OR_MORE_PAY_GROUP_NOT_FOUND":{"title":"ONE_OR_MORE_PAY_GROUP_NOT_FOUND","summary":"Raised when one or more pay groups are not found.","value":{"errors":[{"code":"ONE_OR_MORE_PAY_GROUP_NOT_FOUND","message":"Raised when one or more pay groups are not found."}]}},"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."}]}},"PAY_GROUP_IS_IN_RUNNING_PAYROLL":{"title":"PAY_GROUP_IS_IN_RUNNING_PAYROLL","summary":"Raised when a pay group is in a running payroll.","value":{"errors":[{"code":"PAY_GROUP_IS_IN_RUNNING_PAYROLL","message":"Raised when a pay group is in a running payroll."}]}},"SACRIFICE_NOT_ALLOWED":{"title":"SACRIFICE_NOT_ALLOWED","summary":"Raised when a line declares a sacrifice on a wage type whose is_salary_sacrifice_allowed is false.","value":{"errors":[{"code":"SACRIFICE_NOT_ALLOWED","message":"Raised when a line declares a sacrifice on a wage type whose is_salary_sacrifice_allowed is false."}]}}},"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","ONE_OR_MORE_PAY_GROUP_NOT_FOUND","PAY_GROUP_IS_IN_RUNNING_PAYROLL","SACRIFICE_NOT_ALLOWED"],"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.\n- `ONE_OR_MORE_PAY_GROUP_NOT_FOUND`: Raised when one or more pay groups are not found.\n- `PAY_GROUP_IS_IN_RUNNING_PAYROLL`: Raised when a pay group is in a running payroll.\n- `SACRIFICE_NOT_ALLOWED`: Raised when a line declares a sacrifice on a wage type whose is_salary_sacrifice_allowed is false.","exampleType":"examples"},"d9f87012-cc09-4c70-aeda-89fea6981d57":{"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."}]}},"WAGE_TYPE_NOT_FOUND":{"title":"WAGE_TYPE_NOT_FOUND","summary":"Raised when a wage type is not found.","value":{"errors":[{"code":"WAGE_TYPE_NOT_FOUND","message":"Raised when a wage type is not found."}]}}},"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","WAGE_TYPE_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- `WAGE_TYPE_NOT_FOUND`: Raised when a wage type is not found.","exampleType":"examples"},"f63c5b86-5fd3-43eb-928f-e4e488f9bd41":{"content":{"application/json":{"examples":{"GB_RTI_ID_DUPLICATE":{"title":"GB_RTI_ID_DUPLICATE","summary":"Raised when an RTI Payroll ID is already assigned to another employee in the organization.","value":{"errors":[{"code":"GB_RTI_ID_DUPLICATE","message":"Raised when an RTI Payroll ID is already assigned to another employee in the organization."}]}},"HUB_CLOSED":{"title":"HUB_CLOSED","summary":"Raised on a write to a closed hub: it stays readable, its satellites take no writes.","value":{"errors":[{"code":"HUB_CLOSED","message":"Raised on a write to a closed hub: it stays readable, its satellites take no writes."}]}},"HUB_DUPLICATE_EXTERNAL_REF":{"title":"HUB_DUPLICATE_EXTERNAL_REF","summary":"Raised when the parent already has a hub with this external_ref.","value":{"errors":[{"code":"HUB_DUPLICATE_EXTERNAL_REF","message":"Raised when the parent already has a hub with this external_ref."}]}}},"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_DUPLICATE_EXTERNAL_REF","HUB_CLOSED","GB_RTI_ID_DUPLICATE"],"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_DUPLICATE_EXTERNAL_REF`: Raised when the parent already has a hub with this external_ref.\n- `HUB_CLOSED`: Raised on a write to a closed hub: it stays readable, its satellites take no writes.\n- `GB_RTI_ID_DUPLICATE`: Raised when an RTI Payroll ID is already assigned to another employee in the organization.","exampleType":"examples"},"ba1e03ba-1a12-4994-9281-04955350c096":{"content":{"application/json":{"examples":{"GB_STARTER_EXISTING_EMPLOYMENT_RTI_ID_MISSING":{"title":"GB_STARTER_EXISTING_EMPLOYMENT_RTI_ID_MISSING","summary":"An employment taken over from another payroll provider has no payroll ID to keep.","value":{"errors":[{"code":"GB_STARTER_EXISTING_EMPLOYMENT_RTI_ID_MISSING","message":"An employment taken over from another payroll provider has no payroll ID to keep."}]}}},"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":["GB_STARTER_EXISTING_EMPLOYMENT_RTI_ID_MISSING","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- `GB_STARTER_EXISTING_EMPLOYMENT_RTI_ID_MISSING`: An employment taken over from another payroll provider has no payroll ID to keep.","exampleType":"examples"}},"security":{"66b3ff6d-9c33-4dbf-b8d8-5244c035f4c7":{"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":"Create Employee - Intermezzo Docs","navMaps":{"firstHrefInVersion":{"Preview":{"href":"/api-reference/preview/great-britain/create-employee","matchLevel":0}},"firstHrefInLanguage":{}},"lastModified":"2026-11-18T18:11:00.846Z","originalFileLocation":"api-reference/preview/great-britain/create-employee.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=\"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=\"Create Employee - Intermezzo Docs\">\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/create-employee\">\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=Employees\u0026amp;title=Create+Employee\u0026amp;theme=2cc41bc2d4d72760d1901e1b\u0026amp;signature=b2507db1395cfd8c4933d9bc6642067258031efd13f41352219e0e45c77cb57a\">\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=\"Create Employee - Intermezzo Docs\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://intermezzo.mintlify.site/_mintlify/api/og/v2?division=Employees\u0026amp;title=Create+Employee\u0026amp;theme=2cc41bc2d4d72760d1901e1b\u0026amp;signature=b2507db1395cfd8c4933d9bc6642067258031efd13f41352219e0e45c77cb57a\">\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/create-employee\">\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/create-employee.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/create-employee#webpage\",\"url\":\"https://docs.intermezzo.ai/api-reference/preview/great-britain/create-employee\",\"name\":\"Create Employee\",\"dateModified\":\"2026-11-18T18:11:00.846Z\",\"isPartOf\":{\"@id\":\"https://docs.intermezzo.ai#website\"},\"breadcrumb\":{\"@id\":\"https://docs.intermezzo.ai/api-reference/preview/great-britain/create-employee#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.intermezzo.ai/api-reference/preview/great-britain/create-employee#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\":\"Create Employee\",\"item\":\"https://docs.intermezzo.ai/api-reference/preview/great-britain/create-employee\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.intermezzo.ai/api-reference/preview/great-britain/create-employee#apireference\",\"headline\":\"Create Employee\",\"name\":\"Create Employee\",\"url\":\"https://docs.intermezzo.ai/api-reference/preview/great-britain/create-employee\",\"mainEntityOfPage\":{\"@id\":\"https://docs.intermezzo.ai/api-reference/preview/great-britain/create-employee#webpage\"},\"dateModified\":\"2026-11-18T18:11:00.846Z\",\"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/create-employee.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","description":"Each item is a summary: the employee hub with its `core`, `job`, `tax` satellites. Get one by id for every satellite.","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","description":"Each item is validated and created on its own: an item that fails is reported in `errors` with its index, and the others are still created. The response is `200` however many items fail. Item errors carry the validation codes of the single create, with `field` relative to the item, and its codes: `HUB_DUPLICATE_EXTERNAL_REF`, `HUB_CLOSED`, `GB_RTI_ID_DUPLICATE`, `ONE_OR_MORE_PAY_GROUP_NOT_FOUND`, `PAY_GROUP_IS_IN_RUNNING_PAYROLL`, `WAGE_TYPE_NOT_FOUND`, `SACRIFICE_NOT_ALLOWED`, `GB_STARTER_EXISTING_EMPLOYMENT_RTI_ID_MISSING`. A body that is not an array, is empty or holds more than 100 items is rejected with `422` and nothing is created.","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","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","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":"Create Employee - Intermezzo Docs","deploymentId":"dpl_DyXGnKeCjZyA3sUdfMJ7FjkdBefg","buildId":"dpl_DyXGnKeCjZyA3sUdfMJ7FjkdBefg","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-CiUHMMOm.js","snippetPresets-BgfXU7Bw.js","utils-DWvOwgy_.js","style-to-object-BY3JEAdk.js","utils-BN7RXSMJ.js","v4-DIgz8zy6.js","addUniqueKeysToSchema-CFw8bq89.js","conditional-requirements-CFM0id0Q.js","cloneDeep-CAwdfOU2.js","_Uint8Array-BJr8e-ZL.js","isObject-FP1Yky1u.js","ApiExamples-XX0UgMZK.js","usePlaygroundInputsStore-DXDFSa1V.js","shallow-CdX5aREi.js","isEqual-CoOaxexF.js","CodeSnippets-Cg2wpzWm.js","CodeSnippet-D_HwgQO_.js","getApiPlaygroundDisplay-CmCoerhe.js","Page-CVJ-f_k1.js","DynamicMarkdown-CQM9Bhbv.js","SectionHeading-DpbrP8nQ.js","icon-BPCgijHy.js","MethodPill-GQ8DuY0c.js","getPastedJson-Cb5mT31m.js","Check2Icon-a7bUI6e8.js","axios-CsQoIw0U.js","Markdown-CX2QY19L.js","AssistantPageLink-CY3bFglh.js","dist-Dl6_zDnT.js","lib-DMeTj1gb.js","lib-B8HbPgcC.js","katex-Dbtb6Wk7.js","html-void-elements-mCSPHezU.js","marked.esm-CZWythHk.js"]}