Skip to main content
GET
Get Job

Authorizations

Authorization
string
header
required

Get token from Auth0 and paste it here

Path Parameters

organization_id
string
required
employee_id
string
required

Query Parameters

valid_at
string<date> | null

Valid-time date to read, past or future. Defaults to today, or to the first upcoming edition when nothing is valid yet.

Response

Successful Response

created_at
string<date-time>
required
read-only
created_by
string
required
read-only

Who wrote the edition: the acting user (X-Acting-User, else the access credential), system for our own writes, or <authority>:<notice> for a write on an authority's behalf, e.g. hmrc:P6.

edition
integer
required
read-only
valid_from
string<date>
required
valid_to
string<date>
required
apprenticeship
Apprenticeship · object | null

Apprenticeship details

contracted_weekdays
enum<string>[] | null

Contracted working days of the week

Days of the week.

Available options:
MONDAY,
TUESDAY,
WEDNESDAY,
THURSDAY,
FRIDAY,
SATURDAY,
SUNDAY
contracted_weekly_hours
integer | null
default:40

Contracted weekly hours

department
string | null

Department

director_since
string<date> | null

Date appointed as director

end_date
string<date> | null

Last day of employment

engagement_type
enum<string>
default:EMPLOYEE

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.

Available options:
EMPLOYEE,
OFF_PAYROLL
irregular_payment_pattern
boolean
default:false

The employee is not paid every pay period

ordinarily_works_in_uk
boolean
default:true

Whether the worker's ordinary place of work is in the UK

p45_issued
boolean
default:false

True once a P45 has been issued

pay_basis
enum<string>
default:SALARIED

How pay and hours are determined

Available options:
SALARIED,
HOURLY
pay_group_id
string | null

The pay group the employee is paid in

proration_basis
ProrationBasis · object | null

Employee-level override of the inherited proration basis

start_date
string<date> | null

Employment start date

uk_work_exclusion_reason
enum<string>
default:NOT_APPLICABLE

Why the worker does not ordinarily work in the UK

Available options:
NOT_APPLICABLE,
OVERSEAS_CONTRACT,
OUTBOUND_POSTING,
INBOUND_TEMPORARY_POSTING,
MOBILE_WORKER_OVERSEAS_BASE,
OTHER
worker_type
enum<string>
default:EMPLOYEE

UK employment status

Available options:
EMPLOYEE,
DIRECTOR
workplace_postcode
string | null

UK postcode of the Freeport or Investment Zone special tax site where the employee works, e.g. "SW1A 1AA". Reported to HMRC while a Freeport or Investment Zone NI category letter (F, I, L, S, N, E, D, K) applies in the tax year; approving a payrun that needs it and has none is refused. Whether the postcode lies inside a special tax site is not checked. Null when none.

Pattern: ^[A-Z]([0-9]|[0-9]{2}|([A-HJ-Y][0-9]{1,2})|([0-9][A-Z])|([A-HJ-Y][0-9]?[A-Z])) [0-9][ABD-HJLNP-UW-Z]{2}$