Add pay items to a DRAFT pay run, of any type, for employees of its pay group.
An employee needs no other pay items in the run or the period. Lines are validated as
on submit and keyed by wage type code and external_ref: a line with a key the
employee already has in the run replaces it, any other line is added. The employees’
payslips in the run are deleted, so calculate the run again before approving it.
A run that is not DRAFT, one being calculated included, is refused with 409
INVALID_TRANSITION (params.reasonNOT_DRAFT, params.from its status). An
employee outside the pay group, or a wage type missing from the catalog, is refused
with 422
INVALID_REFERENCE (params.reasonOTHER_PARENT or NOT_FOUND); a wage type the
engine calculates is refused with 422 GB_WAGE_TYPE_NOT_AN_INPUT. field names the
entry or line in the request, e.g. payroll_group[0].pay_details.earnings[1].wage_type_code.
Refused (409) for an employee whose payslip in the run was calculated with prior-period
NI-able earnings supplied through submit: deleting it would drop them. Submit that
employee’s items with the prior-period NI-able earnings instead.
Pay items to add to a draft pay run, per employee.
payroll_group
PayItemAddEntry · object[]
required
Each line is keyed by its wage type code and external_ref, as on submit: a line whose key the employee already has in the run replaces that line, any other line is added. A line without external_ref is the wage type's single keyless line.
Minimum array length: 1
Show child attributes
Response
Successful Response
added_employee_ids
string[]
required
The employees given pay items, once each in request order. Their payslips in the run are deleted: calculate the run again before approving it.
Was this page helpful?
{"docsConfig":{"theme":"palm","$schema":"https://mintlify.com/docs.json","name":"Intermezzo Docs","colors":{"primary":"#73f","light":"#a67cf0","dark":"#73f"},"logo":{"light":"https://mintcdn.com/intermezzo/XOEFYK36Q6eJv_R4/logo/intermezzo_light.svg?fit=max\u0026auto=format\u0026n=XOEFYK36Q6eJv_R4\u0026q=85\u0026s=4b9e8941df9647de37ca603f7ca47f49","dark":"https://mintcdn.com/intermezzo/sciYsehRUBwL7M2i/logo/intermezzo_dark.svg?fit=max\u0026auto=format\u0026n=sciYsehRUBwL7M2i\u0026q=85\u0026s=5bed853d508d4d8bae6691ed85740729","href":"https://intermezzo.ai"},"favicon":"https://mintcdn.com/intermezzo/XOEFYK36Q6eJv_R4/favicon.png?fit=max\u0026auto=format\u0026n=XOEFYK36Q6eJv_R4\u0026q=85\u0026s=5970f25bec25b022614415fec2a93940","api":{"examples":{"defaults":"required","prefill":true}},"appearance":{"default":"light","strict":true},"navbar":{"links":[{"href":"mailto:support@intermezzo.ai","label":"Support"}]},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"intermezzo","hasAudioNarration":false,"actualSubdomain":"intermezzo","customDomains":["docs.intermezzo.ai"],"gitSource":{"type":"github","owner":"intermezzo-ai","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"feedback":{"thumbs":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6afdea29c82885eda0b9aea7","clientVersion":"0.0.4205","searchFilterCounts":[{"language":"default","tag":"API Reference","count":227},{"language":"default","tag":"Great Britain","count":204},{"language":"default","tag":"Employees","count":52},{"language":"default","tag":"Core","count":43},{"language":"default","tag":"Organizations","count":33},{"language":"default","tag":"Wage Types","count":26},{"language":"default","tag":"Pension","count":25},{"language":"default","tag":"Payroll","count":23},{"language":"default","tag":"Reports","count":22},{"language":"default","tag":"Guides","count":15}]},"assistantConfig":{},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"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":"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/add-pay-items","slug":"/api-reference/preview/great-britain/add-pay-items","pageMetadata":{"title":"Add Pay Items","description":"Add pay items to a DRAFT pay run, of any type, for employees of its pay group.\n\nAn employee needs no other pay items in the run or the period. Lines are validated as\non submit and keyed by wage type code and `external_ref`: a line with a key the\nemployee already has in the run replaces it, any other line is added. The employees'\npayslips in the run are deleted, so calculate the run again before approving it.\n\nA run that is not DRAFT, one being calculated included, is refused with 409\n`INVALID_TRANSITION` (`params.reason` `NOT_DRAFT`, `params.from` its status). An\nemployee outside the pay group, or a wage type missing from the catalog, is refused\nwith 422\n`INVALID_REFERENCE` (`params.reason` `OTHER_PARENT` or `NOT_FOUND`); a wage type the\nengine calculates is refused with 422 `GB_WAGE_TYPE_NOT_AN_INPUT`. `field` names the\nentry or line in the request, e.g. `payroll_group[0].pay_details.earnings[1].wage_type_code`.\n\nRefused (409) for an employee whose payslip in the run was calculated with prior-period\nNI-able earnings supplied through submit: deleting it would drop them. Submit that\nemployee's items with the prior-period NI-able earnings instead.","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","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {Fragment: _Fragment, jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_Fragment, {\n children: [_jsx(_components.p, {\n children: \"Add pay items to a DRAFT pay run, of any type, for employees of its pay group.\"\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"An employee needs no other pay items in the run or the period. Lines are validated as\\non submit and keyed by wage type code and \", _jsx(_components.code, {\n children: \"external_ref\"\n }), \": a line with a key the\\nemployee already has in the run replaces it, any other line is added. The employees’\\npayslips in the run are deleted, so calculate the run again before approving it.\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"A run that is not DRAFT, one being calculated included, is refused with 409\\n\", _jsx(_components.code, {\n children: \"INVALID_TRANSITION\"\n }), \" (\", _jsx(_components.code, {\n children: \"params.reason\"\n }), \" \", _jsx(_components.code, {\n children: \"NOT_DRAFT\"\n }), \", \", _jsx(_components.code, {\n children: \"params.from\"\n }), \" its status). An\\nemployee outside the pay group, or a wage type missing from the catalog, is refused\\nwith 422\\n\", _jsx(_components.code, {\n children: \"INVALID_REFERENCE\"\n }), \" (\", _jsx(_components.code, {\n children: \"params.reason\"\n }), \" \", _jsx(_components.code, {\n children: \"OTHER_PARENT\"\n }), \" or \", _jsx(_components.code, {\n children: \"NOT_FOUND\"\n }), \"); a wage type the\\nengine calculates is refused with 422 \", _jsx(_components.code, {\n children: \"GB_WAGE_TYPE_NOT_AN_INPUT\"\n }), \". \", _jsx(_components.code, {\n children: \"field\"\n }), \" names the\\nentry or line in the request, e.g. \", _jsx(_components.code, {\n children: \"payroll_group[0].pay_details.earnings[1].wage_type_code\"\n }), \".\"]\n }), \"\\n\", _jsx(_components.p, {\n children: \"Refused (409) for an employee whose payslip in the run was calculated with prior-period\\nNI-able earnings supplied through submit: deleting it would drop them. Submit that\\nemployee’s items with the prior-period NI-able earnings instead.\"\n })]\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Add Pay Items","description":"Add pay items to a DRAFT pay run, of any type, for employees of its pay group.\n\nAn employee needs no other pay items in the run or the period. Lines are validated as\non submit and keyed by wage type code and `external_ref`: a line with a key the\nemployee already has in the run replaces it, any other line is added. The employees'\npayslips in the run are deleted, so calculate the run again before approving it.\n\nA run that is not DRAFT, one being calculated included, is refused with 409\n`INVALID_TRANSITION` (`params.reason` `NOT_DRAFT`, `params.from` its status). An\nemployee outside the pay group, or a wage type missing from the catalog, is refused\nwith 422\n`INVALID_REFERENCE` (`params.reason` `OTHER_PARENT` or `NOT_FOUND`); a wage type the\nengine calculates is refused with 422 `GB_WAGE_TYPE_NOT_AN_INPUT`. `field` names the\nentry or line in the request, e.g. `payroll_group[0].pay_details.earnings[1].wage_type_code`.\n\nRefused (409) for an employee whose payslip in the run was calculated with prior-period\nNI-able earnings supplied through submit: deleting it would drop them. Submit that\nemployee's items with the prior-period NI-able earnings instead.","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","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"description":"Add pay items to a DRAFT pay run, of any type, for employees of its pay group.\n\nAn employee needs no other pay items in the run or the period. Lines are validated as\non submit and keyed by wage type code and `external_ref`: a line with a key the\nemployee already has in the run replaces it, any other line is added. The employees'\npayslips in the run are deleted, so calculate the run again before approving it.\n\nA run that is not DRAFT, one being calculated included, is refused with 409\n`INVALID_TRANSITION` (`params.reason` `NOT_DRAFT`, `params.from` its status). An\nemployee outside the pay group, or a wage type missing from the catalog, is refused\nwith 422\n`INVALID_REFERENCE` (`params.reason` `OTHER_PARENT` or `NOT_FOUND`); a wage type the\nengine calculates is refused with 422 `GB_WAGE_TYPE_NOT_AN_INPUT`. `field` names the\nentry or line in the request, e.g. `payroll_group[0].pay_details.earnings[1].wage_type_code`.\n\nRefused (409) for an employee whose payslip in the run was calculated with prior-period\nNI-able earnings supplied through submit: deleting it would drop them. Submit that\nemployee's items with the prior-period NI-able earnings instead.","operationId":"add_pay_items_gb_organizations__organization_id__payruns__payrun_id__pay_items_post","parameters":["1866839c-956b-41e0-b009-c2734d892e07","03d51981-84e4-4611-8aba-832936fa08bd"],"requestBody":"f67a7b83-a0c0-4626-bb72-c89344858d04","responses":{"200":"35c3156d-2143-4e60-9cd5-227d5c64c36a","400":"546f49cc-3079-46fc-88be-097a69c41dfa","404":"a2a7dc80-f1c4-418f-8803-2ad91003ce65","409":"950d7347-5327-48db-ba62-5230fa6dae62","422":"d522eb16-00c9-4fe3-a09d-71139dd38efe"},"security":["8d4e8409-cb7d-429f-b3ae-566e5a41c696"],"summary":"Add Pay Items","tags":["Great Britain","Pay Items"],"method":"post","type":"path","servers":["0a0251d4-b9ef-4650-8cdc-c27a2b5fe346"],"path":"/gb/organizations/{organization_id}/payruns/{payrun_id}/pay-items","baseUrlOptions":["https://preview.intermezzo.ai"],"title":"Add Pay Items","codeSamples":[],"requiredOnlyExamples":true,"requestExampleType":"generated","responseExampleType":"generated","prefillPlaygroundWithExample":true,"prefillPlaygroundExamples":[{"body.payroll_group.items.0.employee_id":"\u003cstring>","body.payroll_group.items.0.pay_details.benefits.oneOf.0.items.0.wage_type_code":"\u003cstring>","body.payroll_group.items.0.pay_details.benefits.oneOf.0.items.0.amount.oneOf.1":"0.00","body.payroll_group.items.0.pay_details.benefits.oneOf.0.items.0.cash_alternative_amount.oneOf.1":"0.00","body.payroll_group.items.0.pay_details.benefits.oneOf.0.items.0.external_ref.oneOf.0":"\u003cstring>","body.payroll_group.items.0.pay_details.benefits.oneOf.0.items.0.foregone_amount.oneOf.1":"0.00","body.payroll_group.items.0.pay_details.benefits.oneOf.0.items.0.make_good_amount.oneOf.1":"0.00","body.payroll_group.items.0.pay_details.earnings.oneOf.0.items.0.oneOf.0.amount.oneOf.0":123,"body.payroll_group.items.0.pay_details.earnings.oneOf.0.items.0.oneOf.0.wage_type_code":"\u003cstring>","body.payroll_group.items.0.pay_details.earnings.oneOf.0.items.0.oneOf.0.earning_frequency.oneOf.0":"MONTH","body.payroll_group.items.0.pay_details.earnings.oneOf.0.items.0.oneOf.0.earning_type":"AMOUNT","body.payroll_group.items.0.pay_details.earnings.oneOf.0.items.0.oneOf.0.external_ref.oneOf.0":"\u003cstring>","body.payroll_group.items.0.pay_details.earnings.oneOf.0.items.0.oneOf.0.is_lumpsum":false,"body.payroll_group.items.0.pay_details.earnings.oneOf.0.items.0.oneOf.0.sacrificed_amount.oneOf.0":1,"body.payroll_group.items.0.pay_details.deductions.oneOf.0.items.0.amount.oneOf.0":1,"body.payroll_group.items.0.pay_details.deductions.oneOf.0.items.0.wage_type_code":"\u003cstring>","body.payroll_group.items.0.pay_details.deductions.oneOf.0.items.0.external_ref.oneOf.0":"\u003cstring>","body.payroll_group.items.0.pay_details.deductions.oneOf.0.items.0.sacrificed_amount.oneOf.0":1,"body.payroll_group.items.0.pay_details.reimbursements.oneOf.0.items.0.amount.oneOf.0":1,"body.payroll_group.items.0.pay_details.reimbursements.oneOf.0.items.0.wage_type_code":"\u003cstring>","body.payroll_group.items.0.pay_details.reimbursements.oneOf.0.items.0.external_ref.oneOf.0":"\u003cstring>"}]},"dependencies":{"parameters":{"1866839c-956b-41e0-b009-c2734d892e07":{"in":"path","name":"organization_id","required":true,"schema":{"title":"Organization Id","type":"string","isRequired":true,"uniqueKey":"","typeLabel":"string"}},"03d51981-84e4-4611-8aba-832936fa08bd":{"in":"path","name":"payrun_id","required":true,"schema":{"title":"Payrun Id","type":"string","isRequired":true,"uniqueKey":"","typeLabel":"string"}}},"requestBody":{"content":{"application/json":{"schema":{"additionalProperties":false,"description":"Pay items to add to a draft pay run, per employee.","properties":{"payroll_group":{"description":"Each line is keyed by its wage type code and `external_ref`, as on submit: a line whose key the employee already has in the run replaces that line, any other line is added. A line without `external_ref` is the wage type's single keyless line.","items":{"additionalProperties":false,"description":"One employee's pay items, in submit's line schema.","properties":{"employee_id":{"title":"Employee Id","type":"string","isRequired":true,"uniqueKey":"payroll_group.items.[INDEX].employee_id","typeLabel":"string"},"pay_details":{"additionalProperties":false,"properties":{"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":"payroll_group.items.[INDEX].pay_details.benefits.oneOf.0.items.[INDEX].wage_type_code","typeLabel":"string"},"amount":{"oneOf":[{"type":"number","title":"Amount","description":"Amount of benefit","default":"0.00","minimum":0,"uniqueKey":"payroll_group.items.[INDEX].pay_details.benefits.oneOf.0.items.[INDEX].amount.oneOf.0","typeLabel":"number"},{"type":"string","title":"Amount","description":"Amount of benefit","default":"0.00","uniqueKey":"payroll_group.items.[INDEX].pay_details.benefits.oneOf.0.items.[INDEX].amount.oneOf.1","typeLabel":"string"},{"type":"null","title":"Amount","description":"Amount of benefit","default":"0.00","uniqueKey":"payroll_group.items.[INDEX].pay_details.benefits.oneOf.0.items.[INDEX].amount.oneOf.2","typeLabel":"null"}],"uniqueKey":"payroll_group.items.[INDEX].pay_details.benefits.oneOf.0.items.[INDEX].amount","typeLabel":"number | string | null"},"cash_alternative_amount":{"oneOf":[{"type":"number","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","minimum":0,"uniqueKey":"payroll_group.items.[INDEX].pay_details.benefits.oneOf.0.items.[INDEX].cash_alternative_amount.oneOf.0","typeLabel":"number"},{"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":"payroll_group.items.[INDEX].pay_details.benefits.oneOf.0.items.[INDEX].cash_alternative_amount.oneOf.1","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":"payroll_group.items.[INDEX].pay_details.benefits.oneOf.0.items.[INDEX].cash_alternative_amount.oneOf.2","typeLabel":"null"}],"uniqueKey":"payroll_group.items.[INDEX].pay_details.benefits.oneOf.0.items.[INDEX].cash_alternative_amount","typeLabel":"number | 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":"payroll_group.items.[INDEX].pay_details.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":"payroll_group.items.[INDEX].pay_details.benefits.oneOf.0.items.[INDEX].external_ref.oneOf.1","typeLabel":"null"}],"uniqueKey":"payroll_group.items.[INDEX].pay_details.benefits.oneOf.0.items.[INDEX].external_ref","typeLabel":"string | null"},"foregone_amount":{"oneOf":[{"type":"number","title":"Foregone Amount","description":"If subject to OpRa, amount foregone","default":"0.00","minimum":0,"uniqueKey":"payroll_group.items.[INDEX].pay_details.benefits.oneOf.0.items.[INDEX].foregone_amount.oneOf.0","typeLabel":"number"},{"type":"string","title":"Foregone Amount","description":"If subject to OpRa, amount foregone","default":"0.00","uniqueKey":"payroll_group.items.[INDEX].pay_details.benefits.oneOf.0.items.[INDEX].foregone_amount.oneOf.1","typeLabel":"string"},{"type":"null","title":"Foregone Amount","description":"If subject to OpRa, amount foregone","default":"0.00","uniqueKey":"payroll_group.items.[INDEX].pay_details.benefits.oneOf.0.items.[INDEX].foregone_amount.oneOf.2","typeLabel":"null"}],"uniqueKey":"payroll_group.items.[INDEX].pay_details.benefits.oneOf.0.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","default":"0.00","minimum":0,"uniqueKey":"payroll_group.items.[INDEX].pay_details.benefits.oneOf.0.items.[INDEX].make_good_amount.oneOf.0","typeLabel":"number"},{"type":"string","title":"Make Good Amount","description":"Amount paid by employee for the benefit","default":"0.00","uniqueKey":"payroll_group.items.[INDEX].pay_details.benefits.oneOf.0.items.[INDEX].make_good_amount.oneOf.1","typeLabel":"string"},{"type":"null","title":"Make Good Amount","description":"Amount paid by employee for the benefit","default":"0.00","uniqueKey":"payroll_group.items.[INDEX].pay_details.benefits.oneOf.0.items.[INDEX].make_good_amount.oneOf.2","typeLabel":"null"}],"uniqueKey":"payroll_group.items.[INDEX].pay_details.benefits.oneOf.0.items.[INDEX].make_good_amount","typeLabel":"number | string | null"}},"required":["wage_type_code"],"title":"Benefits","type":"object","uniqueKey":"payroll_group.items.[INDEX].pay_details.benefits.oneOf.0.items.[INDEX]","typeLabel":"Benefits · object"},"title":"Benefits","isRequired":true,"uniqueKey":"payroll_group.items.[INDEX].pay_details.benefits.oneOf.0","typeLabel":"Benefits · object[]"},{"type":"null","title":"Benefits","isRequired":true,"uniqueKey":"payroll_group.items.[INDEX].pay_details.benefits.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"payroll_group.items.[INDEX].pay_details.benefits","typeLabel":"Benefits · object[] | null"},"earnings":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"object","title":"AmountEarnings","description":"Fixed-amount earnings (salary, bonus, allowance). Amount + frequency.","required":["wage_type_code","amount"],"properties":{"amount":{"oneOf":[{"type":"number","title":"Amount","description":"Earnings amount (negative values represent period adjustments, e.g. leave reductions)","isRequired":true,"uniqueKey":"payroll_group.items.[INDEX].pay_details.earnings.oneOf.0.items.[INDEX].oneOf.0.amount.oneOf.0","typeLabel":"number"},{"type":"string","title":"Amount","description":"Earnings amount (negative values represent period adjustments, e.g. leave reductions)","isRequired":true,"uniqueKey":"payroll_group.items.[INDEX].pay_details.earnings.oneOf.0.items.[INDEX].oneOf.0.amount.oneOf.1","typeLabel":"string"}],"isRequired":true,"uniqueKey":"payroll_group.items.[INDEX].pay_details.earnings.oneOf.0.items.[INDEX].oneOf.0.amount","typeLabel":"number | string"},"wage_type_code":{"description":"Wage type code from catalog (e.g. UK-E-001)","title":"Wage Type Code","type":"string","isRequired":true,"uniqueKey":"payroll_group.items.[INDEX].pay_details.earnings.oneOf.0.items.[INDEX].oneOf.0.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":"payroll_group.items.[INDEX].pay_details.earnings.oneOf.0.items.[INDEX].oneOf.0.earning_frequency.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","description":"If recurring, specify the frequency","default":"MONTH","uniqueKey":"payroll_group.items.[INDEX].pay_details.earnings.oneOf.0.items.[INDEX].oneOf.0.earning_frequency.oneOf.1","typeLabel":"null"}],"uniqueKey":"payroll_group.items.[INDEX].pay_details.earnings.oneOf.0.items.[INDEX].oneOf.0.earning_frequency","typeLabel":"enum\u003cstring> | null"},"earning_type":{"const":"AMOUNT","default":"AMOUNT","title":"Earning Type","type":"string","uniqueKey":"payroll_group.items.[INDEX].pay_details.earnings.oneOf.0.items.[INDEX].oneOf.0.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":"payroll_group.items.[INDEX].pay_details.earnings.oneOf.0.items.[INDEX].oneOf.0.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":"payroll_group.items.[INDEX].pay_details.earnings.oneOf.0.items.[INDEX].oneOf.0.external_ref.oneOf.1","typeLabel":"null"}],"uniqueKey":"payroll_group.items.[INDEX].pay_details.earnings.oneOf.0.items.[INDEX].oneOf.0.external_ref","typeLabel":"string | null"},"is_lumpsum":{"default":false,"description":"True if onetime. Defaults to False","title":"Is Lumpsum","type":"boolean","uniqueKey":"payroll_group.items.[INDEX].pay_details.earnings.oneOf.0.items.[INDEX].oneOf.0.is_lumpsum","typeLabel":"boolean"},"sacrificed_amount":{"oneOf":[{"type":"number","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","minimum":0,"uniqueKey":"payroll_group.items.[INDEX].pay_details.earnings.oneOf.0.items.[INDEX].oneOf.0.sacrificed_amount.oneOf.0","typeLabel":"number"},{"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":"payroll_group.items.[INDEX].pay_details.earnings.oneOf.0.items.[INDEX].oneOf.0.sacrificed_amount.oneOf.1","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":"payroll_group.items.[INDEX].pay_details.earnings.oneOf.0.items.[INDEX].oneOf.0.sacrificed_amount.oneOf.2","typeLabel":"null"}],"uniqueKey":"payroll_group.items.[INDEX].pay_details.earnings.oneOf.0.items.[INDEX].oneOf.0.sacrificed_amount","typeLabel":"number | string | null"}},"additionalProperties":false,"uniqueKey":"payroll_group.items.[INDEX].pay_details.earnings.oneOf.0.items.[INDEX].oneOf.0","typeLabel":"AmountEarnings · object"},{"type":"object","title":"HoursEarnings","description":"Hours-based earnings. Gross = hours_worked x hourly_rate.","required":["wage_type_code","hours_worked","hourly_rate"],"properties":{"hourly_rate":{"oneOf":[{"type":"number","title":"Hourly Rate","description":"Hourly rate","minimum":0,"isRequired":true,"uniqueKey":"payroll_group.items.[INDEX].pay_details.earnings.oneOf.0.items.[INDEX].oneOf.1.hourly_rate.oneOf.0","typeLabel":"number"},{"type":"string","title":"Hourly Rate","description":"Hourly rate","isRequired":true,"uniqueKey":"payroll_group.items.[INDEX].pay_details.earnings.oneOf.0.items.[INDEX].oneOf.1.hourly_rate.oneOf.1","typeLabel":"string"}],"isRequired":true,"uniqueKey":"payroll_group.items.[INDEX].pay_details.earnings.oneOf.0.items.[INDEX].oneOf.1.hourly_rate","typeLabel":"number | string"},"hours_worked":{"oneOf":[{"type":"number","title":"Hours Worked","description":"Number of hours worked","minimum":0,"isRequired":true,"uniqueKey":"payroll_group.items.[INDEX].pay_details.earnings.oneOf.0.items.[INDEX].oneOf.1.hours_worked.oneOf.0","typeLabel":"number"},{"type":"string","title":"Hours Worked","description":"Number of hours worked","isRequired":true,"uniqueKey":"payroll_group.items.[INDEX].pay_details.earnings.oneOf.0.items.[INDEX].oneOf.1.hours_worked.oneOf.1","typeLabel":"string"}],"isRequired":true,"uniqueKey":"payroll_group.items.[INDEX].pay_details.earnings.oneOf.0.items.[INDEX].oneOf.1.hours_worked","typeLabel":"number | string"},"wage_type_code":{"description":"Wage type code from catalog (e.g. UK-E-002)","title":"Wage Type Code","type":"string","isRequired":true,"uniqueKey":"payroll_group.items.[INDEX].pay_details.earnings.oneOf.0.items.[INDEX].oneOf.1.wage_type_code","typeLabel":"string"},"earning_type":{"const":"HOURS","default":"HOURS","title":"Earning Type","type":"string","uniqueKey":"payroll_group.items.[INDEX].pay_details.earnings.oneOf.0.items.[INDEX].oneOf.1.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":"payroll_group.items.[INDEX].pay_details.earnings.oneOf.0.items.[INDEX].oneOf.1.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":"payroll_group.items.[INDEX].pay_details.earnings.oneOf.0.items.[INDEX].oneOf.1.external_ref.oneOf.1","typeLabel":"null"}],"uniqueKey":"payroll_group.items.[INDEX].pay_details.earnings.oneOf.0.items.[INDEX].oneOf.1.external_ref","typeLabel":"string | null"},"is_lumpsum":{"default":false,"description":"True if onetime. Defaults to False","title":"Is Lumpsum","type":"boolean","uniqueKey":"payroll_group.items.[INDEX].pay_details.earnings.oneOf.0.items.[INDEX].oneOf.1.is_lumpsum","typeLabel":"boolean"},"sacrificed_amount":{"oneOf":[{"type":"number","title":"Sacrificed Amount","description":"Amount of this earning the employee has sacrificed (Type A OpRA). Pre-tax. Must be > 0 and \u003c= hours_worked x hourly_rate when set.","minimum":0,"uniqueKey":"payroll_group.items.[INDEX].pay_details.earnings.oneOf.0.items.[INDEX].oneOf.1.sacrificed_amount.oneOf.0","typeLabel":"number"},{"type":"string","title":"Sacrificed Amount","description":"Amount of this earning the employee has sacrificed (Type A OpRA). Pre-tax. Must be > 0 and \u003c= hours_worked x hourly_rate when set.","uniqueKey":"payroll_group.items.[INDEX].pay_details.earnings.oneOf.0.items.[INDEX].oneOf.1.sacrificed_amount.oneOf.1","typeLabel":"string"},{"type":"null","title":"Sacrificed Amount","description":"Amount of this earning the employee has sacrificed (Type A OpRA). Pre-tax. Must be > 0 and \u003c= hours_worked x hourly_rate when set.","uniqueKey":"payroll_group.items.[INDEX].pay_details.earnings.oneOf.0.items.[INDEX].oneOf.1.sacrificed_amount.oneOf.2","typeLabel":"null"}],"uniqueKey":"payroll_group.items.[INDEX].pay_details.earnings.oneOf.0.items.[INDEX].oneOf.1.sacrificed_amount","typeLabel":"number | string | null"}},"additionalProperties":false,"uniqueKey":"payroll_group.items.[INDEX].pay_details.earnings.oneOf.0.items.[INDEX].oneOf.1","typeLabel":"HoursEarnings · object"}],"uniqueKey":"payroll_group.items.[INDEX].pay_details.earnings.oneOf.0.items.[INDEX]","typeLabel":"AmountEarnings · object | HoursEarnings · object"},"title":"Earnings","isRequired":true,"uniqueKey":"payroll_group.items.[INDEX].pay_details.earnings.oneOf.0","typeLabel":"(AmountEarnings · object | HoursEarnings · object)[]"},{"type":"null","title":"Earnings","isRequired":true,"uniqueKey":"payroll_group.items.[INDEX].pay_details.earnings.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"payroll_group.items.[INDEX].pay_details.earnings","typeLabel":"(AmountEarnings · object | HoursEarnings · object)[] | null"},"deductions":{"oneOf":[{"type":"array","items":{"additionalProperties":false,"properties":{"amount":{"oneOf":[{"type":"number","title":"Amount","minimum":0,"isRequired":true,"uniqueKey":"payroll_group.items.[INDEX].pay_details.deductions.oneOf.0.items.[INDEX].amount.oneOf.0","typeLabel":"number"},{"type":"string","title":"Amount","isRequired":true,"uniqueKey":"payroll_group.items.[INDEX].pay_details.deductions.oneOf.0.items.[INDEX].amount.oneOf.1","typeLabel":"string"}],"isRequired":true,"uniqueKey":"payroll_group.items.[INDEX].pay_details.deductions.oneOf.0.items.[INDEX].amount","typeLabel":"number | string"},"wage_type_code":{"description":"Wage type code from catalog (e.g. UK-D-001)","title":"Wage Type Code","type":"string","isRequired":true,"uniqueKey":"payroll_group.items.[INDEX].pay_details.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":"payroll_group.items.[INDEX].pay_details.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":"payroll_group.items.[INDEX].pay_details.deductions.oneOf.0.items.[INDEX].external_ref.oneOf.1","typeLabel":"null"}],"uniqueKey":"payroll_group.items.[INDEX].pay_details.deductions.oneOf.0.items.[INDEX].external_ref","typeLabel":"string | null"},"sacrificed_amount":{"oneOf":[{"type":"number","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.","minimum":0,"uniqueKey":"payroll_group.items.[INDEX].pay_details.deductions.oneOf.0.items.[INDEX].sacrificed_amount.oneOf.0","typeLabel":"number"},{"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":"payroll_group.items.[INDEX].pay_details.deductions.oneOf.0.items.[INDEX].sacrificed_amount.oneOf.1","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":"payroll_group.items.[INDEX].pay_details.deductions.oneOf.0.items.[INDEX].sacrificed_amount.oneOf.2","typeLabel":"null"}],"uniqueKey":"payroll_group.items.[INDEX].pay_details.deductions.oneOf.0.items.[INDEX].sacrificed_amount","typeLabel":"number | string | null"}},"required":["wage_type_code","amount"],"title":"Deductions","type":"object","uniqueKey":"payroll_group.items.[INDEX].pay_details.deductions.oneOf.0.items.[INDEX]","typeLabel":"Deductions · object"},"title":"Deductions","uniqueKey":"payroll_group.items.[INDEX].pay_details.deductions.oneOf.0","typeLabel":"Deductions · object[]"},{"type":"null","title":"Deductions","uniqueKey":"payroll_group.items.[INDEX].pay_details.deductions.oneOf.1","typeLabel":"null"}],"uniqueKey":"payroll_group.items.[INDEX].pay_details.deductions","typeLabel":"Deductions · object[] | null"},"reimbursements":{"oneOf":[{"type":"array","items":{"additionalProperties":false,"properties":{"amount":{"oneOf":[{"type":"number","title":"Amount","minimum":0,"isRequired":true,"uniqueKey":"payroll_group.items.[INDEX].pay_details.reimbursements.oneOf.0.items.[INDEX].amount.oneOf.0","typeLabel":"number"},{"type":"string","title":"Amount","isRequired":true,"uniqueKey":"payroll_group.items.[INDEX].pay_details.reimbursements.oneOf.0.items.[INDEX].amount.oneOf.1","typeLabel":"string"}],"isRequired":true,"uniqueKey":"payroll_group.items.[INDEX].pay_details.reimbursements.oneOf.0.items.[INDEX].amount","typeLabel":"number | string"},"wage_type_code":{"description":"Wage type code from catalog (e.g. UK-R-001)","title":"Wage Type Code","type":"string","isRequired":true,"uniqueKey":"payroll_group.items.[INDEX].pay_details.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":"payroll_group.items.[INDEX].pay_details.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":"payroll_group.items.[INDEX].pay_details.reimbursements.oneOf.0.items.[INDEX].external_ref.oneOf.1","typeLabel":"null"}],"uniqueKey":"payroll_group.items.[INDEX].pay_details.reimbursements.oneOf.0.items.[INDEX].external_ref","typeLabel":"string | null"}},"required":["wage_type_code","amount"],"title":"Reimbursement","type":"object","uniqueKey":"payroll_group.items.[INDEX].pay_details.reimbursements.oneOf.0.items.[INDEX]","typeLabel":"Reimbursement · object"},"title":"Reimbursements","uniqueKey":"payroll_group.items.[INDEX].pay_details.reimbursements.oneOf.0","typeLabel":"Reimbursement · object[]"},{"type":"null","title":"Reimbursements","uniqueKey":"payroll_group.items.[INDEX].pay_details.reimbursements.oneOf.1","typeLabel":"null"}],"uniqueKey":"payroll_group.items.[INDEX].pay_details.reimbursements","typeLabel":"Reimbursement · object[] | null"}},"required":["earnings","benefits"],"title":"Gross","type":"object","description":"At least one line: an earning, benefit, deduction or reimbursement.","isRequired":true,"uniqueKey":"payroll_group.items.[INDEX].pay_details","typeLabel":"Gross · object"}},"required":["employee_id","pay_details"],"title":"PayItemAddEntry","type":"object","uniqueKey":"payroll_group.items.[INDEX]","typeLabel":"PayItemAddEntry · object"},"minItems":1,"title":"Payroll Group","type":"array","isRequired":true,"uniqueKey":"payroll_group","typeLabel":"PayItemAddEntry · object[]"}},"required":["payroll_group"],"title":"PayItemAddRequest","type":"object","uniqueKey":"","typeLabel":"PayItemAddRequest · object"},"examples":{"Example":{"title":"Example","value":{"payroll_group":[{"employee_id":"\u003cstring>","pay_details":{"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"}],"earnings":[{"amount":123,"wage_type_code":"\u003cstring>","earning_frequency":"MONTH","earning_type":"AMOUNT","external_ref":"\u003cstring>","is_lumpsum":false,"sacrificed_amount":1}],"deductions":[{"amount":1,"wage_type_code":"\u003cstring>","external_ref":"\u003cstring>","sacrificed_amount":1}],"reimbursements":[{"amount":1,"wage_type_code":"\u003cstring>","external_ref":"\u003cstring>"}]}}]}}},"exampleType":"generated"}},"required":true,"exampleType":"generated"},"responses":{"35c3156d-2143-4e60-9cd5-227d5c64c36a":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"added_employee_ids":{"description":"The employees given pay items, once each in request order. Their payslips in the run are deleted: calculate the run again before approving it.","items":{"type":"string","uniqueKey":"added_employee_ids.items.[INDEX]","typeLabel":"string"},"title":"Added Employee Ids","type":"array","isRequired":true,"uniqueKey":"added_employee_ids","typeLabel":"string[]"}},"required":["added_employee_ids"],"title":"PayItemAddResponse","type":"object","uniqueKey":"","typeLabel":"PayItemAddResponse · object"},"examples":{"Example":{"title":"Example","value":{"added_employee_ids":["\u003cstring>"]}}},"exampleType":"generated"}},"description":"Successful Response","exampleType":"generated"},"546f49cc-3079-46fc-88be-097a69c41dfa":{"content":{"application/json":{"examples":{"ORG_BELONGS_TO_A_DIFFERENT_COUNTRY":{"title":"ORG_BELONGS_TO_A_DIFFERENT_COUNTRY","summary":"Raised when an organization belongs to a different country than the one in the path.","value":{"errors":[{"code":"ORG_BELONGS_TO_A_DIFFERENT_COUNTRY","message":"Raised when an organization belongs to a different country than the one in the path."}]}},"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","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- `SACRIFICE_NOT_ALLOWED`: Raised when a line declares a sacrifice on a wage type whose is_salary_sacrifice_allowed is false.","exampleType":"examples"},"a2a7dc80-f1c4-418f-8803-2ad91003ce65":{"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."}]}},"PAYRUN_NOT_FOUND":{"title":"PAYRUN_NOT_FOUND","summary":"Raised when a payrun is not found.","value":{"errors":[{"code":"PAYRUN_NOT_FOUND","message":"Raised when a payrun 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","PAYRUN_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- `PAYRUN_NOT_FOUND`: Raised when a payrun is not found.","exampleType":"examples"},"950d7347-5327-48db-ba62-5230fa6dae62":{"content":{"application/json":{"examples":{"GB_NIC_PRIORS_WOULD_BE_LOST":{"title":"GB_NIC_PRIORS_WOULD_BE_LOST","summary":"Raised when pay items are added for, or a move names, employees whose current payslip in the pay run was calculated with NIC prior-period niable earnings supplied through submit.","value":{"errors":[{"code":"GB_NIC_PRIORS_WOULD_BE_LOST","message":"Raised when pay items are added for, or a move names, employees whose current payslip in the pay run was calculated with NIC prior-period niable earnings supplied through submit."}]}},"INVALID_TRANSITION":{"title":"INVALID_TRANSITION","summary":"Raised when a pay run that is not DRAFT is changed: pay items added or deleted, the run calculated or cancelled, or employees moved into or out of it.","value":{"errors":[{"code":"INVALID_TRANSITION","message":"Raised when a pay run that is not DRAFT is changed: pay items added or deleted, the run calculated or cancelled, or employees moved into or out of it."}]}}},"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":["INVALID_TRANSITION","GB_NIC_PRIORS_WOULD_BE_LOST"],"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":"- `INVALID_TRANSITION`: Raised when a pay run that is not DRAFT is changed: pay items added or deleted, the run calculated or cancelled, or employees moved into or out of it.\n- `GB_NIC_PRIORS_WOULD_BE_LOST`: Raised when pay items are added for, or a move names, employees whose current payslip in the pay run was calculated with NIC prior-period niable earnings supplied through submit.","exampleType":"examples"},"d522eb16-00c9-4fe3-a09d-71139dd38efe":{"content":{"application/json":{"examples":{"GB_WAGE_TYPE_NOT_AN_INPUT":{"title":"GB_WAGE_TYPE_NOT_AN_INPUT","summary":"Raised when a pay item added to a pay run names a CALCULATED_ONLY system wage type, a pure engine output (PAYE, NIC, loans, statutory pay).","value":{"errors":[{"code":"GB_WAGE_TYPE_NOT_AN_INPUT","message":"Raised when a pay item added to a pay run names a CALCULATED_ONLY system wage type, a pure engine output (PAYE, NIC, loans, statutory pay)."}]}},"INVALID_REFERENCE":{"title":"INVALID_REFERENCE","summary":"Raised when pay items are added for employees who are not members of the pay run's pay group on the pay calendar's pay date.","value":{"errors":[{"code":"INVALID_REFERENCE","field":"payroll_group[0].employee_id","message":"Raised when pay items are added for employees who are not members of the pay run's pay group on the pay calendar's pay date.","params":{"employee_ids":["emp_01j0000000e008000000000002"],"id":"emp_01j0000000e008000000000002","reason":"OTHER_PARENT"}}]}},"INVALID_REFERENCE (NOT_FOUND)":{"title":"INVALID_REFERENCE (NOT_FOUND)","summary":"Raised when a pay item added to a pay run names a wage type that is not in the organization's catalog on the pay calendar's pay date.","value":{"errors":[{"code":"INVALID_REFERENCE","field":"payroll_group[0].pay_details.earnings[0].wage_type_code","message":"Raised when a pay item added to a pay run names a wage type that is not in the organization's catalog on the pay calendar's pay date.","params":{"id":"UK-E-999","reason":"NOT_FOUND"}}]}},"PAY_PERIOD_UNRESOLVED":{"title":"PAY_PERIOD_UNRESOLVED","summary":"Raised when a payrun's pay date and period type cannot be mapped to a tax period — either the period type is one the tax calendar does not support, or the pay date falls outside the tax year.","value":{"errors":[{"code":"PAY_PERIOD_UNRESOLVED","message":"Raised when a payrun's pay date and period type cannot be mapped to a tax period — either the period type is one the tax calendar does not support, or the pay date falls outside the tax year."}]}}},"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":["INVALID_REFERENCE","GB_WAGE_TYPE_NOT_AN_INPUT","PAY_PERIOD_UNRESOLVED","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- `INVALID_REFERENCE`: Raised when pay items are added for employees who are not members of the pay run's pay group on the pay calendar's pay date.\n- `INVALID_REFERENCE`: Raised when a pay item added to a pay run names a wage type that is not in the organization's catalog on the pay calendar's pay date.\n- `GB_WAGE_TYPE_NOT_AN_INPUT`: Raised when a pay item added to a pay run names a CALCULATED_ONLY system wage type, a pure engine output (PAYE, NIC, loans, statutory pay).\n- `PAY_PERIOD_UNRESOLVED`: Raised when a payrun's pay date and period type cannot be mapped to a tax period — either the period type is one the tax calendar does not support, or the pay date falls outside the tax year.","exampleType":"examples"}},"security":{"8d4e8409-cb7d-429f-b3ae-566e5a41c696":{"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":"Add Pay Items - Intermezzo Docs","navMaps":{"firstHrefInVersion":{"Preview":{"href":"/api-reference/preview/great-britain/add-pay-items","matchLevel":0}},"firstHrefInLanguage":{}},"lastModified":"2026-11-18T18:11:02.946Z","originalFileLocation":"api-reference/preview/great-britain/add-pay-items.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=\"light\";if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"light\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Add pay items to a DRAFT pay run, of any type, for employees of its pay group. An employee needs no other pay items in the run or the period. Lines are validated as on submit and keyed by wage type code and external_ref: a line with a key the employee already has in the run replaces it, any other line is added. The employees\u0026#x27; payslips in the run are deleted, so calculate the run again before approving it. A run that is not DRAFT, one being calculated included, is refused with 409 INVALID_TRANSITION (params.reason NOT_DRAFT, params.from its status). An employee outside the pay group, or a wage type missing from the catalog, is refused with 422 INVALID_REFERENCE (params.reason OTHER_PARENT or NOT_FOUND); a wage type the engine calculates is refused with 422 GB_WAGE_TYPE_NOT_AN_INPUT. field names the entry or line in the request, e.g. payroll_group[0].pay_details.earnings[1].wage_type_code. Refused (409) for an employee whose payslip in the run was calculated with prior-period NI-able earnings supplied through submit: deleting it would drop them. Submit that employee\u0026#x27;s items with the prior-period NI-able earnings instead.\">\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=\"Add Pay Items - Intermezzo Docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"Add pay items to a DRAFT pay run, of any type, for employees of its pay group. An employee needs no other pay items in the run or the period. Lines are validated as on submit and keyed by wage type code and external_ref: a line with a key the employee already has in the run replaces it, any other line is added. The employees\u0026#x27; payslips in the run are deleted, so calculate the run again before approving it. A run that is not DRAFT, one being calculated included, is refused with 409 INVALID_TRANSITION (params.reason NOT_DRAFT, params.from its status). An employee outside the pay group, or a wage type missing from the catalog, is refused with 422 INVALID_REFERENCE (params.reason OTHER_PARENT or NOT_FOUND); a wage type the engine calculates is refused with 422 GB_WAGE_TYPE_NOT_AN_INPUT. field names the entry or line in the request, e.g. payroll_group[0].pay_details.earnings[1].wage_type_code. Refused (409) for an employee whose payslip in the run was calculated with prior-period NI-able earnings supplied through submit: deleting it would drop them. Submit that employee\u0026#x27;s items with the prior-period NI-able earnings instead.\">\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/add-pay-items\">\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=Pay+Items\u0026amp;title=Add+Pay+Items\u0026amp;description=Add+pay+items+to+a+DRAFT+pay+run%2C+of+any+type%2C+for+employees+of+its+pay+group.%0A%0AAn+employee+needs+no+other+pay+items+in+the+run+or+the+period.+Lines+are+validat\u0026amp;theme=2cc41bc2d4d72760d1901e1b\u0026amp;signature=ca47ae50b9dc73c00755fc86b527563a2516b50d8bba1a7f2a878b5312cdd4c9\">\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=\"Add Pay Items - Intermezzo Docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Add pay items to a DRAFT pay run, of any type, for employees of its pay group. An employee needs no other pay items in the run or the period. Lines are validated as on submit and keyed by wage type code and external_ref: a line with a key the employee already has in the run replaces it, any other line is added. The employees\u0026#x27; payslips in the run are deleted, so calculate the run again before approving it. A run that is not DRAFT, one being calculated included, is refused with 409 INVALID_TRANSITION (params.reason NOT_DRAFT, params.from its status). An employee outside the pay group, or a wage type missing from the catalog, is refused with 422 INVALID_REFERENCE (params.reason OTHER_PARENT or NOT_FOUND); a wage type the engine calculates is refused with 422 GB_WAGE_TYPE_NOT_AN_INPUT. field names the entry or line in the request, e.g. payroll_group[0].pay_details.earnings[1].wage_type_code. Refused (409) for an employee whose payslip in the run was calculated with prior-period NI-able earnings supplied through submit: deleting it would drop them. Submit that employee\u0026#x27;s items with the prior-period NI-able earnings instead.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://intermezzo.mintlify.site/_mintlify/api/og/v2?division=Pay+Items\u0026amp;title=Add+Pay+Items\u0026amp;description=Add+pay+items+to+a+DRAFT+pay+run%2C+of+any+type%2C+for+employees+of+its+pay+group.%0A%0AAn+employee+needs+no+other+pay+items+in+the+run+or+the+period.+Lines+are+validat\u0026amp;theme=2cc41bc2d4d72760d1901e1b\u0026amp;signature=ca47ae50b9dc73c00755fc86b527563a2516b50d8bba1a7f2a878b5312cdd4c9\">\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/add-pay-items\">\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/add-pay-items.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/add-pay-items#webpage\",\"url\":\"https://docs.intermezzo.ai/api-reference/preview/great-britain/add-pay-items\",\"name\":\"Add Pay Items\",\"description\":\"Add pay items to a DRAFT pay run, of any type, for employees of its pay group. An employee needs no other pay items in the run or the period. Lines are validated as on submit and keyed by wage type code and external_ref: a line with a key the employee already has in the run replaces it, any other line is added. The employees' payslips in the run are deleted, so calculate the run again before approving it. A run that is not DRAFT, one being calculated included, is refused with 409 INVALID_TRANSITION (params.reason NOT_DRAFT, params.from its status). An employee outside the pay group, or a wage type missing from the catalog, is refused with 422 INVALID_REFERENCE (params.reason OTHER_PARENT or NOT_FOUND); a wage type the engine calculates is refused with 422 GB_WAGE_TYPE_NOT_AN_INPUT. field names the entry or line in the request, e.g. payroll_group[0].pay_details.earnings[1].wage_type_code. Refused (409) for an employee whose payslip in the run was calculated with prior-period NI-able earnings supplied through submit: deleting it would drop them. Submit that employee's items with the prior-period NI-able earnings instead.\",\"dateModified\":\"2026-11-18T18:11:02.946Z\",\"isPartOf\":{\"@id\":\"https://docs.intermezzo.ai#website\"},\"breadcrumb\":{\"@id\":\"https://docs.intermezzo.ai/api-reference/preview/great-britain/add-pay-items#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.intermezzo.ai/api-reference/preview/great-britain/add-pay-items#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\":\"Pay Items\",\"item\":\"https://docs.intermezzo.ai/api-reference/preview/great-britain/list-pay-items\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Add Pay Items\",\"item\":\"https://docs.intermezzo.ai/api-reference/preview/great-britain/add-pay-items\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.intermezzo.ai/api-reference/preview/great-britain/add-pay-items#apireference\",\"headline\":\"Add Pay Items\",\"name\":\"Add Pay Items\",\"description\":\"Add pay items to a DRAFT pay run, of any type, for employees of its pay group. An employee needs no other pay items in the run or the period. Lines are validated as on submit and keyed by wage type code and external_ref: a line with a key the employee already has in the run replaces it, any other line is added. The employees' payslips in the run are deleted, so calculate the run again before approving it. A run that is not DRAFT, one being calculated included, is refused with 409 INVALID_TRANSITION (params.reason NOT_DRAFT, params.from its status). An employee outside the pay group, or a wage type missing from the catalog, is refused with 422 INVALID_REFERENCE (params.reason OTHER_PARENT or NOT_FOUND); a wage type the engine calculates is refused with 422 GB_WAGE_TYPE_NOT_AN_INPUT. field names the entry or line in the request, e.g. payroll_group[0].pay_details.earnings[1].wage_type_code. Refused (409) for an employee whose payslip in the run was calculated with prior-period NI-able earnings supplied through submit: deleting it would drop them. Submit that employee's items with the prior-period NI-able earnings instead.\",\"url\":\"https://docs.intermezzo.ai/api-reference/preview/great-britain/add-pay-items\",\"mainEntityOfPage\":{\"@id\":\"https://docs.intermezzo.ai/api-reference/preview/great-britain/add-pay-items#webpage\"},\"dateModified\":\"2026-11-18T18:11:02.946Z\",\"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/add-pay-items.md","siteName":"Intermezzo Docs","nav":{"global":null,"versions":[{"version":"Preview","tabs":[{"tab":"Guides","pages":[{"title":"Guides","href":""}]},{"tab":"API Reference","groups":[{"group":"Great Britain","pages":[{"group":"Organizations","pages":[{"title":"List Organizations","deprecated":null,"version":null,"openapi":"/api-reference/preview.json get /gb/organizations","href":"/api-reference/preview/great-britain/list-organizations"},{"title":"Create Organization","deprecated":null,"version":null,"openapi":"/api-reference/preview.json post /gb/organizations","href":"/api-reference/preview/great-britain/create-organization"},{"title":"Create Organizations","deprecated":null,"version":null,"openapi":"/api-reference/preview.json post /gb/organizations/list","href":"/api-reference/preview/great-britain/create-organizations"},{"title":"Get Organization","deprecated":null,"version":null,"openapi":"/api-reference/preview.json get /gb/organizations/{organization_id}","href":"/api-reference/preview/great-britain/get-organization"},{"title":"Close Organization","deprecated":null,"version":null,"openapi":"/api-reference/preview.json post /gb/organizations/{organization_id}/close","href":"/api-reference/preview/great-britain/close-organization"},{"title":"Set HMRC Credentials","deprecated":null,"version":null,"openapi":"/api-reference/preview.json put /gb/organizations/{organization_id}/hmrc-credentials","href":"/api-reference/preview/great-britain/set-hmrc-credentials"},{"title":"Get Organization Status","deprecated":null,"version":null,"openapi":"/api-reference/preview.json get /gb/organizations/{organization_id}/status","href":"/api-reference/preview/great-britain/get-organization-status"},{"group":"Address","pages":[{"title":"Get Address","deprecated":null,"version":null,"openapi":"/api-reference/preview.json get /gb/organizations/{organization_id}/address","href":"/api-reference/preview/great-britain/get-address"},{"title":"Create Address Edition","deprecated":null,"version":null,"openapi":"/api-reference/preview.json put /gb/organizations/{organization_id}/address","href":"/api-reference/preview/great-britain/create-address-edition"},{"title":"Get Address Editions","deprecated":null,"version":null,"openapi":"/api-reference/preview.json get /gb/organizations/{organization_id}/address/editions","href":"/api-reference/preview/great-britain/get-address-editions"},{"title":"Get Address Protocol","deprecated":null,"version":null,"openapi":"/api-reference/preview.json get /gb/organizations/{organization_id}/address/protocol","href":"/api-reference/preview/great-britain/get-address-protocol"}]},{"group":"Bank","pages":[{"title":"Get Bank","deprecated":null,"version":null,"openapi":"/api-reference/preview.json get /gb/organizations/{organization_id}/bank","href":"/api-reference/preview/great-britain/get-bank"},{"title":"Create Bank Edition","deprecated":null,"version":null,"openapi":"/api-reference/preview.json put /gb/organizations/{organization_id}/bank","href":"/api-reference/preview/great-britain/create-bank-edition"},{"title":"Get Bank Editions","deprecated":null,"version":null,"openapi":"/api-reference/preview.json get /gb/organizations/{organization_id}/bank/editions","href":"/api-reference/preview/great-britain/get-bank-editions"},{"title":"Get Bank Protocol","deprecated":null,"version":null,"openapi":"/api-reference/preview.json get /gb/organizations/{organization_id}/bank/protocol","href":"/api-reference/preview/great-britain/get-bank-protocol"}]},{"group":"Contact","pages":[{"title":"Get Contact","deprecated":null,"version":null,"openapi":"/api-reference/preview.json get /gb/organizations/{organization_id}/contact","href":"/api-reference/preview/great-britain/get-contact"},{"title":"Create Contact Edition","deprecated":null,"version":null,"openapi":"/api-reference/preview.json put /gb/organizations/{organization_id}/contact","href":"/api-reference/preview/great-britain/create-contact-edition"},{"title":"Get Contact Editions","deprecated":null,"version":null,"openapi":"/api-reference/preview.json get /gb/organizations/{organization_id}/contact/editions","href":"/api-reference/preview/great-britain/get-contact-editions"},{"title":"Get Contact Protocol","deprecated":null,"version":null,"openapi":"/api-reference/preview.json get /gb/organizations/{organization_id}/contact/protocol","href":"/api-reference/preview/great-britain/get-contact-protocol"}]},{"group":"Core","pages":[{"title":"Get Core","deprecated":null,"version":null,"openapi":"/api-reference/preview.json get /gb/organizations/{organization_id}/core","href":"/api-reference/preview/great-britain/get-core"},{"title":"Create Core Edition","deprecated":null,"version":null,"openapi":"/api-reference/preview.json put /gb/organizations/{organization_id}/core","href":"/api-reference/preview/great-britain/create-core-edition"},{"title":"Get Core Editions","deprecated":null,"version":null,"openapi":"/api-reference/preview.json get /gb/organizations/{organization_id}/core/editions","href":"/api-reference/preview/great-britain/get-core-editions"},{"title":"Get Core Protocol","deprecated":null,"version":null,"openapi":"/api-reference/preview.json get /gb/organizations/{organization_id}/core/protocol","href":"/api-reference/preview/great-britain/get-core-protocol"}]},{"group":"Insurance","pages":[{"title":"Get Insurance","deprecated":null,"version":null,"openapi":"/api-reference/preview.json get /gb/organizations/{organization_id}/insurance","href":"/api-reference/preview/great-britain/get-insurance"},{"title":"Create Insurance Edition","deprecated":null,"version":null,"openapi":"/api-reference/preview.json put /gb/organizations/{organization_id}/insurance","href":"/api-reference/preview/great-britain/create-insurance-edition"},{"title":"Get Insurance Editions","deprecated":null,"version":null,"openapi":"/api-reference/preview.json get /gb/organizations/{organization_id}/insurance/editions","href":"/api-reference/preview/great-britain/get-insurance-editions"},{"title":"Get Insurance Protocol","deprecated":null,"version":null,"openapi":"/api-reference/preview.json get /gb/organizations/{organization_id}/insurance/protocol","href":"/api-reference/preview/great-britain/get-insurance-protocol"}]},{"group":"Tax","pages":[{"title":"Get Tax","deprecated":null,"version":null,"openapi":"/api-reference/preview.json get /gb/organizations/{organization_id}/tax","href":"/api-reference/preview/great-britain/get-tax"},{"title":"Create Tax Edition","deprecated":null,"version":null,"openapi":"/api-reference/preview.json put /gb/organizations/{organization_id}/tax","href":"/api-reference/preview/great-britain/create-tax-edition"},{"title":"Get Tax Editions","deprecated":null,"version":null,"openapi":"/api-reference/preview.json get /gb/organizations/{organization_id}/tax/editions","href":"/api-reference/preview/great-britain/get-tax-editions"},{"title":"Get Tax Protocol","deprecated":null,"version":null,"openapi":"/api-reference/preview.json get /gb/organizations/{organization_id}/tax/protocol","href":"/api-reference/preview/great-britain/get-tax-protocol"}]}]},{"group":"Absence Schemes","pages":[{"title":"List Absence Scheme Assignments","deprecated":null,"version":null,"openapi":"/api-reference/preview.json get /gb/organizations/{organization_id}/absence-scheme-assignments","href":"/api-reference/preview/great-britain/list-absence-scheme-assignments"},{"title":"Create Absence Scheme Assignment","deprecated":null,"version":null,"openapi":"/api-reference/preview.json post /gb/organizations/{organization_id}/absence-scheme-assignments","href":"/api-reference/preview/great-britain/create-absence-scheme-assignment"},{"title":"End Absence Scheme Assignment","deprecated":null,"version":null,"openapi":"/api-reference/preview.json delete /gb/organizations/{organization_id}/absence-scheme-assignments/{assignment_id}","href":"/api-reference/preview/great-britain/end-absence-scheme-assignment"},{"title":"List Absence Schemes","deprecated":null,"version":null,"openapi":"/api-reference/preview.json get /gb/organizations/{organization_id}/absence-schemes","href":"/api-reference/preview/great-britain/list-absence-schemes"},{"title":"Create Absence Scheme","deprecated":null,"version":null,"openapi":"/api-reference/preview.json post /gb/organizations/{organization_id}/absence-schemes","href":"/api-reference/preview/great-britain/create-absence-scheme"},{"title":"Delete Absence Scheme","deprecated":null,"version":null,"openapi":"/api-reference/preview.json delete /gb/organizations/{organization_id}/absence-schemes/{scheme_id}","href":"/api-reference/preview/great-britain/delete-absence-scheme"},{"title":"Get Absence Scheme","deprecated":null,"version":null,"openapi":"/api-reference/preview.json get /gb/organizations/{organization_id}/absence-schemes/{scheme_id}","href":"/api-reference/preview/great-britain/get-absence-scheme"},{"title":"Update Absence Scheme","deprecated":null,"version":null,"openapi":"/api-reference/preview.json put /gb/organizations/{organization_id}/absence-schemes/{scheme_id}","href":"/api-reference/preview/great-britain/update-absence-scheme"},{"title":"List Absence Scheme Editions","deprecated":null,"version":null,"openapi":"/api-reference/preview.json get /gb/organizations/{organization_id}/absence-schemes/{scheme_id}/editions","href":"/api-reference/preview/great-britain/list-absence-scheme-editions"}]},{"group":"Employees","pages":[{"title":"List Employees","deprecated":null,"version":null,"openapi":"/api-reference/preview.json get /gb/organizations/{organization_id}/employees","href":"/api-reference/preview/great-britain/list-employees"},{"title":"Create Employee","deprecated":null,"version":null,"openapi":"/api-reference/preview.json post /gb/organizations/{organization_id}/employees","href":"/api-reference/preview/great-britain/create-employee"},{"title":"Create Employees","deprecated":null,"version":null,"openapi":"/api-reference/preview.json post /gb/organizations/{organization_id}/employees/list","href":"/api-reference/preview/great-britain/create-employees"},{"title":"Get Employee","deprecated":null,"version":null,"openapi":"/api-reference/preview.json get /gb/organizations/{organization_id}/employees/{employee_id}","href":"/api-reference/preview/great-britain/get-employee"},{"title":"Close Employee","deprecated":null,"version":null,"openapi":"/api-reference/preview.json post /gb/organizations/{organization_id}/employees/{employee_id}/close","href":"/api-reference/preview/great-britain/close-employee"},{"title":"Get Employee Status","deprecated":null,"version":null,"openapi":"/api-reference/preview.json get /gb/organizations/{organization_id}/employees/{employee_id}/status","href":"/api-reference/preview/great-britain/get-employee-status"},{"group":"Address","pages":[{"title":"Get Address","deprecated":null,"version":null,"openapi":"/api-reference/preview.json get /gb/organizations/{organization_id}/employees/{employee_id}/address","href":"/api-reference/preview/great-britain/get-address-1"},{"title":"Create Address Edition","deprecated":null,"version":null,"openapi":"/api-reference/preview.json put /gb/organizations/{organization_id}/employees/{employee_id}/address","href":"/api-reference/preview/great-britain/create-address-edition-1"},{"title":"Get Address Editions","deprecated":null,"version":null,"openapi":"/api-reference/preview.json get /gb/organizations/{organization_id}/employees/{employee_id}/address/editions","href":"/api-reference/preview/great-britain/get-address-editions-1"},{"title":"Get Address Protocol","deprecated":null,"version":null,"openapi":"/api-reference/preview.json get /gb/organizations/{organization_id}/employees/{employee_id}/address/protocol","href":"/api-reference/preview/great-britain/get-address-protocol-1"}]},{"group":"Bank","pages":[{"title":"Get Bank","deprecated":null,"version":null,"openapi":"/api-reference/preview.json get /gb/organizations/{organization_id}/employees/{employee_id}/bank","href":"/api-reference/preview/great-britain/get-bank-1"},{"title":"Create Bank Edition","deprecated":null,"version":null,"openapi":"/api-reference/preview.json put /gb/organizations/{organization_id}/employees/{employee_id}/bank","href":"/api-reference/preview/great-britain/create-bank-edition-1"},{"title":"Get Bank Editions","deprecated":null,"version":null,"openapi":"/api-reference/preview.json get /gb/organizations/{organization_id}/employees/{employee_id}/bank/editions","href":"/api-reference/preview/great-britain/get-bank-editions-1"},{"title":"Get Bank Protocol","deprecated":null,"version":null,"openapi":"/api-reference/preview.json get /gb/organizations/{organization_id}/employees/{employee_id}/bank/protocol","href":"/api-reference/preview/great-britain/get-bank-protocol-1"}]},{"group":"Compensation","pages":[{"title":"Get Compensation","deprecated":null,"version":null,"openapi":"/api-reference/preview.json get /gb/organizations/{organization_id}/employees/{employee_id}/compensation","href":"/api-reference/preview/great-britain/get-compensation"},{"title":"Create Compensation Edition","deprecated":null,"version":null,"openapi":"/api-reference/preview.json put /gb/organizations/{organization_id}/employees/{employee_id}/compensation","href":"/api-reference/preview/great-britain/create-compensation-edition"},{"title":"Get Compensation Editions","deprecated":null,"version":null,"openapi":"/api-reference/preview.json get /gb/organizations/{organization_id}/employees/{employee_id}/compensation/editions","href":"/api-reference/preview/great-britain/get-compensation-editions"},{"title":"Get Compensation Protocol","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","description":"List a payrun's DRAFT pay-items. Repeatable `employee_id` filters to those\nemployees; omit for all employees in the run. DRAFT is implicit.","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","description":"Batch soft-delete CALLER pay-items of a DRAFT pay run by id and/or caller key: marks\nthem is_deleted (retained for audit, excluded from reads), not a hard delete.\nIdempotent, with a per-target outcome; a VALUED, STANDING or ADMIN_ENTRY item is\nrefused. The payslips in the run of the employees whose lines were deleted are\ndeleted, so calculate the run again before approving it.\n\nRefused (409 `INVALID_TRANSITION`) for a pay run that is not DRAFT, one being\ncalculated included, as on adding pay items. Refused whole (409), deleting\nnothing, when the payslip of an employee whose line would be deleted was calculated\nwith prior-period NI-able earnings supplied through submit: deleting it would drop\nthem. Submit that employee's items with the prior-period NI-able earnings instead.\nRefused whole (409 `GB_MAIN_PAY_ITEMS_HOLD_NMW_HOURS`) when it would leave a positive\npay main run no pay items for an employee whose minimum wage hours an approved\nsupplementary run of the period left to the main run. A draft supplementary that left\nthem there has its payslip for the employee deleted, so it is calculated again; while\na run of the period is being calculated for the employee, the delete is refused (409\n`RESULT_NOT_CALCULATED`, `params.reason` `OTHER_RUN_CALCULATING`): retry once it has\nfinished.","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":"Add Pay Items - Intermezzo Docs","deploymentId":"dpl_FZMKUpaaKiVETbfqhoUe4sPFDTmY","buildId":"dpl_FZMKUpaaKiVETbfqhoUe4sPFDTmY","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-B6WFFOBL.js","utils-BN5um1KA.js","cloneDeep-C3md22mN.js","_Uint8Array-DLlL8L26.js","isObject-FP1Yky1u.js","utils-BSmbkXJR.js","addUniqueKeysToSchema-2tqcVnUE.js","snippetPresets-CtWfvr2J.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-DkKHBy30.js","isEqual-O3q7y6pq.js","usePlaygroundInputsStore-Brc5H9UJ.js","shallow-C4L4xvbs.js","getApiPlaygroundDisplay-2bxyq_aI.js","CodeSnippet-BJu8ddd5.js","CodeSnippets-dazWmoqB.js","Page-CnLhKuUV.js","getPastedJson-Chy3Qa1S.js","icon-CyO7h3jh.js","MethodPill-Dle0_91v.js","DuplicateIcon-CVvWAf4a.js","createIcon-Di07A27B.js","DynamicMarkdown-C4w9kavL.js","SectionHeading-XiBebVYC.js","axios-vUo_bRtp.js","Markdown-DTeL0SpS.js","dist-OCScizqf.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","katex-YMM-FMeD.js","html-void-elements-mCSPHezU.js","marked.esm-CZWythHk.js","AssistantPageLink-KcneGfMY.js"]}