GET
/
organizations
/
{organization_id}
/
employees
/
{employee_id}
/
tax-details
/
history
Get Employee Tax Details History
curl --request GET \
  --url https://api.example.com/organizations/{organization_id}/employees/{employee_id}/tax-details/history \
  --header 'Authorization: Bearer <token>'
[
  {
    "id": 123,
    "employeeId": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "taxCode": {
      "originalCode": "<string>",
      "personalAllowance": "0",
      "prefix": "<string>",
      "prefixMeaning": "<string>",
      "suffix": "<string>",
      "suffixMeaning": "<string>",
      "emergency": false,
      "region": "England/NI"
    },
    "employmentCountry": "GB",
    "studentLoanType": "Plan1",
    "postgraduateLoan": false,
    "p45GrossPay": "0.00",
    "p45TaxAmount": "0.00",
    "validFrom": "2023-12-25",
    "validTo": "2023-12-25"
  }
]

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
organization_id
required
​
employee_id
required

Response

Successful Response

Response model for tax details with metadata fields.

​
id
required
​
employeeId
string
required
​
createdAt
string<date-time> | null
required
​
updatedAt
string<date-time> | null
required
​
taxCode
TaxCode · object
required
​
employmentCountry
string
default:GB
Allowed value: "GB"
​
studentLoanType
enum<string> | null

Types of student loan plans

Available options:
Plan1,
Plan2,
Plan4
​
postgraduateLoan
boolean
default:false
​
p45GrossPay
string | null
default:0.00
​
p45TaxAmount
string | null
default:0.00
​
validFrom
string<date> | null
​
validTo
string<date> | null