Skip to main content
GET
Get Tax

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

edition
integer
required
read-only
valid_from
string<date>
required
valid_to
string<date>
required
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.

rti_id
string | null

RTI Payroll ID, unique for this employee in HMRC submissions. Generated when absent.

Required string length: 1 - 35
tax_code
string | null
student_loan_type
enum<string> | null

Student loan type

Available options:
Plan1,
Plan2,
Plan4
postgraduate_loan
boolean
default:false

Postgraduate loan?

p45_gross_pay
string | null
default:0.00

P45 gross pay

Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
p45_tax_amount
string | null
default:0.00

P45 tax amount

Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$