Get a payslip as it stood for a lock cycle

GET

payslip

data

{employeeId}

{year}

{period}

versions

{lockCycle}

Get a payslip as it stood for a lock cycle

curl --request GET \
  --url https://api.sandbox.flowpayroll.ai/v1/payslip/data/{employeeId}/{year}/{period}/versions/{lockCycle} \
  --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/{lockCycle}"

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/{lockCycle}', 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/{lockCycle}",
  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/{lockCycle}"

	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/{lockCycle}")
  .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/{lockCycle}")

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>",
      "payslip": {
        "employeeDetails": {
          "id": "EMP01JPW80Q2B7Q9RGGRY29VGC8WM",
          "name": {
            "firstName": "John",
            "lastName": "Smith",
            "title": "Mr",
            "initials": "<string>",
            "middleName": "Edward"
          },
          "email": "john.doe@example.com",
          "birthDate": "1980-01-12",
          "birthGender": "Female",
          "hoursWorkedCategory": "Above30Hours",
          "taxCode": {
            "code": "1257L",
            "effectiveDate": "2024-04-06",
            "reason": "Standard tax code",
            "issuedBy": "HMRC",
            "week1Month1": false
          },
          "nationalInsuranceCategory": "A",
          "nationalInsuranceNumber": "AB123456C",
          "starterDetails": {
            "startDate": "2024-01-15",
            "starterDeclaration": "ThisIsMyOnlyJob",
            "secondedDetails": {
              "stayStatus": "Stay183DaysOrMore",
              "eEACitizen": true,
              "ePM6": false
            },
            "alreadySentToHmrcFps": false
          },
          "isPaymentAfterLeaving": false,
          "secondaryEmail": "john.doe@example.com",
          "address": {
            "line1": "123 Main Street",
            "line2": "Apt 4B",
            "city": "London",
            "county": "Greater London",
            "postcode": "SW1A 1AA",
            "countryCode": "GB"
          },
          "payrollId": "PAY123",
          "employeeCode": "EMP001",
          "passportNumber": "123456789",
          "studentDetails": {
            "studentLoanDetails": {
              "loanType": "Plan2",
              "startDate": "2010-09-01",
              "endDate": "2025-07-31"
            },
            "postgraduateLoanDetails": {
              "loanType": "PostgraduateLoan",
              "startDate": "2015-09-01",
              "endDate": "2028-07-31"
            }
          },
          "directorDetails": {
            "directorsNICType": "Annual",
            "appointmentDate": "2024-01-15",
            "endDate": "2025-03-31"
          },
          "leaverDetails": {
            "leavingDate": "2024-12-31",
            "reason": "Retirement",
            "issuedBy": "Employer",
            "reportedToHmrc": false,
            "finalisedOnPayslip": true
          },
          "workplaceDetails": {
            "workplacePostcode": "E1 6AN"
          },
          "bankAccounts": [
            {
              "accountNumber": "12345678",
              "sortCode": "123456",
              "accountHolderName": "John Doe",
              "isPrimaryPayrollAccount": true,
              "allocationPercentage": 100
            }
          ],
          "department": "<string>",
          "jobTitle": "<string>",
          "pensionDetails": {
            "employeeId": "<string>",
            "pensionGroupId": "<string>",
            "employeePensionRate": 123,
            "employerPensionRate": 123,
            "pensionType": "NetPayArrangement",
            "nationalInsuranceSavingFactor": 123,
            "isQualifyingEarnings": true
          },
          "tags": [
            {
              "name": "FullTime",
              "group": "EmploymentType",
              "value": "FullTime"
            }
          ]
        },
        "employerDetails": {
          "id": "LOAD_TEST",
          "organisationInformation": {
            "name": {
              "legalName": "Acme Corporation Ltd",
              "tradingName": "Acme Corp"
            },
            "organisationType": "Parent",
            "companyRegistrationNumber": "12345678",
            "businessType": "LimitedCompany",
            "registredOfficeAddress": {
              "line1": "123 Main Street",
              "line2": "Apt 4B",
              "city": "London",
              "county": "Greater London",
              "postcode": "SW1A 1AA",
              "countryCode": "GB"
            },
            "correspondenceAddress": {
              "line1": "123 Main Street",
              "line2": "Apt 4B",
              "city": "London",
              "county": "Greater London",
              "postcode": "SW1A 1AA",
              "countryCode": "GB"
            },
            "companyContactDetails": {
              "name": "HR Department",
              "email": "hr@acme.com",
              "phone": "0161 123 4567"
            },
            "primaryContactDetails": {
              "name": "HR Department",
              "email": "hr@acme.com",
              "phone": "0161 123 4567"
            },
            "organisationId": "org_123",
            "createdBy": "user_123",
            "createdDate": "2025-01-01T00:00:00Z",
            "updatedBy": "user_456",
            "updatedDate": "2025-01-02T00:00:00Z"
          },
          "taxReferenceNumbers": {
            "employerPayeReference": {
              "officeNumber": "123",
              "referenceNumber": "AB12345"
            },
            "accountsOfficeReference": "123PX00123456",
            "selfAssessmentUniqueTaxpayerReference": "1234567890",
            "corporationTaxReferenceUniqueTaxpayerReference": "1234567890"
          }
        },
        "year": 2024,
        "period": 2,
        "payrollConfigId": "01JNR9P81W74HYCN35X1EEFDZE",
        "frequency": "Monthly",
        "summaryItems": [
          {
            "id": "PAYLINE-01JPW80Q2B5B76SQ2K56BZ3DHA",
            "description": "Regular Hours",
            "amount": 306,
            "type": "Employee",
            "category": "Earning",
            "payRate": 10.5,
            "payElementId": "base_salary",
            "unitName": "Hour",
            "units": 123,
            "date": "2024-02-28",
            "isNetDeduction": false,
            "canEdit": true,
            "billingStatus": "None",
            "wasReducedByProtectedEarnings": true,
            "chargeRate": 123,
            "chargeUnits": 1,
            "chargeValue": 100,
            "chargeDescription": "<string>",
            "tags": [
              {
                "name": "FullTime",
                "group": "EmploymentType",
                "value": "FullTime"
              }
            ],
            "unitType": "Amount",
            "originalValue": 123,
            "lineItemSequence": 123,
            "courtOrderId": "<string>",
            "courtOrderType": "None",
            "eligibility": {
              "courtOrders": {
                "cmsDeo": true,
                "dea": true,
                "aeoPriority": true,
                "aeoNonPriority": true,
                "ctaeo": true,
                "ea": true,
                "mcaeo": true,
                "cma": true,
                "cao": true,
                "niFinesAeo": true,
                "niEjoAeo": true
              }
            },
            "paymentDetails": {
              "accountName": "CMS Central Account",
              "accountNumber": "12345678",
              "sortCode": "12-34-56",
              "paymentReference": "CMS-2025-UK01",
              "paymentCategory": "CourtOrders"
            },
            "attachments": [
              {
                "id": "<string>",
                "lineItemId": "<string>",
                "filename": "<string>",
                "contentType": "<string>",
                "fileSize": 123,
                "uploadedDate": "2023-11-07T05:31:56Z",
                "uploadedBy": "<string>",
                "downloadUrl": "<string>",
                "downloadUrlExpiresAt": "2023-11-07T05:31:56Z"
              }
            ],
            "poNumber": "PO-2025-001",
            "clientId": "CLIENT-001",
            "invoiceId": "<string>",
            "calculationFlags": {
              "niType": "Niable",
              "payType": "Payable",
              "isPensionable": true,
              "accrueHoliday": true,
              "isClass1ANiable": true,
              "subjectToNmwCheck": true,
              "taxType": "Taxable"
            },
            "tax": 123,
            "employeeNi": 123,
            "employeePension": 123,
            "studentLoan": 123,
            "postgraduateLoan": 123,
            "employerNi": 123,
            "employerClass1ANi": 123,
            "employerPension": 123,
            "apprenticeshipLevy": 123,
            "employmentAllowance": 123,
            "apprenticeshipLevyAllowance": 123,
            "pensionSacrificeAmount": 123,
            "pensionEmployerContribution": 123,
            "pensionLineType": "Contribution",
            "ordinaryDebtDeducted": 123,
            "pensionMetadata": {
              "pensionGroupId": "<string>",
              "contributionSource": "Group",
              "basis": "<string>",
              "employerContributionType": "Percentage",
              "employerContributionValue": 123,
              "nationalInsuranceSavingsFactor": 123,
              "employerRefundAmount": 123,
              "reliefAtSourceApplied": true,
              "reliefAtSourceWithheldReason": "MissingNationalInsuranceNumber",
              "pensionType": "<string>"
            }
          }
        ],
        "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
          }
        },
        "yearToDate": {
          "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
          }
        },
        "forEmployment": {
          "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
          }
        },
        "createdDate": "2025-03-21T14:17:19.076Z",
        "createdBy": "System",
        "updatedDate": "2025-03-21T14:17:19.076Z",
        "updatedBy": "System",
        "status": "Final",
        "payslipMetadata": {
          "notes": "Additional holiday pay included for this period",
          "paymentDateOverwrite": "2024-02-28"
        },
        "payPeriodStartDate": "2024-02-01",
        "payPeriodEndDate": "2024-02-29",
        "lockCycle": 1,
        "paymentDate": "<string>",
        "lateReason": "ReasonableExcuse",
        "alerts": [
          {
            "code": "MissingBankAccount",
            "severity": "Warning",
            "context": {}
          }
        ],
        "lastEmailedAt": "2026-06-24T10:00:00.000Z",
        "lastEmailedTo": "jane.doe@example.com",
        "lastEmailedBy": "admin@example.com",
        "lastEmailedStatus": "Sent",
        "lastEmailError": "Mailbox full",
        "versionId": "01KZB4YMGGSKA1B3PFD5WJ5YFB"
      },
      "supersededReason": "<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>"
        }
      ]
    }
  ]
}

{
  "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

lockCycle

integer<int32>

required

The lock cycle the version belongs to (1 = the first lock)

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 version was retrieved successfully

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

Get a payslip as it stood for a lock cycle

curl --request GET \
  --url https://api.sandbox.flowpayroll.ai/v1/payslip/data/{employeeId}/{year}/{period}/versions/{lockCycle} \
  --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/{lockCycle}"

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/{lockCycle}', 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/{lockCycle}",
  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/{lockCycle}"

	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/{lockCycle}")
  .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/{lockCycle}")

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>",
      "payslip": {
        "employeeDetails": {
          "id": "EMP01JPW80Q2B7Q9RGGRY29VGC8WM",
          "name": {
            "firstName": "John",
            "lastName": "Smith",
            "title": "Mr",
            "initials": "<string>",
            "middleName": "Edward"
          },
          "email": "john.doe@example.com",
          "birthDate": "1980-01-12",
          "birthGender": "Female",
          "hoursWorkedCategory": "Above30Hours",
          "taxCode": {
            "code": "1257L",
            "effectiveDate": "2024-04-06",
            "reason": "Standard tax code",
            "issuedBy": "HMRC",
            "week1Month1": false
          },
          "nationalInsuranceCategory": "A",
          "nationalInsuranceNumber": "AB123456C",
          "starterDetails": {
            "startDate": "2024-01-15",
            "starterDeclaration": "ThisIsMyOnlyJob",
            "secondedDetails": {
              "stayStatus": "Stay183DaysOrMore",
              "eEACitizen": true,
              "ePM6": false
            },
            "alreadySentToHmrcFps": false
          },
          "isPaymentAfterLeaving": false,
          "secondaryEmail": "john.doe@example.com",
          "address": {
            "line1": "123 Main Street",
            "line2": "Apt 4B",
            "city": "London",
            "county": "Greater London",
            "postcode": "SW1A 1AA",
            "countryCode": "GB"
          },
          "payrollId": "PAY123",
          "employeeCode": "EMP001",
          "passportNumber": "123456789",
          "studentDetails": {
            "studentLoanDetails": {
              "loanType": "Plan2",
              "startDate": "2010-09-01",
              "endDate": "2025-07-31"
            },
            "postgraduateLoanDetails": {
              "loanType": "PostgraduateLoan",
              "startDate": "2015-09-01",
              "endDate": "2028-07-31"
            }
          },
          "directorDetails": {
            "directorsNICType": "Annual",
            "appointmentDate": "2024-01-15",
            "endDate": "2025-03-31"
          },
          "leaverDetails": {
            "leavingDate": "2024-12-31",
            "reason": "Retirement",
            "issuedBy": "Employer",
            "reportedToHmrc": false,
            "finalisedOnPayslip": true
          },
          "workplaceDetails": {
            "workplacePostcode": "E1 6AN"
          },
          "bankAccounts": [
            {
              "accountNumber": "12345678",
              "sortCode": "123456",
              "accountHolderName": "John Doe",
              "isPrimaryPayrollAccount": true,
              "allocationPercentage": 100
            }
          ],
          "department": "<string>",
          "jobTitle": "<string>",
          "pensionDetails": {
            "employeeId": "<string>",
            "pensionGroupId": "<string>",
            "employeePensionRate": 123,
            "employerPensionRate": 123,
            "pensionType": "NetPayArrangement",
            "nationalInsuranceSavingFactor": 123,
            "isQualifyingEarnings": true
          },
          "tags": [
            {
              "name": "FullTime",
              "group": "EmploymentType",
              "value": "FullTime"
            }
          ]
        },
        "employerDetails": {
          "id": "LOAD_TEST",
          "organisationInformation": {
            "name": {
              "legalName": "Acme Corporation Ltd",
              "tradingName": "Acme Corp"
            },
            "organisationType": "Parent",
            "companyRegistrationNumber": "12345678",
            "businessType": "LimitedCompany",
            "registredOfficeAddress": {
              "line1": "123 Main Street",
              "line2": "Apt 4B",
              "city": "London",
              "county": "Greater London",
              "postcode": "SW1A 1AA",
              "countryCode": "GB"
            },
            "correspondenceAddress": {
              "line1": "123 Main Street",
              "line2": "Apt 4B",
              "city": "London",
              "county": "Greater London",
              "postcode": "SW1A 1AA",
              "countryCode": "GB"
            },
            "companyContactDetails": {
              "name": "HR Department",
              "email": "hr@acme.com",
              "phone": "0161 123 4567"
            },
            "primaryContactDetails": {
              "name": "HR Department",
              "email": "hr@acme.com",
              "phone": "0161 123 4567"
            },
            "organisationId": "org_123",
            "createdBy": "user_123",
            "createdDate": "2025-01-01T00:00:00Z",
            "updatedBy": "user_456",
            "updatedDate": "2025-01-02T00:00:00Z"
          },
          "taxReferenceNumbers": {
            "employerPayeReference": {
              "officeNumber": "123",
              "referenceNumber": "AB12345"
            },
            "accountsOfficeReference": "123PX00123456",
            "selfAssessmentUniqueTaxpayerReference": "1234567890",
            "corporationTaxReferenceUniqueTaxpayerReference": "1234567890"
          }
        },
        "year": 2024,
        "period": 2,
        "payrollConfigId": "01JNR9P81W74HYCN35X1EEFDZE",
        "frequency": "Monthly",
        "summaryItems": [
          {
            "id": "PAYLINE-01JPW80Q2B5B76SQ2K56BZ3DHA",
            "description": "Regular Hours",
            "amount": 306,
            "type": "Employee",
            "category": "Earning",
            "payRate": 10.5,
            "payElementId": "base_salary",
            "unitName": "Hour",
            "units": 123,
            "date": "2024-02-28",
            "isNetDeduction": false,
            "canEdit": true,
            "billingStatus": "None",
            "wasReducedByProtectedEarnings": true,
            "chargeRate": 123,
            "chargeUnits": 1,
            "chargeValue": 100,
            "chargeDescription": "<string>",
            "tags": [
              {
                "name": "FullTime",
                "group": "EmploymentType",
                "value": "FullTime"
              }
            ],
            "unitType": "Amount",
            "originalValue": 123,
            "lineItemSequence": 123,
            "courtOrderId": "<string>",
            "courtOrderType": "None",
            "eligibility": {
              "courtOrders": {
                "cmsDeo": true,
                "dea": true,
                "aeoPriority": true,
                "aeoNonPriority": true,
                "ctaeo": true,
                "ea": true,
                "mcaeo": true,
                "cma": true,
                "cao": true,
                "niFinesAeo": true,
                "niEjoAeo": true
              }
            },
            "paymentDetails": {
              "accountName": "CMS Central Account",
              "accountNumber": "12345678",
              "sortCode": "12-34-56",
              "paymentReference": "CMS-2025-UK01",
              "paymentCategory": "CourtOrders"
            },
            "attachments": [
              {
                "id": "<string>",
                "lineItemId": "<string>",
                "filename": "<string>",
                "contentType": "<string>",
                "fileSize": 123,
                "uploadedDate": "2023-11-07T05:31:56Z",
                "uploadedBy": "<string>",
                "downloadUrl": "<string>",
                "downloadUrlExpiresAt": "2023-11-07T05:31:56Z"
              }
            ],
            "poNumber": "PO-2025-001",
            "clientId": "CLIENT-001",
            "invoiceId": "<string>",
            "calculationFlags": {
              "niType": "Niable",
              "payType": "Payable",
              "isPensionable": true,
              "accrueHoliday": true,
              "isClass1ANiable": true,
              "subjectToNmwCheck": true,
              "taxType": "Taxable"
            },
            "tax": 123,
            "employeeNi": 123,
            "employeePension": 123,
            "studentLoan": 123,
            "postgraduateLoan": 123,
            "employerNi": 123,
            "employerClass1ANi": 123,
            "employerPension": 123,
            "apprenticeshipLevy": 123,
            "employmentAllowance": 123,
            "apprenticeshipLevyAllowance": 123,
            "pensionSacrificeAmount": 123,
            "pensionEmployerContribution": 123,
            "pensionLineType": "Contribution",
            "ordinaryDebtDeducted": 123,
            "pensionMetadata": {
              "pensionGroupId": "<string>",
              "contributionSource": "Group",
              "basis": "<string>",
              "employerContributionType": "Percentage",
              "employerContributionValue": 123,
              "nationalInsuranceSavingsFactor": 123,
              "employerRefundAmount": 123,
              "reliefAtSourceApplied": true,
              "reliefAtSourceWithheldReason": "MissingNationalInsuranceNumber",
              "pensionType": "<string>"
            }
          }
        ],
        "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
          }
        },
        "yearToDate": {
          "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
          }
        },
        "forEmployment": {
          "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
          }
        },
        "createdDate": "2025-03-21T14:17:19.076Z",
        "createdBy": "System",
        "updatedDate": "2025-03-21T14:17:19.076Z",
        "updatedBy": "System",
        "status": "Final",
        "payslipMetadata": {
          "notes": "Additional holiday pay included for this period",
          "paymentDateOverwrite": "2024-02-28"
        },
        "payPeriodStartDate": "2024-02-01",
        "payPeriodEndDate": "2024-02-29",
        "lockCycle": 1,
        "paymentDate": "<string>",
        "lateReason": "ReasonableExcuse",
        "alerts": [
          {
            "code": "MissingBankAccount",
            "severity": "Warning",
            "context": {}
          }
        ],
        "lastEmailedAt": "2026-06-24T10:00:00.000Z",
        "lastEmailedTo": "jane.doe@example.com",
        "lastEmailedBy": "admin@example.com",
        "lastEmailedStatus": "Sent",
        "lastEmailError": "Mailbox full",
        "versionId": "01KZB4YMGGSKA1B3PFD5WJ5YFB"
      },
      "supersededReason": "<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>"
        }
      ]
    }
  ]
}

{
  "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

Get a payslip as it stood for a lock cycle

Authorizations

Headers

Path Parameters

Query Parameters

Response