Calculate the salary lines for a pay period
Runs the pro-rata calculation for one employee and pay period with no side effects, using the employee’s salary history and working pattern exactly as a pay run does. Supply year and period to get the line item ids the pay run would receive. Supply statutoryLines to preview the salary adjustment and any top-up the employee’s statutory leave policy produces for them; each result line carries its kind.
curl --request POST \
--url https://api.sandbox.flowpayroll.ai/v1/salary/employees/{employeeId}/calculate \
--header 'Content-Type: application/json' \
--header 'X-Auth-Token: <api-key>' \
--header 'X-Org-Id: <api-key>' \
--data '
{
"payrollConfigId": "<string>",
"periodStartDate": "<string>",
"periodEndDate": "<string>",
"frequency": "<string>",
"year": 123,
"period": 123,
"statutoryLines": [
{
"statutoryType": "<string>",
"units": 123,
"unitName": "<string>",
"amount": 123,
"id": "<string>",
"from": "<string>",
"to": "<string>",
"leaveStart": "<string>",
"periodAmount": 123
}
]
}
'import requests
url = "https://api.sandbox.flowpayroll.ai/v1/salary/employees/{employeeId}/calculate"
payload = {
"payrollConfigId": "<string>",
"periodStartDate": "<string>",
"periodEndDate": "<string>",
"frequency": "<string>",
"year": 123,
"period": 123,
"statutoryLines": [
{
"statutoryType": "<string>",
"units": 123,
"unitName": "<string>",
"amount": 123,
"id": "<string>",
"from": "<string>",
"to": "<string>",
"leaveStart": "<string>",
"periodAmount": 123
}
]
}
headers = {
"X-Auth-Token": "<api-key>",
"X-Org-Id": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'X-Auth-Token': '<api-key>',
'X-Org-Id': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
payrollConfigId: '<string>',
periodStartDate: '<string>',
periodEndDate: '<string>',
frequency: '<string>',
year: 123,
period: 123,
statutoryLines: [
{
statutoryType: '<string>',
units: 123,
unitName: '<string>',
amount: 123,
id: '<string>',
from: '<string>',
to: '<string>',
leaveStart: '<string>',
periodAmount: 123
}
]
})
};
fetch('https://api.sandbox.flowpayroll.ai/v1/salary/employees/{employeeId}/calculate', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.sandbox.flowpayroll.ai/v1/salary/employees/{employeeId}/calculate",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'payrollConfigId' => '<string>',
'periodStartDate' => '<string>',
'periodEndDate' => '<string>',
'frequency' => '<string>',
'year' => 123,
'period' => 123,
'statutoryLines' => [
[
'statutoryType' => '<string>',
'units' => 123,
'unitName' => '<string>',
'amount' => 123,
'id' => '<string>',
'from' => '<string>',
'to' => '<string>',
'leaveStart' => '<string>',
'periodAmount' => 123
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-Auth-Token: <api-key>",
"X-Org-Id: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.sandbox.flowpayroll.ai/v1/salary/employees/{employeeId}/calculate"
payload := strings.NewReader("{\n \"payrollConfigId\": \"<string>\",\n \"periodStartDate\": \"<string>\",\n \"periodEndDate\": \"<string>\",\n \"frequency\": \"<string>\",\n \"year\": 123,\n \"period\": 123,\n \"statutoryLines\": [\n {\n \"statutoryType\": \"<string>\",\n \"units\": 123,\n \"unitName\": \"<string>\",\n \"amount\": 123,\n \"id\": \"<string>\",\n \"from\": \"<string>\",\n \"to\": \"<string>\",\n \"leaveStart\": \"<string>\",\n \"periodAmount\": 123\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-Auth-Token", "<api-key>")
req.Header.Add("X-Org-Id", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.sandbox.flowpayroll.ai/v1/salary/employees/{employeeId}/calculate")
.header("X-Auth-Token", "<api-key>")
.header("X-Org-Id", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"payrollConfigId\": \"<string>\",\n \"periodStartDate\": \"<string>\",\n \"periodEndDate\": \"<string>\",\n \"frequency\": \"<string>\",\n \"year\": 123,\n \"period\": 123,\n \"statutoryLines\": [\n {\n \"statutoryType\": \"<string>\",\n \"units\": 123,\n \"unitName\": \"<string>\",\n \"amount\": 123,\n \"id\": \"<string>\",\n \"from\": \"<string>\",\n \"to\": \"<string>\",\n \"leaveStart\": \"<string>\",\n \"periodAmount\": 123\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.sandbox.flowpayroll.ai/v1/salary/employees/{employeeId}/calculate")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-Auth-Token"] = '<api-key>'
request["X-Org-Id"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"payrollConfigId\": \"<string>\",\n \"periodStartDate\": \"<string>\",\n \"periodEndDate\": \"<string>\",\n \"frequency\": \"<string>\",\n \"year\": 123,\n \"period\": 123,\n \"statutoryLines\": [\n {\n \"statutoryType\": \"<string>\",\n \"units\": 123,\n \"unitName\": \"<string>\",\n \"amount\": 123,\n \"id\": \"<string>\",\n \"from\": \"<string>\",\n \"to\": \"<string>\",\n \"leaveStart\": \"<string>\",\n \"periodAmount\": 123\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"message": {
"text": "<string>",
"token": "<string>",
"tokenArguments": [
{
"name": "<string>",
"value": null
}
]
},
"content": {
"data": {
"calculationMethod": "CalendarDays",
"source": "Default",
"lines": [
{
"lineItemId": "<string>",
"description": "<string>",
"unitName": "<string>",
"units": 123,
"payRate": 123,
"amount": 123,
"annualSalary": 123,
"effectiveFrom": "<string>",
"segmentStart": "<string>",
"segmentEnd": "<string>",
"calculationMethod": "CalendarDays",
"divisor": 123,
"kind": "Salary",
"payElementId": "<string>",
"statutoryType": "StatutorySickPay"
}
]
},
"metadata": {
"dateFormat": "<string>",
"dateTimeFormat": "<string>",
"paginationToken": "<string>"
}
},
"validationIssues": [
{
"field": "<string>",
"reason": "<string>",
"reasonToken": "<string>",
"reasonTokenArguments": [
{
"name": "<string>",
"value": null
}
]
}
]
}{
"message": {
"text": "<string>",
"token": "<string>",
"tokenArguments": [
{
"name": "<string>",
"value": null
}
]
},
"content": {
"data": null,
"metadata": {
"dateFormat": "<string>",
"dateTimeFormat": "<string>",
"paginationToken": "<string>"
}
},
"validationIssues": [
{
"field": "<string>",
"reason": "<string>",
"reasonToken": "<string>",
"reasonTokenArguments": [
{
"name": "<string>",
"value": null
}
]
}
]
}{
"message": {
"text": "<string>",
"token": "<string>",
"tokenArguments": [
{
"name": "<string>",
"value": null
}
]
},
"content": {
"data": null,
"metadata": {
"dateFormat": "<string>",
"dateTimeFormat": "<string>",
"paginationToken": "<string>"
}
},
"validationIssues": [
{
"field": "<string>",
"reason": "<string>",
"reasonToken": "<string>",
"reasonTokenArguments": [
{
"name": "<string>",
"value": null
}
]
}
]
}Authorizations
FlowPayroll JWT (raw token, no Bearer prefix)
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
Body
Runs the salary calculation for one employee and one pay period without side effects.
The payroll configuration the pay period belongs to.
1First day of the pay period, YYYY-MM-DD.
1Last day of the pay period, YYYY-MM-DD.
1Pay frequency: Weekly, Fortnightly, FourWeekly, Monthly, Quarterly, BiAnnually or Annual.
1Tax year of the pay run. Optional; with period it makes the returned line item ids match the ones the pay run receives.
Period number of the pay run. Optional; see year.
Statutory pay lines to treat as if they were on the payslip, so the salary adjustment and any top-up can be previewed. Optional.
Show child attributes
Show child attributes
Was this page helpful?
curl --request POST \
--url https://api.sandbox.flowpayroll.ai/v1/salary/employees/{employeeId}/calculate \
--header 'Content-Type: application/json' \
--header 'X-Auth-Token: <api-key>' \
--header 'X-Org-Id: <api-key>' \
--data '
{
"payrollConfigId": "<string>",
"periodStartDate": "<string>",
"periodEndDate": "<string>",
"frequency": "<string>",
"year": 123,
"period": 123,
"statutoryLines": [
{
"statutoryType": "<string>",
"units": 123,
"unitName": "<string>",
"amount": 123,
"id": "<string>",
"from": "<string>",
"to": "<string>",
"leaveStart": "<string>",
"periodAmount": 123
}
]
}
'import requests
url = "https://api.sandbox.flowpayroll.ai/v1/salary/employees/{employeeId}/calculate"
payload = {
"payrollConfigId": "<string>",
"periodStartDate": "<string>",
"periodEndDate": "<string>",
"frequency": "<string>",
"year": 123,
"period": 123,
"statutoryLines": [
{
"statutoryType": "<string>",
"units": 123,
"unitName": "<string>",
"amount": 123,
"id": "<string>",
"from": "<string>",
"to": "<string>",
"leaveStart": "<string>",
"periodAmount": 123
}
]
}
headers = {
"X-Auth-Token": "<api-key>",
"X-Org-Id": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'X-Auth-Token': '<api-key>',
'X-Org-Id': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
payrollConfigId: '<string>',
periodStartDate: '<string>',
periodEndDate: '<string>',
frequency: '<string>',
year: 123,
period: 123,
statutoryLines: [
{
statutoryType: '<string>',
units: 123,
unitName: '<string>',
amount: 123,
id: '<string>',
from: '<string>',
to: '<string>',
leaveStart: '<string>',
periodAmount: 123
}
]
})
};
fetch('https://api.sandbox.flowpayroll.ai/v1/salary/employees/{employeeId}/calculate', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.sandbox.flowpayroll.ai/v1/salary/employees/{employeeId}/calculate",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'payrollConfigId' => '<string>',
'periodStartDate' => '<string>',
'periodEndDate' => '<string>',
'frequency' => '<string>',
'year' => 123,
'period' => 123,
'statutoryLines' => [
[
'statutoryType' => '<string>',
'units' => 123,
'unitName' => '<string>',
'amount' => 123,
'id' => '<string>',
'from' => '<string>',
'to' => '<string>',
'leaveStart' => '<string>',
'periodAmount' => 123
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-Auth-Token: <api-key>",
"X-Org-Id: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.sandbox.flowpayroll.ai/v1/salary/employees/{employeeId}/calculate"
payload := strings.NewReader("{\n \"payrollConfigId\": \"<string>\",\n \"periodStartDate\": \"<string>\",\n \"periodEndDate\": \"<string>\",\n \"frequency\": \"<string>\",\n \"year\": 123,\n \"period\": 123,\n \"statutoryLines\": [\n {\n \"statutoryType\": \"<string>\",\n \"units\": 123,\n \"unitName\": \"<string>\",\n \"amount\": 123,\n \"id\": \"<string>\",\n \"from\": \"<string>\",\n \"to\": \"<string>\",\n \"leaveStart\": \"<string>\",\n \"periodAmount\": 123\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-Auth-Token", "<api-key>")
req.Header.Add("X-Org-Id", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.sandbox.flowpayroll.ai/v1/salary/employees/{employeeId}/calculate")
.header("X-Auth-Token", "<api-key>")
.header("X-Org-Id", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"payrollConfigId\": \"<string>\",\n \"periodStartDate\": \"<string>\",\n \"periodEndDate\": \"<string>\",\n \"frequency\": \"<string>\",\n \"year\": 123,\n \"period\": 123,\n \"statutoryLines\": [\n {\n \"statutoryType\": \"<string>\",\n \"units\": 123,\n \"unitName\": \"<string>\",\n \"amount\": 123,\n \"id\": \"<string>\",\n \"from\": \"<string>\",\n \"to\": \"<string>\",\n \"leaveStart\": \"<string>\",\n \"periodAmount\": 123\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.sandbox.flowpayroll.ai/v1/salary/employees/{employeeId}/calculate")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-Auth-Token"] = '<api-key>'
request["X-Org-Id"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"payrollConfigId\": \"<string>\",\n \"periodStartDate\": \"<string>\",\n \"periodEndDate\": \"<string>\",\n \"frequency\": \"<string>\",\n \"year\": 123,\n \"period\": 123,\n \"statutoryLines\": [\n {\n \"statutoryType\": \"<string>\",\n \"units\": 123,\n \"unitName\": \"<string>\",\n \"amount\": 123,\n \"id\": \"<string>\",\n \"from\": \"<string>\",\n \"to\": \"<string>\",\n \"leaveStart\": \"<string>\",\n \"periodAmount\": 123\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"message": {
"text": "<string>",
"token": "<string>",
"tokenArguments": [
{
"name": "<string>",
"value": null
}
]
},
"content": {
"data": {
"calculationMethod": "CalendarDays",
"source": "Default",
"lines": [
{
"lineItemId": "<string>",
"description": "<string>",
"unitName": "<string>",
"units": 123,
"payRate": 123,
"amount": 123,
"annualSalary": 123,
"effectiveFrom": "<string>",
"segmentStart": "<string>",
"segmentEnd": "<string>",
"calculationMethod": "CalendarDays",
"divisor": 123,
"kind": "Salary",
"payElementId": "<string>",
"statutoryType": "StatutorySickPay"
}
]
},
"metadata": {
"dateFormat": "<string>",
"dateTimeFormat": "<string>",
"paginationToken": "<string>"
}
},
"validationIssues": [
{
"field": "<string>",
"reason": "<string>",
"reasonToken": "<string>",
"reasonTokenArguments": [
{
"name": "<string>",
"value": null
}
]
}
]
}{
"message": {
"text": "<string>",
"token": "<string>",
"tokenArguments": [
{
"name": "<string>",
"value": null
}
]
},
"content": {
"data": null,
"metadata": {
"dateFormat": "<string>",
"dateTimeFormat": "<string>",
"paginationToken": "<string>"
}
},
"validationIssues": [
{
"field": "<string>",
"reason": "<string>",
"reasonToken": "<string>",
"reasonTokenArguments": [
{
"name": "<string>",
"value": null
}
]
}
]
}{
"message": {
"text": "<string>",
"token": "<string>",
"tokenArguments": [
{
"name": "<string>",
"value": null
}
]
},
"content": {
"data": null,
"metadata": {
"dateFormat": "<string>",
"dateTimeFormat": "<string>",
"paginationToken": "<string>"
}
},
"validationIssues": [
{
"field": "<string>",
"reason": "<string>",
"reasonToken": "<string>",
"reasonTokenArguments": [
{
"name": "<string>",
"value": null
}
]
}
]
}