Skip to main content
GET
/
organisation
/
balances
/
paye-liability
/
{taxYear}
Get PAYE liability summary by tax year
curl --request GET \
  --url https://api.sandbox.flowpayroll.ai/v1/organisation/balances/paye-liability/{taxYear} \
  --header 'X-Auth-Token: <api-key>'
{
  "message": {
    "text": "<string>",
    "token": "<string>",
    "tokenArguments": [
      {
        "name": "<string>",
        "value": "<string>"
      }
    ]
  },
  "content": {
    "data": {},
    "metadata": {
      "dateFormat": "yyyy-MM-dd",
      "dateTimeFormat": "yyyy-MM-ddTHH:mm:ss.fffZ",
      "paginationToken": "<string>"
    }
  },
  "validationIssues": [
    {
      "field": "<string>",
      "reason": "<string>",
      "reasonToken": "<string>",
      "reasonTokenArguments": [
        {
          "name": "<string>",
          "value": "<string>"
        }
      ]
    }
  ],
  "messageToken": "<string>",
  "data": [
    {
      "taxYear": 2024,
      "period": 5,
      "dueDate": "2024-06-22",
      "payFrequency": "Monthly",
      "liability": {
        "total": 2500,
        "apprenticeshipLevy": 100,
        "tax": 1200,
        "studentLoan": 150,
        "postgraduateLoan": 50,
        "employeeNi": 400,
        "employerNi": 500,
        "class1ANi": 50
      },
      "credits": {
        "total": 200,
        "statutoryPaymentsReclaims": {
          "SMP": {
            "reclaimed": 150,
            "nicCompensationRecovered": 50
          },
          "SSP": {
            "reclaimed": 0,
            "nicCompensationRecovered": 0
          }
        },
        "employmentAllowance": 100,
        "apprenticeshipLevyAllowance": 100
      },
      "due": 2300,
      "paid": 1500,
      "remaining": 800,
      "payments": [
        {
          "paymentReference": "PAYE_2024_001",
          "amountPaid": 1500,
          "paymentDate": "2024-05-22",
          "paymentId": "PAY_2024_001",
          "organisationId": "org_123",
          "dueDate": "2024-05-22",
          "isOnTime": true,
          "period": 5,
          "taxYear": 2024,
          "createdDate": "2024-05-22T10:00:00Z",
          "createdBy": "user_123",
          "updatedDate": "2024-05-22T10:00:00Z",
          "updatedBy": "user_123",
          "notes": "BACS payment via online banking"
        }
      ]
    }
  ]
}

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

​
taxYear
integer
required

The tax year to retrieve PAYE liability summary for

Required range: 1800 <= x <= 3000

Response

Successfully retrieved PAYE liability summary

​
message
object
​
content
object
​
validationIssues
object[]
​
messageToken
string
​
data
object[]

List of PAYE liability summaries (12 for monthly, 4 for quarterly)