canonical: https://jentic.com/apis/payfit.io/payfit # PayFit Partner API Jentic publishes the only available OpenAPI specification for PayFit Partner API, keeping it validated and agent-ready. The PayFit Partner API enables third-party integrations with PayFit's payroll platform across France, Spain, and the UK. It exposes 29 endpoints for accessing company payroll data, employee contracts, payslips, accounting exports, billing declarations, and health insurance configurations through OAuth 2.0 authorization code flows. ## For AI agents Retrieve payroll data, employee contracts, payslips, and accounting exports from PayFit for companies operating in France, Spain, and the UK. ## Scope Does not handle payroll calculation, salary changes, or employee onboarding - use for reading payroll outputs, contracts, and document retrieval only. ## Capabilities - Retrieve employee contracts and contract details including time-based records - Export accounting entries and billing declarations for financial reconciliation - Download payslips and income tax documents for individual employees - Access health insurance and provident fund contract configurations - Monitor payroll processing status for a given company - Manage collaborator records and retrieve meal voucher allocations - Create employee contracts for French entities with regularization support ## Use cases ### Payroll Accounting Export Extract structured accounting entries from PayFit after each payroll run to feed into external accounting software. The API provides both v1 and v2 accounting formats, supporting journal entry creation in systems like Sage, Xero, or QuickBooks. This eliminates manual CSV exports and ensures monthly accounting closes happen without delay. Example prompt: Retrieve the v2 accounting export for company {companyId} and verify it contains entries for the current month ### Employee Document Retrieval Access payslips, income tax documents, and insurance setup sheets for individual employees or entire companies. The API supports document download by ID and listing of available documents per employee contract. Useful for employee self-service portals, audit preparation, and compliance document aggregation. Example prompt: List all payslips for collaborator {collaboratorId} in company {companyId} and download the most recent one by document ID ### Contract and Benefits Management Read and manage employee contract information including health insurance elections, provident fund configurations, and auto-enrolment documents. For French entities, the API supports contract creation and regularization submissions. This powers HR dashboards that display real-time contract and benefits status across the workforce. Example prompt: Retrieve the health insurance contract details for company {companyId} and update the health insurance configuration for French contract {contractId} ### AI Agent Payroll Data Access via Jentic AI agents use Jentic to query PayFit payroll data without implementing OAuth 2.0 authorization code flows or managing token refresh cycles. Jentic handles credential storage and provides intent-based search so agents can find operations like 'get accounting export' or 'list employee contracts' and receive ready-to-execute schemas. Example prompt: Search Jentic for 'retrieve payroll status', load the operation schema, and execute it for company {companyId} to check if this month's payroll is complete ## Key endpoints | Method | Path | Description | | --- | --- | --- | | GET | /companies/{companyId} | Retrieve company details | | GET | /companies/{companyId}/accounting-v2 | Export accounting entries (v2) | | GET | /companies/{companyId}/contracts | List all employee contracts | | GET | /companies/{companyId}/payroll-status | Check payroll processing status | | GET | /companies/{companyId}/collaborators | List collaborators | | GET | /companies/{companyId}/collaborators/{collaboratorId}/payslips | List employee payslips | | POST | /companies/{companyId}/billing-declarations | Submit billing declarations | | GET | /companies/{companyId}/health-insurance-contracts | Get health insurance contracts | ## Key resources - **Companies** — Access company-level payroll data, settings, and regional configurations - **Contracts** — Read employee contracts with time records and France-specific details - **Collaborators** — Manage employee records, payslips, and meal voucher allocations - **Accounting** — Export structured accounting entries in v1 and v2 formats - **Documents** — Download payslips, tax documents, and insurance setup sheets - **Benefits** — Access health insurance and provident fund contract details ## Why Jentic - **Setup:** Wiring PayFit by hand means running its OAuth 2.0 flow, managing scoped tokens and refresh, and paging company, contract, and payslip data yourself. Through Jentic you install once, import the PayFit Partner API from the API Directory, store the credentials once, and your agent calls it. - **Permission scoping:** PayFit puts the company and collaborator ids in the URL path (/companies/{companyId}/collaborators/{collaboratorId}/payslips), so a rule can pin your agent to one company: it can read that company's contracts and payslips and nothing else. You choose the operations it may call, so posting billing declarations is not included unless you add it. - **Credential handling:** Your PayFit OAuth client secret and refresh token are stored once, encrypted, by your own Jentic One instance and exchanged for scoped tokens at execution time. They never enter the agent's prompt, logs, or context. - **Discovery method:** Agents search Jentic by intent such as 'get an accounting export for a company' or 'retrieve a collaborator's payslips', 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 - **Paylocity API** — US-focused payroll and HCM platform with deeper employee management features - **Personio API** — European HR platform covering recruiting, attendance, and payroll preparation - **BambooHR API** — HR information system for employee records, time-off, and onboarding workflows ## FAQ ### Why is there no official OpenAPI spec for PayFit Partner API? PayFit does not publish an OpenAPI specification. Jentic generates and maintains this spec so that AI agents and developers can call PayFit 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 PayFit Partner API uses OAuth 2.0 authorization code flow. Partners redirect users to oauth.payfit.com/authorize and exchange the code at oauth.payfit.com/token. Scopes include contracts:read, accounting:read, and collaborators:read. Through Jentic, the OAuth flow and token refresh are handled automatically. ### Can I retrieve employee payslips with the PayFit Partner API? Yes. Use GET /companies/{companyId}/collaborators/{collaboratorId}/payslips to list all payslips for a specific employee. Individual payslip documents can then be downloaded using GET /companies/{companyId}/documents/{documentId} with the document ID from the payslip listing. ### What are the rate limits for the PayFit Partner API? PayFit applies rate limiting per OAuth client. The standard tier allows approximately 100 requests per minute. Monitor for 429 Too Many Requests responses and implement retry logic with backoff. Jentic manages rate limiting and retries when executing operations on your behalf. ### How do I export accounting data through the PayFit API via Jentic? Search Jentic for 'export payroll accounting entries' to find the GET /companies/{companyId}/accounting-v2 operation. Jentic returns the input schema showing the required companyId parameter. Execute through Jentic and receive structured journal entries ready for your accounting system. Install with pip install jentic. ### Does the PayFit API support multiple countries? Yes. The API serves companies in France, Spain, and the UK. French entities have additional endpoints such as /companies-fr/{companyId} for country-specific data, contract regularization, and health insurance setup sheets. General endpoints like /companies/{companyId}/contracts work across all supported countries. ### Can I limit what my agent is allowed to do with the PayFit Partner API? Yes. You run Jentic One yourself, so your own rules decide which PayFit operations and credentials the agent can use. Because PayFit puts the company and collaborator ids in the URL path, such as /companies/{companyId}/collaborators/{collaboratorId}/payslips, you can pin the agent to a single company and let it read only that company's contracts and payslips. You also choose the specific operations it may call, so a write action like POST /companies/{companyId}/billing-declarations stays off unless you add it.