Skip to main content
POST
/
organisation
/
balances
/
paye-payments
/
{taxYear}
/
period
/
{period}
Record a PAYE payment for a specific tax year and period
curl --request POST \
  --url https://api.sandbox.flowpayroll.ai/v1/organisation/balances/paye-payments/{taxYear}/period/{period} \
  --header 'Content-Type: application/json' \
  --header 'X-Auth-Token: <api-key>' \
  --data '
{
  "paymentReference": "PAYE_2024_001",
  "amountPaid": 1500,
  "paymentDate": "2024-05-22",
  "notes": "BACS payment via online banking"
}
'
{
  "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": {
    "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 for the payment

Required range: 1800 <= x <= 3000
​
period
integer
required

The period for the payment (1-12 for monthly, 1-4 for quarterly)

Required range: 1 <= x <= 12

Body

application/json

Request body for recording a PAYE payment

​
paymentReference
string
required

The payment reference used

Example:

"PAYE_2024_001"

​
amountPaid
number<decimal>
required

The amount paid to HMRC

Example:

1500

​
paymentDate
string<date>
required

The date the payment was made

Example:

"2024-05-22"

​
notes
string | null

Notes about the payment (e.g., how it was made, who made it)

Example:

"BACS payment via online banking"

Response

Successfully recorded PAYE payment

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

Response containing the recorded PAYE payment details