PayFit Create
CertifiedInitialize a PayFit contract
PayFit Create
Initialize a PayFit contract
Calls POST /companies/{companyId}/collaborators/{collaboratorId}/contracts. Currently available for French companies only. PayFit returns 201 with an empty body, and the contract can take 2 to 5 minutes before it can be read. The contract is not finalized until an administrator completes it in PayFit. Requires the collaborators: contracts: write scope.
type: io.kestra.plugin.payfit.contracts.CreateExamples
Initialize a contract for a new collaborator
id: payfit_create_contract
namespace: company.team
tasks:
- id: contract
type: io.kestra.plugin.payfit.contracts.Create
apiKey: "{{ secret('PAYFIT_API_KEY') }}"
collaboratorId: "{{ outputs.create.id }}"
jobTitle: "Software Engineer"
startDate: "2026-01-06"
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.
collaboratorId *string
Collaborator id returned by collaborators.Create
jobTitle *string
Job title
startDate *string
Contract start date, as YYYY-MM-DD
baseUrl 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
body object
Raw PayFit response
id string
Created contract id when PayFit returns one. The current API returns an empty 201 body
