Skip to main content
POST
Create or update payslip metadata such as notes and payment date overwrite

Authorizations

X-Auth-Token
string
header
required

Access token obtained from OAuth2 client credentials flow

X-Org-Id
string
header
required

Organisation to scope the request to. Required when the principal can access more than one organisation; optional for single-organisation principals (the authorizer resolves it automatically).

Path Parameters

employeeId
string
required

ID of the employee

year
integer
required

Year of the payslip

period
integer
required

Pay period number within the year

Body

application/json
notes
string | null
required

Notes to be added or updated for the payslip

Example:

"Additional holiday pay included for this period"

paymentDateOverwrite
string | null

Payment date overwrite for the payslip

Example:

"2024-02-28"

Response

Payslip metadata created or updated successfully

message
object
content
object
validationIssues
object[]
messageToken
string