canonical: https://jentic.com/apis/partner-api.payfit.com/payfit

# Partner Api Payfit Partner API

Jentic publishes the only available OpenAPI specification for Partner API, keeping it validated and agent-ready. The PayFit Partner API provides programmatic access to company payroll data, employee contracts, collaborator records, and accounting exports for French and international entities. It exposes 19 endpoints covering payslip retrieval, contract management, health insurance configuration, provident fund setup, and meal voucher data across multi-entity company structures.

## For AI agents

Retrieve payroll status, employee contracts, payslips, and accounting data from PayFit company entities. Supports French-specific contract details including health insurance and provident fund configuration.

## Scope

Does not handle recruiting, time-off requests, or performance reviews - use for payroll data, contracts, and accounting exports only.

## Capabilities

- Retrieve payslips and payroll status for any company entity
- Access collaborator records with meal voucher entitlements
- Export accounting data in standard and v2 formats for reconciliation
- Manage health insurance contract assignments on French employee contracts
- Configure provident fund allocations per contract
- Query contract time tracking data across company entities
- Retrieve France-specific contract details including social security classifications

## Use cases

### Payroll Accounting Export

Export structured accounting entries from PayFit for automatic reconciliation with external accounting systems. The Partner API provides both standard and v2 accounting formats covering salary costs, employer contributions, and benefit allocations. Each export maps to a specific payroll period and company entity, enabling month-end close automation without manual data entry.

Example prompt: Retrieve accounting-v2 data for company entity ID abc123 and map journal entries to the current payroll period

### Employee Payslip Retrieval

Access individual payslips for any collaborator through the Partner API by specifying company, collaborator, contract, and payslip identifiers. This supports automated payslip distribution, employee self-service portals, and audit compliance workflows. Each payslip contains gross pay, deductions, net pay, and benefit line items tied to the specific contract period.

Example prompt: Retrieve the payslip for collaborator col456 under contract ctr789 for the most recent payroll period in company comp123

### French Contract Benefits Management

Configure health insurance and provident fund allocations on French employment contracts through dedicated PUT endpoints. The API accepts contract-level benefit assignments that map to the French social security system, enabling HR platforms to synchronize benefit elections without manual entry in the PayFit interface. Changes take effect on the next payroll cycle.

Example prompt: Update the health insurance contract assignment for French contract ctr789 in company comp123 with the new mutuelle provider details

### AI Agent Payroll Data Integration

AI agents connect to the PayFit Partner API through Jentic to retrieve payroll, contract, and accounting data without managing OAuth2 token flows directly. Jentic handles credential isolation and token refresh, letting agents query payroll status or export accounting entries by searching for the relevant operation and executing it with scoped access. This reduces integration from days of OAuth implementation to minutes of intent-based discovery.

Example prompt: Search Jentic for 'retrieve payroll status' operation, load the schema for the PayFit payroll-status endpoint, and execute it for company comp123

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| GET | /companies/{companyId}/collaborators | List all collaborators in a company |
| GET | /companies/{companyId}/collaborators/{collaboratorId}/contracts/{contractId}/payslips/{payslipId} | Retrieve a specific payslip |
| GET | /companies/{companyId}/accounting-v2 | Export v2 accounting data |
| GET | /companies/{companyId}/payroll-status | Check current payroll processing status |
| GET | /companies/{companyId}/contracts | List all employment contracts |
| PUT | /companies/{companyId}/contracts-fr/{contractId}/health-insurance | Update health insurance on a French contract |

## Key resources

- **Companies** — Retrieve company-level details including French-specific entity data
- **Collaborators** — Access employee records and meal voucher entitlements
- **Contracts** — Query employment contracts with time tracking, health insurance, and provident fund data
- **Payslips** — Retrieve individual payslip documents by collaborator and contract
- **Accounting** — Export payroll accounting data in standard and v2 formats

## Why Jentic

- **Setup:** Wiring the PayFit Partner API by hand means implementing its OAuth2 flow with token refresh, setting the partner-api.payfit.com host, and threading company and contract path parameters through every call yourself. Through Jentic you install once, import the PayFit Partner API from the API Directory, store the credential once, and your agent calls it.
- **Permission scoping:** PayFit puts the company id in the URL path (/companies/{companyId}/...), so a rule can pin your agent to one company: it can read collaborators, contracts, payslips, and accounting there. You choose the operations it may call, so writes like updating a contract's health insurance are not included unless you add them.
- **Credential handling:** Your PayFit OAuth credential is stored once, encrypted, by your own Jentic One instance and injected at execution time. It never enters the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'retrieve a collaborator's payslip' or 'export company accounting', and Jentic returns the matching PayFit operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Gusto API** — US-focused payroll and HR platform with broader employee lifecycle coverage
- **BambooHR API** — HR information system with time-off, onboarding, and performance management
- **Personio API** — European HR platform covering recruiting, attendance, and payroll
- **Xero Accounting API** — Accounting platform that receives payroll journal entries from PayFit

## FAQ

### Why is there no official OpenAPI spec for Partner API?

PayFit does not publish an OpenAPI specification. Jentic generates and maintains this spec so that AI agents and developers can call Partner API via structured tooling. It is validated against the live API and kept up to date. Get started with Jentic One, the self-hosted execution layer.

### What authentication does the PayFit Partner API use?

The Partner API uses OAuth 2.0 authentication. Through Jentic, OAuth tokens are stored encrypted in the credential vault and agents receive scoped access tokens without handling the OAuth flow directly.

### Can I retrieve individual payslips through the Partner API?

Yes. The GET endpoint at /companies/{companyId}/collaborators/{collaboratorId}/contracts/{contractId}/payslips/{payslipId} returns a specific payslip. You need the company, collaborator, contract, and payslip identifiers to make the request.

### What accounting formats does the Partner API support?

The API provides two accounting export endpoints: /companies/{companyId}/accounting for the standard format and /companies/{companyId}/accounting-v2 for the enhanced v2 format. Both return structured payroll journal entries for a given company entity.

### How do I configure health insurance on a French contract through Jentic?

Search Jentic for 'update health insurance contract' to find the PUT /companies/{companyId}/contracts-fr/{contractId}/health-insurance operation. Load the schema to see required fields, then execute with your contract and benefit provider details. Run pip install jentic to get started.

### Are there rate limits on the PayFit Partner API?

The OpenAPI spec does not document specific rate limits. As a partner-tier API requiring OAuth2 credentials, access is governed by your partner agreement with PayFit. Contact PayFit partner support for your specific allocation.

### Can I limit what my agent is allowed to do with the PayFit Partner API?

Yes. Because you run Jentic One yourself, your own rules decide which PayFit operations and credentials the agent may use. Since the company id sits in the URL path, you can pin the agent to a single company and allow only read operations there, such as listing collaborators and contracts, retrieving payslips, and exporting accounting data. Write operations like updating a contract's health insurance stay off limits unless you explicitly add them.