Create Job Edition
If-Match carries the edition of the slice the range starts in, as read. A satellite not yet written is created by a PUT with If-None-Match: * instead, on a range that runs to 9999-12-31. The response’s ETag is the edition written.
Headers
Body
Whether the worker's ordinary place of work under their contract is in the UK (per TPR Detailed Guidance No. 1). If False, the employer has no statutory auto-enrolment duties for this worker. Employees on temporary overseas secondment who remain on UK payroll and whose ordinary place of work is the UK stay True: this flag reflects the contractual base, not the employee's current physical location.
Why the worker does not ordinarily work in the UK. Required, and other than NOT_APPLICABLE, when ordinarily_works_in_uk is False; must be NOT_APPLICABLE when it is True.
NOT_APPLICABLE, OVERSEAS_CONTRACT, OUTBOUND_POSTING, INBOUND_TEMPORARY_POSTING, MOBILE_WORKER_OVERSEAS_BASE, OTHER "NOT_APPLICABLE"
How the worker is engaged. EMPLOYEE: a direct employee under PAYE. OFF_PAYROLL: subject to the off-payroll working rules (IR35, Chapter 10 ITEPA 2003), with this employer as the deemed employer; reported to HMRC as OffPayrollWorker, and no student or postgraduate loan is deducted. Independent of worker_type: a director can be off-payroll. Changing it within a tax year after a payment is not supported yet: the next FPS fails. More values will be added; accept values you do not know.
EMPLOYEE, OFF_PAYROLL UK postcode of the Freeport or Investment Zone special tax site where the employee works, e.g. "SW1A 1AA". Reported to HMRC while a Freeport or Investment Zone NI category letter (F, I, L, S, N, E, D, K) applies in the tax year; approving a payrun that needs it and has none is refused. Whether the postcode lies inside a special tax site is not checked. Null when none.
Response
Successful Response
How the worker is engaged. EMPLOYEE: a direct employee under PAYE. OFF_PAYROLL: subject to the off-payroll working rules (IR35, Chapter 10 ITEPA 2003), with this employer as the deemed employer; reported to HMRC as OffPayrollWorker, and no student or postgraduate loan is deducted. Independent of worker_type: a director can be off-payroll. Changing it within a tax year after a payment is not supported yet: the next FPS fails. More values will be added; accept values you do not know.
EMPLOYEE, OFF_PAYROLL UK postcode of the Freeport or Investment Zone special tax site where the employee works, e.g. "SW1A 1AA". Reported to HMRC while a Freeport or Investment Zone NI category letter (F, I, L, S, N, E, D, K) applies in the tax year; approving a payrun that needs it and has none is refused. Whether the postcode lies inside a special tax site is not checked. Null when none.
^[A-Z]([0-9]|[0-9]{2}|([A-HJ-Y][0-9]{1,2})|([0-9][A-Z])|([A-HJ-Y][0-9]?[A-Z])) [0-9][ABD-HJLNP-UW-Z]{2}$