API Reference

Create a draft termination for a payroll team member

post
https://api.oysterhr.com/v1/offboardings/payroll_team_members/terminations

This API endpoint allows you to create a draft offboarding for a payroll team member.

This endpoint requires the X-Oyster-Actor-Email header when using client credentials authentication.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required
length ≥ 1
string
required
length ≥ 1
date
required
length ≥ 1
date
required
length ≥ 1
boolean
required
string
length ≥ 1
string
length ≥ 1
number
≥ 0
additionalPayments
array of objects
additionalPayments
payrollPayoutMonthChange
object
Responses

Updated 9 days ago

Language
Credentials
Bearer
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 9 days ago