PayFit GetPayrollStatus
CertifiedGet PayFit payroll status
PayFit GetPayrollStatus
Get PayFit payroll status
Fetches GET /companies/{companyId}/payroll-status?date=YYYYMM. Returns the payroll status (completed or not_completed) and execution end timestamp for a given pay period. No scope is required beyond a valid company token.
type: io.kestra.plugin.payfit.company.GetPayrollStatusExamples
Check whether a payroll period has completed
id: payfit_payroll_status
namespace: company.team
tasks:
- id: status
type: io.kestra.plugin.payfit.company.GetPayrollStatus
apiKey: "{{ secret('PAYFIT_API_KEY') }}"
date: "202610"
Properties
apiKey *string
API key
PayFit API key or OAuth access token, sent as a bearer token. Create a customer key in the PayFit app under Integrations > API Access, or use the access token returned by auth.AccessToken. Store this value in a Kestra secret.
date *string
Payroll period in YYYYMM format
assets
Assets this task consumes as inputs or produces as outputs, for lineage tracking and the asset graph (Enterprise Edition). A flow declaring this property on a task is rejected in the open-source edition.
io.kestra.core.models.assets.AssetsDeclaration
IGNOREFAILWARNAsset failure behavior
Behavior applied to the task state when a declared asset fails to render, emit, or be persisted (e.g. a lock conflict): FAIL escalates it to FAILED, WARN (default) warns it if it would otherwise succeed, IGNORE leaves the state untouched.
Whether to auto-register assets referenced dynamically at runtime that are not statically declared in inputs or outputs.
The assets consumed as inputs.
io.kestra.core.models.assets.AssetIdentifier
1The assets produced as outputs.
io.kestra.plugin.ee.assets.Dataset
1150{}1150io.kestra.plugin.ee.assets.File
1150{}1150io.kestra.plugin.ee.assets.Table
1150{}1150io.kestra.plugin.ee.assets.VM
1150{}1150io.kestra.core.models.assets.External
1150{}1150io.kestra.core.models.assets.Custom
11501Custom asset type
{}1150baseUrl string
https://partner-api.payfit.comPartner API base URL
Base URL of the PayFit Partner API. Defaults to https://partner-api.payfit.com.
companyId string
Company ID
PayFit company identifier used in /companies/{companyId} paths. When omitted, the task calls POST https://oauth.payfit.com/introspect and uses company_id from the token.
oauthUrl string
https://oauth.payfit.comOAuth base URL
Base URL used for token introspection and authorization-code exchange. Defaults to https://oauth.payfit.com.
options
HTTP client options
Optional HTTP client configuration applied to PayFit requests.
io.kestra.core.http.client.configurations.HttpConfiguration
falseIf true, allow a failed response code (response code >= 400)
List of response code allowed for this request
The authentication to use.
io.kestra.core.http.client.configurations.BasicAuthConfiguration
The password for HTTP basic authentication.
The username for HTTP basic authentication.
io.kestra.core.http.client.configurations.BearerAuthConfiguration
The token for bearer token authentication.
io.kestra.core.http.client.configurations.DigestAuthConfiguration
The password for HTTP Digest authentication.
The username for HTTP Digest authentication.
UTF-8The default charset for the request.
java.nio.charset.Charset
trueWhether to enable TCP Keep-Alive extended socket options (TCP_KEEPIDLE, TCP_KEEPINTERVAL, TCP_KEEPCOUNT).
Set to false when running on Windows workers, as these extended socket options are not supported by the Windows JDK and will cause connection failures.
trueWhether redirects should be followed automatically.
REQUEST_HEADERSREQUEST_BODYRESPONSE_HEADERSRESPONSE_BODYThe enabled log.
The proxy configuration.
io.kestra.core.http.client.configurations.ProxyConfiguration
The address of the proxy server.
The password for proxy authentication.
The port of the proxy server.
DIRECTDIRECTHTTPSOCKSThe type of proxy to use.
The username for proxy authentication.
The SSL request options
io.kestra.core.http.client.configurations.SslOptions
Whether to disable checking of the remote SSL certificate.
Only applies if no trust store is configured. Note: This makes the SSL connection insecure and should only be used for testing. If you are using a self-signed certificate, set up a trust store instead.
The timeout configuration.
io.kestra.core.http.client.configurations.TimeoutConfiguration
The time allowed to establish a connection to the server before failing.
PT5MThe time allowed for a read connection to remain idle before closing it.
Outputs
completed boolean
falseWhether the payroll for the given period is completed
Convenience boolean flag indicating whether status is completed.
executionEndDate string
date-timeExecution end timestamp of the payroll run for the period, if available
Execution end timestamp in UTC, null while the payroll is not completed.
payrollStatus
Payroll status payload returned by PayFit
io.kestra.plugin.payfit.model.PayrollStatus
Execution end date
ISO-8601 timestamp, null while the payroll is not completed.
Payroll status
Either completed or not_completed.
status string
Payroll status (completed or not_completed)
Either completed or not_completed.
