Skip to main content
POST
/
payslip
/
data
/
{employeeId}
/
{year}
/
{period}
Create or update payslip metadata such as notes and payment date overwrite
curl --request POST \
  --url https://api.sandbox.flowpayroll.ai/v1/payslip/data/{employeeId}/{year}/{period} \
  --header 'Content-Type: application/json' \
  --header 'X-Auth-Token: <api-key>' \
  --data '
{
  "payslipMetadata": {
    "notes": "Additional holiday pay included for this period",
    "paymentDateOverwrite": "2024-02-28"
  }
}
'
{
  "message": {
    "text": "Payslip metadata added or updated",
    "token": "payslipMetadataAddedOrUpdated"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.flowpayroll.ai/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
X-Auth-Token
string
header
required

Access token obtained from OAuth2 client credentials flow

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