Skip to main content
POST
Calculate the salary lines for a pay period

Authorizations

X-Auth-Token
string
header
required

FlowPayroll JWT (raw token, no Bearer prefix)

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

Body

application/json

Runs the salary calculation for one employee and one pay period without side effects.

payrollConfigId
string
required

The payroll configuration the pay period belongs to.

Minimum string length: 1
periodStartDate
string
required

First day of the pay period, YYYY-MM-DD.

Minimum string length: 1
periodEndDate
string
required

Last day of the pay period, YYYY-MM-DD.

Minimum string length: 1
frequency
string
required

Pay frequency: Weekly, Fortnightly, FourWeekly, Monthly, Quarterly, BiAnnually or Annual.

Minimum string length: 1
year
integer<int32> | null

Tax year of the pay run. Optional; with period it makes the returned line item ids match the ones the pay run receives.

period
integer<int32> | null

Period number of the pay run. Optional; see year.

statutoryLines
object[] | null

Statutory pay lines to treat as if they were on the payslip, so the salary adjustment and any top-up can be previewed. Optional.

Response

OK

message
object
content
object
validationIssues
object[] | null