Skip to main content
POST
/
payrollconfig
Create a new payroll configuration
curl --request POST \
  --url https://api.sandbox.flowpayroll.ai/v1/payrollconfig \
  --header 'Content-Type: application/json' \
  --header 'X-Auth-Token: <api-key>' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "items": [
    {
      "name": "<string>",
      "description": "<string>",
      "unitName": "<string>",
      "units": 123,
      "payRate": 123,
      "taxType": "<string>",
      "payType": "<string>",
      "billingType": "<string>",
      "id": "<string>",
      "chargeRate": 123
    }
  ],
  "tags": [
    {
      "name": "FullTime",
      "group": "EmploymentType",
      "value": "FullTime"
    }
  ],
  "paymentPeriodConfig": {
    "startingDayOfMonth": 1,
    "startingDayOfWeek": "Monday",
    "startingDayOfWeekOffSet": 0
  },
  "processZeroGrossPayslips": false,
  "includeZeroGrossPayslipsInFps": true
}
'
{
  "message": {
    "text": "<string>",
    "token": "<string>",
    "tokenArguments": [
      {
        "name": "<string>",
        "value": "<string>"
      }
    ]
  },
  "content": {
    "data": {
      "name": "<string>",
      "description": "<string>",
      "id": "<string>",
      "items": [
        {
          "name": "<string>",
          "description": "<string>",
          "unitName": "<string>",
          "units": 123,
          "payRate": 123,
          "taxType": "<string>",
          "payType": "<string>",
          "billingType": "<string>",
          "id": "<string>",
          "chargeRate": 123
        }
      ],
      "tags": [
        {
          "name": "FullTime",
          "group": "EmploymentType",
          "value": "FullTime"
        }
      ],
      "paymentDateConfig": {
        "dayOfMonth": 123,
        "weekOfMonth": 123,
        "month": 123,
        "isWorkingDay": true,
        "customRuleParams": "<string>",
        "whichWeekInPeriod": 123
      },
      "paymentPeriodConfig": {
        "startingDayOfMonth": 1,
        "startingDayOfWeek": "Monday",
        "startingDayOfWeekOffSet": 0
      },
      "processZeroGrossPayslips": false,
      "includeZeroGrossPayslipsInFps": true,
      "createdBy": "<string>",
      "createdDate": "2023-11-07T05:31:56Z",
      "updatedBy": "<string>",
      "updatedDate": "2023-11-07T05:31:56Z",
      "organisationId": "<string>"
    },
    "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>"
}

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

Body

application/json
name
string
required
description
string
required
payFrequency
enum<string>
required
Available options:
Annual,
Monthly,
FourWeekly,
Fortnightly,
Weekly,
Daily,
Quarterly,
BiAnnually
items
object[]
tags
object[]
paymentDateConfig
object
paymentPeriodConfig
object
processZeroGrossPayslips
boolean
default:false

Whether to process payslips with no line items (zero gross). Defaults to false.

includeZeroGrossPayslipsInFps
boolean
default:true

When true (default), payslips with totally-zero values (Gross, Net, Tax, Ni etc all 0) are included in FPS preview AND submission. When false, they are filtered out of both so HMRC never sees zeroed records that have no payment to report. Same flag controls preview and submit (single source of truth — no drift).

Response

Payroll Configuration Created

message
object
content
object
validationIssues
object[]
messageToken
string