Skip to main content
GET
/
payment
/
file
/
run
/
{payrollConfigId}
/
year
/
{year}
/
frequency
/
{frequency}
/
period
/
{period}
Get payment file for a pay run
curl --request GET \
  --url https://api.sandbox.flowpayroll.ai/v1/payment/file/run/{payrollConfigId}/year/{year}/frequency/{frequency}/period/{period} \
  --header 'X-Auth-Token: <api-key>'
"<unknown>"

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

​
payrollConfigId
string
required
​
year
string
required
​
frequency
string
required
​
period
string
required

Response

Payment file retrieved successfully

The response is of type any.