Partner API

Name: Partner API API
Brand: Partner API
Availability: InStock

★ Only Publicly Available OpenAPI DocumentHR recruitingPayrolloauth219 EndpointsREST

For 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.

Connect the Partner API to your agent

Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the Partner API, or any other public or private API you need. You set the rules, the agent never sees your credentials, and every call is logged.

Install Jentic One Beta (Self-Hosted)

Jentic One Host machine

# On the machine that will host your Jentic One instance:
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh

Agent machine

# On the machine where your agent runs (keep this separate from the instance):
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh
jentic register       # connects your agent to your Jentic One instance

Jentic One is in public beta. The setup above keeps your agent separate from the instance, which is what you want before using real credentials: an agent running as the same OS user as Jentic One can read its stored keys directly. Just evaluating? A single local install is fine to start. See the secure deployment guide for the tiers.

Capabilities

What an agent can do with Partner API API.

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

GET STARTED

Start building with Partner API API

Explore with Jentic

View OpenAPI Document

Jentic publishes the only available OpenAPI document for Partner API, keeping it validated and agent-ready.

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.

Use Cases

Patterns agents use Partner API API for, with concrete tasks.

★ 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.

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.

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.

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.

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

Key Endpoints

19 endpoints — jentic publishes the only available openapi specification for partner api, keeping it validated and agent-ready.

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

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

Why though Jentic?

Three things that make agents converge on Jentic-routed access.

Credential isolation

PayFit OAuth 2.0 tokens are stored encrypted in the Jentic vault. Agents receive scoped access tokens for specific company entities without handling authorization code flows or token refresh logic.

Intent-based discovery

Agents search by intent (e.g., 'retrieve employee payslips') and Jentic returns matching PayFit operations with their input schemas, including required path parameters like companyId and collaboratorId.

Time to first call

Direct PayFit integration: 2-4 days for OAuth setup, token management, and endpoint mapping. Through Jentic: under 1 hour — search, load schema, execute.

Related APIs

Alternatives and complements available in the Jentic catalogue.

Alternative

Gusto API

US-focused payroll and HR platform with broader employee lifecycle coverage

Choose Gusto when managing US payroll, tax filings, or benefits administration. PayFit specializes in French and European payroll compliance.

Alternative

BambooHR API

HR information system with time-off, onboarding, and performance management

Choose BambooHR for broader HR lifecycle management. PayFit is specifically focused on payroll processing and compensation data.

Alternative

Personio API

European HR platform covering recruiting, attendance, and payroll

Choose Personio for a unified European HR suite including recruiting and attendance. PayFit focuses narrowly on payroll and contract management.

Complementary

Xero Accounting API

Accounting platform that receives payroll journal entries from PayFit

Use alongside PayFit to import accounting exports into a general ledger for month-end reconciliation and financial reporting.

FAQs

Specific to using Partner API API through Jentic.

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 at https://app.jentic.com/sign-up.

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.