> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stackone.com/llms.txt
> Use this file to discover all available pages before exploring further.

# PayFit

> How to set up the PayFit connector, plus the actions that are available.

![PayFit](https://stackone-logos.com/api/payfit/filled/svg)

v2.0.0[See changelog](https://docs.stackone.com/connectors/payfit/changelog.md)

[23 actions](#actions) · 2 auth methods

HRIS

## Getting Started

**1. Create or Select a Project**

Set up a new project or select an existing one. See [Organizations & Projects](https://docs.stackone.com/gateway/concepts/organizations-and-projects.md).

**2. Configure the Connector**

Enable the connector and create a Connector Profile in your project. See [Setup Connector Profile](https://docs.stackone.com/gateway/quickstart.md#setup-connector-profile).

> [card] [API Key · Connector Profile](https://docs.stackone.com/connectors/payfit/guides/connector-profile/api-key.md)
>
> Uses an API key that an admin generates in the PayFit dashboard. The scopes selected when the key is created determine w\...

> [card] [OAuth 2.0 · Connector Profile](https://docs.stackone.com/connectors/payfit/guides/connector-profile/oauth-2-0.md)
>
> Requires PayFit partner credentials (Client ID and Client Secret). Access is limited to the company of the admin who aut...

**3. Link an Account**

Link an account [from the dashboard](https://docs.stackone.com/connect/managing-connectors/linking-accounts.md#link-from-the-dashboard) (or via [StackOne Hub](https://docs.stackone.com/embed/account-linking/overview)).

See the guide for the authentication type chosen in the Connector Profile:

> [card] [API Key · Link Account](https://docs.stackone.com/connectors/payfit/guides/link-account/api-key.md)

> [card] [OAuth 2.0 · Link Account](https://docs.stackone.com/connectors/payfit/guides/link-account/oauth-2-0.md)

**4. Use Actions**

Connect an AI platform to the linked account's actions. See [AI Platforms](https://docs.stackone.com/ai-platforms/overview.md).

Other ways to call actions are listed in [Protocols & SDKs](https://docs.stackone.com/connect/protocols-and-sdks.md).

## Actions

Scopes

Select all
|
Clear

accounting:read

collaborators:contracts:write

collaborators:meal-vouchers:read

collaborators:read

collaborators:write

contracts:payslips:read

contracts:read

health-insurance:read

health-insurance:write

payment-files:read

pension:read

time:read

No scopes found

23 actions

ActionDescriptionRequired scopes

Get Company`payfit_get_company`

Retrieve company information including legal name, SIREN, country, and onboarding status.

Get Company (France)`payfit_get_company_fr`

Retrieve French-specific company information including SIREN, SIRET, address, city, postalCode, and healthInsuranceProra...

List Health Insurance Contracts`payfit_list_health_insurance_contracts`

Retrieve all health insurance contracts for the company. Only available for French companies.

`health-insurance:read`

Update Health Insurance Affiliation`payfit_update_health_insurance_affiliation`

Update health insurance affiliation for an employee contract. To affiliate a plan, call list\_health\_insurance\_contracts...

`health-insurance:write`

List Provident Fund Contracts`payfit_list_provident_fund_contracts`

Retrieve all provident fund (prévoyance) contracts for the company. Only available for French companies.

`health-insurance:read`

Update Provident Fund Affiliation`payfit_update_provident_fund_affiliation`

Update provident fund (prévoyance) affiliation for an employee contract. Call list\_provident\_fund\_contracts and pass the...

`health-insurance:write`

List Worked Time`payfit_list_worked_time`

Retrieve worked time for all contracts for a given pay period. Returns hours worked, overtime, and absence details. Only...

`time:read`

List Collaborators`payfit_list_collaborators`

Retrieve all collaborators (employees) for a company including personal info, contracts, and contact details.

`collaborators:read`

Get Collaborator`payfit_get_collaborator`

Retrieve detailed information for a specific collaborator by ID including personal data, contracts, and contact info.

`collaborators:read`

Create Collaborator`payfit_create_collaborator`

Create a new collaborator (employee) and return their ID. The collaborator won't have a contract initially and won't app...

`collaborators:write`

List Collaborator Payslips`payfit_list_collaborator_payslips`

Retrieve all payslips for a specific collaborator by their ID.

`contracts:payslips:read`

Get Collaborator Payslip`payfit_get_collaborator_payslip`

Retrieve a specific payslip document for a collaborator by payslip ID.

`contracts:payslips:read`

List Collaborators Meal Vouchers`payfit_list_collaborators_meal_vouchers`

Retrieve meal voucher data for all collaborators for a given month. Only available for French companies.

`collaborators:meal-vouchers:read`

List Contracts`payfit_list_contracts`

Retrieve all employment contracts for a company including job details, status, and working hours.

`contracts:read`

Get Contract`payfit_get_contract`

Retrieve detailed information for a specific employment contract by ID.

`contracts:read`

Create Contract`payfit_create_contract`

Create a basic employment contract for a collaborator. PayFit does not return the new contract ID in the create response...

`collaborators:contracts:write`

Get Payroll Status`payfit_get_payroll_status`

Retrieve the payroll processing status for a specific month, indicating if payroll is completed.

Get Accounting Data V2`payfit_get_accounting_v2`

Retrieve accounting data for a given month in JSON format. Available for FR and UK companies. Returns detailed entries w\...

`accounting:read`

Get Payment File`payfit_get_payment_file`

Retrieve the payment file (SEPA/bank transfer file) for a given month for payroll payment processing.

`payment-files:read`

List Income Taxes Documents`payfit_list_income_taxes_documents`

Retrieve all income taxes documents (P45, P60, P11D) for UK companies. Returns document metadata with download URLs.

`contracts:payslips:read`

List Auto Enrolment Documents`payfit_list_auto_enrolment_documents`

Retrieve all auto enrolment (pension) documents for UK companies. Returns pension-related document metadata.

`pension:read`

Get Company Document`payfit_get_company_document`

Download a specific company document by its ID. Use document IDs from income taxes or auto enrolment document lists.

`contracts:payslips:read``pension:read`

List Absences`payfit_list_absences`

Retrieve a paginated list of absences for the company. By default, only approved absences are returned.

`time:read`


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.