List the earlier versions of a payslip

GET

payslip

data

{employeeId}

{year}

{period}

versions

List the earlier versions of a payslip

curl --request GET \
  --url https://api.sandbox.flowpayroll.ai/v1/payslip/data/{employeeId}/{year}/{period}/versions \
  --header 'X-Auth-Token: <api-key>' \
  --header 'X-Org-Id: <api-key>'

import requests

url = "https://api.sandbox.flowpayroll.ai/v1/payslip/data/{employeeId}/{year}/{period}/versions"

headers = {
    "X-Auth-Token": "<api-key>",
    "X-Org-Id": "<api-key>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'X-Auth-Token': '<api-key>', 'X-Org-Id': '<api-key>'}};

fetch('https://api.sandbox.flowpayroll.ai/v1/payslip/data/{employeeId}/{year}/{period}/versions', 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/payslip/data/{employeeId}/{year}/{period}/versions",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "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"
	"net/http"
	"io"
)

func main() {

	url := "https://api.sandbox.flowpayroll.ai/v1/payslip/data/{employeeId}/{year}/{period}/versions"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-Auth-Token", "<api-key>")
	req.Header.Add("X-Org-Id", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.sandbox.flowpayroll.ai/v1/payslip/data/{employeeId}/{year}/{period}/versions")
  .header("X-Auth-Token", "<api-key>")
  .header("X-Org-Id", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.sandbox.flowpayroll.ai/v1/payslip/data/{employeeId}/{year}/{period}/versions")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-Auth-Token"] = '<api-key>'
request["X-Org-Id"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "message": {
    "text": "<string>",
    "token": "<string>",
    "tokenArguments": [
      {
        "name": "<string>",
        "value": "<unknown>"
      }
    ]
  },
  "content": {
    "metadata": {
      "dateFormat": "<string>",
      "dateTimeFormat": "<string>",
      "paginationToken": "<string>"
    },
    "data": [
      {
        "lockCycle": 123,
        "supersededAt": "<string>",
        "supersededBy": "<string>",
        "status": "Preview",
        "gross": 123,
        "net": 123,
        "tax": 123,
        "forPeriod": {
          "gross": 306,
          "grossTaxable": 306,
          "grossNi": 306,
          "grossForEmployerNi": 306,
          "grossForEmployerClass1ANi": 306,
          "grossPensionable": 306,
          "grossForCourtOrders": 306,
          "tax": 45.2,
          "ni": 25.3,
          "pension": 0,
          "employerNi": 35.4,
          "employerClass1ANI": 35.4,
          "employerPension": 0,
          "studentLoan": 0,
          "postgraduateLoan": 0,
          "net": 235.5,
          "netDeductions": 0,
          "totalPayable": 235.5,
          "totalEmployerCost": 306,
          "niBand": {},
          "statutory": {
            "SSP": 0,
            "SMP": 0
          },
          "pensionContributionsByType": {
            "NetPayArrangement": 0,
            "ReliefAtSource": 0,
            "SalarySacrifice": 0
          },
          "qualifyingEarningsForPension": 0,
          "apprenticeshipLevy": 1.53,
          "employmentAllowance": 0,
          "apprenticeshipLevyAllowance": 0,
          "statutoryRecovery": {
            "StatutoryMaternityPay": {
              "reclaimed": 100,
              "nicCompensationRecovered": 8.5
            }
          },
          "isEmpty": false,
          "pensionRefundsByType": {
            "ReliefAtSource": 146.76
          },
          "employerPensionRefundsByType": {
            "ReliefAtSource": 110.07
          }
        },
        "updatedDate": "<string>",
        "supersededReason": "<string>",
        "versionId": "<string>"
      }
    ]
  },
  "validationIssues": [
    {
      "field": "<string>",
      "reason": "<string>",
      "reasonToken": "<string>",
      "reasonTokenArguments": [
        {
          "name": "<string>",
          "value": "<unknown>"
        }
      ]
    }
  ]
}

{
  "message": {
    "text": "<string>",
    "token": "<string>",
    "tokenArguments": [
      {
        "name": "<string>",
        "value": "<unknown>"
      }
    ]
  },
  "content": {
    "metadata": {
      "dateFormat": "<string>",
      "dateTimeFormat": "<string>",
      "paginationToken": "<string>"
    },
    "data": "<unknown>"
  },
  "validationIssues": [
    {
      "field": "<string>",
      "reason": "<string>",
      "reasonToken": "<string>",
      "reasonTokenArguments": [
        {
          "name": "<string>",
          "value": "<unknown>"
        }
      ]
    }
  ]
}

{
  "message": {
    "text": "<string>",
    "token": "<string>",
    "tokenArguments": [
      {
        "name": "<string>",
        "value": "<unknown>"
      }
    ]
  },
  "content": {
    "metadata": {
      "dateFormat": "<string>",
      "dateTimeFormat": "<string>",
      "paginationToken": "<string>"
    },
    "data": "<unknown>"
  },
  "validationIssues": [
    {
      "field": "<string>",
      "reason": "<string>",
      "reasonToken": "<string>",
      "reasonTokenArguments": [
        {
          "name": "<string>",
          "value": "<unknown>"
        }
      ]
    }
  ]
}

{
  "message": {
    "text": "<string>",
    "token": "<string>",
    "tokenArguments": [
      {
        "name": "<string>",
        "value": "<unknown>"
      }
    ]
  },
  "content": {
    "metadata": {
      "dateFormat": "<string>",
      "dateTimeFormat": "<string>",
      "paginationToken": "<string>"
    },
    "data": "<unknown>"
  },
  "validationIssues": [
    {
      "field": "<string>",
      "reason": "<string>",
      "reasonToken": "<string>",
      "reasonTokenArguments": [
        {
          "name": "<string>",
          "value": "<unknown>"
        }
      ]
    }
  ]
}

{
  "message": {
    "text": "<string>",
    "token": "<string>",
    "tokenArguments": [
      {
        "name": "<string>",
        "value": "<unknown>"
      }
    ]
  },
  "content": {
    "metadata": {
      "dateFormat": "<string>",
      "dateTimeFormat": "<string>",
      "paginationToken": "<string>"
    },
    "data": "<unknown>"
  },
  "validationIssues": [
    {
      "field": "<string>",
      "reason": "<string>",
      "reasonToken": "<string>",
      "reasonTokenArguments": [
        {
          "name": "<string>",
          "value": "<unknown>"
        }
      ]
    }
  ]
}

{
  "message": {
    "text": "<string>",
    "token": "<string>",
    "tokenArguments": [
      {
        "name": "<string>",
        "value": "<unknown>"
      }
    ]
  },
  "content": {
    "metadata": {
      "dateFormat": "<string>",
      "dateTimeFormat": "<string>",
      "paginationToken": "<string>"
    },
    "data": "<unknown>"
  },
  "validationIssues": [
    {
      "field": "<string>",
      "reason": "<string>",
      "reasonToken": "<string>",
      "reasonTokenArguments": [
        {
          "name": "<string>",
          "value": "<unknown>"
        }
      ]
    }
  ]
}

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).

Headers

Request-Id

string

Optional. Your id for this request: it is carried into every log line about it, so quote it when you contact support.

Path Parameters

year

integer<int32>

required

Year of the payslip

period

integer<int32>

required

Pay period number within the year

employeeId

string

required

ID of the employee

Query Parameters

frequency

enum<string>

Optional payment frequency override. When provided, overrides the frequency from the employee's payroll config.

Available options:

Annual,

Monthly,

FourWeekly,

Fortnightly,

Weekly,

Daily,

Quarterly,

BiAnnually

Response

The payslip versions were retrieved successfully; empty when the pay run was never unlocked

message

object

required

A readable message about the outcome and a stable token a client can branch on.

Show child attributes

content

object

The data the request returns with its metadata; left out on a response that carries no data, such as most errors.

Show child attributes

validationIssues

object[] | null

Each field the request was refused for and why; left out when the request was not refused for its fields.

Show child attributes

List the earlier versions of a payslip

curl --request GET \
  --url https://api.sandbox.flowpayroll.ai/v1/payslip/data/{employeeId}/{year}/{period}/versions \
  --header 'X-Auth-Token: <api-key>' \
  --header 'X-Org-Id: <api-key>'

import requests

url = "https://api.sandbox.flowpayroll.ai/v1/payslip/data/{employeeId}/{year}/{period}/versions"

headers = {
    "X-Auth-Token": "<api-key>",
    "X-Org-Id": "<api-key>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'X-Auth-Token': '<api-key>', 'X-Org-Id': '<api-key>'}};

fetch('https://api.sandbox.flowpayroll.ai/v1/payslip/data/{employeeId}/{year}/{period}/versions', 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/payslip/data/{employeeId}/{year}/{period}/versions",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "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"
	"net/http"
	"io"
)

func main() {

	url := "https://api.sandbox.flowpayroll.ai/v1/payslip/data/{employeeId}/{year}/{period}/versions"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-Auth-Token", "<api-key>")
	req.Header.Add("X-Org-Id", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.sandbox.flowpayroll.ai/v1/payslip/data/{employeeId}/{year}/{period}/versions")
  .header("X-Auth-Token", "<api-key>")
  .header("X-Org-Id", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.sandbox.flowpayroll.ai/v1/payslip/data/{employeeId}/{year}/{period}/versions")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-Auth-Token"] = '<api-key>'
request["X-Org-Id"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "message": {
    "text": "<string>",
    "token": "<string>",
    "tokenArguments": [
      {
        "name": "<string>",
        "value": "<unknown>"
      }
    ]
  },
  "content": {
    "metadata": {
      "dateFormat": "<string>",
      "dateTimeFormat": "<string>",
      "paginationToken": "<string>"
    },
    "data": [
      {
        "lockCycle": 123,
        "supersededAt": "<string>",
        "supersededBy": "<string>",
        "status": "Preview",
        "gross": 123,
        "net": 123,
        "tax": 123,
        "forPeriod": {
          "gross": 306,
          "grossTaxable": 306,
          "grossNi": 306,
          "grossForEmployerNi": 306,
          "grossForEmployerClass1ANi": 306,
          "grossPensionable": 306,
          "grossForCourtOrders": 306,
          "tax": 45.2,
          "ni": 25.3,
          "pension": 0,
          "employerNi": 35.4,
          "employerClass1ANI": 35.4,
          "employerPension": 0,
          "studentLoan": 0,
          "postgraduateLoan": 0,
          "net": 235.5,
          "netDeductions": 0,
          "totalPayable": 235.5,
          "totalEmployerCost": 306,
          "niBand": {},
          "statutory": {
            "SSP": 0,
            "SMP": 0
          },
          "pensionContributionsByType": {
            "NetPayArrangement": 0,
            "ReliefAtSource": 0,
            "SalarySacrifice": 0
          },
          "qualifyingEarningsForPension": 0,
          "apprenticeshipLevy": 1.53,
          "employmentAllowance": 0,
          "apprenticeshipLevyAllowance": 0,
          "statutoryRecovery": {
            "StatutoryMaternityPay": {
              "reclaimed": 100,
              "nicCompensationRecovered": 8.5
            }
          },
          "isEmpty": false,
          "pensionRefundsByType": {
            "ReliefAtSource": 146.76
          },
          "employerPensionRefundsByType": {
            "ReliefAtSource": 110.07
          }
        },
        "updatedDate": "<string>",
        "supersededReason": "<string>",
        "versionId": "<string>"
      }
    ]
  },
  "validationIssues": [
    {
      "field": "<string>",
      "reason": "<string>",
      "reasonToken": "<string>",
      "reasonTokenArguments": [
        {
          "name": "<string>",
          "value": "<unknown>"
        }
      ]
    }
  ]
}

{
  "message": {
    "text": "<string>",
    "token": "<string>",
    "tokenArguments": [
      {
        "name": "<string>",
        "value": "<unknown>"
      }
    ]
  },
  "content": {
    "metadata": {
      "dateFormat": "<string>",
      "dateTimeFormat": "<string>",
      "paginationToken": "<string>"
    },
    "data": "<unknown>"
  },
  "validationIssues": [
    {
      "field": "<string>",
      "reason": "<string>",
      "reasonToken": "<string>",
      "reasonTokenArguments": [
        {
          "name": "<string>",
          "value": "<unknown>"
        }
      ]
    }
  ]
}

{
  "message": {
    "text": "<string>",
    "token": "<string>",
    "tokenArguments": [
      {
        "name": "<string>",
        "value": "<unknown>"
      }
    ]
  },
  "content": {
    "metadata": {
      "dateFormat": "<string>",
      "dateTimeFormat": "<string>",
      "paginationToken": "<string>"
    },
    "data": "<unknown>"
  },
  "validationIssues": [
    {
      "field": "<string>",
      "reason": "<string>",
      "reasonToken": "<string>",
      "reasonTokenArguments": [
        {
          "name": "<string>",
          "value": "<unknown>"
        }
      ]
    }
  ]
}

{
  "message": {
    "text": "<string>",
    "token": "<string>",
    "tokenArguments": [
      {
        "name": "<string>",
        "value": "<unknown>"
      }
    ]
  },
  "content": {
    "metadata": {
      "dateFormat": "<string>",
      "dateTimeFormat": "<string>",
      "paginationToken": "<string>"
    },
    "data": "<unknown>"
  },
  "validationIssues": [
    {
      "field": "<string>",
      "reason": "<string>",
      "reasonToken": "<string>",
      "reasonTokenArguments": [
        {
          "name": "<string>",
          "value": "<unknown>"
        }
      ]
    }
  ]
}

{
  "message": {
    "text": "<string>",
    "token": "<string>",
    "tokenArguments": [
      {
        "name": "<string>",
        "value": "<unknown>"
      }
    ]
  },
  "content": {
    "metadata": {
      "dateFormat": "<string>",
      "dateTimeFormat": "<string>",
      "paginationToken": "<string>"
    },
    "data": "<unknown>"
  },
  "validationIssues": [
    {
      "field": "<string>",
      "reason": "<string>",
      "reasonToken": "<string>",
      "reasonTokenArguments": [
        {
          "name": "<string>",
          "value": "<unknown>"
        }
      ]
    }
  ]
}

{
  "message": {
    "text": "<string>",
    "token": "<string>",
    "tokenArguments": [
      {
        "name": "<string>",
        "value": "<unknown>"
      }
    ]
  },
  "content": {
    "metadata": {
      "dateFormat": "<string>",
      "dateTimeFormat": "<string>",
      "paginationToken": "<string>"
    },
    "data": "<unknown>"
  },
  "validationIssues": [
    {
      "field": "<string>",
      "reason": "<string>",
      "reasonToken": "<string>",
      "reasonTokenArguments": [
        {
          "name": "<string>",
          "value": "<unknown>"
        }
      ]
    }
  ]
}

Overview

Administration API

Email Wording API

Authentication API

Billing

Court orders

HMRC DPS

HMRC P-forms

Holiday & leave

Integrations

Pay API

Payment

Payroll journals

Pensions

Recurring line items

Reports

Salary

Statutory pay

Webhooks

List the earlier versions of a payslip

Authorizations

Headers

Path Parameters

Query Parameters

Response