User Payroll Information

List of valid attributes:

Attribute	Description	Specifics
staff_number	Staff number of employee	Can be blank; if set, must be an integer between 1 and 99,999 and unique within the account
employment_start_date	Employment start date	Can be blank; if set, must be a valid date in the format YYYY-MM-DD

Show

This endpoint retrieves the payroll information for a specific user. Returns data: null if no payroll information is set.

HTTP Request

GET /api/v1/users/:user_id/payroll_information

URL Parameters

Parameter	Description
user_id	The ID of the user to return the payroll information for

Example response:

{
  "data": {
    "id": "98815bd8-f3e6-41ec-8c4a-25a431ac6ce4",
    "type": "payroll_information",
    "attributes": {
      "staff_number": "12345",
      "employment_start_date": "2025-05-06"
    }
  }
}

Update

This endpoint updates the payroll information for a specific user.

HTTP Request

PUT /api/v1/users/:user_id/payroll_information

URL Parameters

Parameter	Description
user_id	The ID of the user to update the payroll information for

Example request body:

{
  "data": {
    "type": "payroll_information",
    "attributes": {
      "staff_number": "12345",
      "employment_start_date": "2025-06-06"
    }
  }
}

Example response:

{
  "data": {
    "id": "98815bd8-f3e6-41ec-8c4a-25a431ac6ce4",
    "type": "payroll_information",
    "attributes": {
      "staff_number": "12345",
      "employment_start_date": "2025-06-06"
    }
  }
}