Contract
Create a Contract π«π·
Changed onCreate a basic contract on a collaborator and return its ID. Important notes:
- Contract completion: the created contract won't be finalized, and the employee won't be available for payroll while their information is not set by an admin in the PayFit app.
- Multiple Contracts: While it is technically possible to create multiple contracts for an employee, it is strongly recommended to avoid this during the initialization phase. It will be difficult for the HR manager to identify which contract needs to be updated. We encourage implementing a control to prevent initializing a new contract if one is already in progress. If your use case requires multiple contracts, proceed with caution and ensure proper identification and management.
- Country availability: Currently, this functionality is only available for France. It will be made available for Spain and the United Kingdom in the future.
Required scopes: collaborators:contracts:write
post/companies/{companyId}/collaborators/{collaboratorId}/contracts
Request
- Base URLhttps://partner-api.payfit.com
- AuthOAuth 2Authorization codehttps://oauth.payfit.com/authorizeToken URLhttps://oauth.payfit.com/tokenScopescollaborators:contracts:write
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Path parameters
companyIdstring required
The id of the company
collaboratorIdstring uuid required
The id of the collaborator
Request body
Example request
{
"jobTitle": "Software Engineer",
"startDate": "2021-07-18"
}Response
This endpoint returns no data. The contract can take 2-5min before being available.
object required
Changes
- breaking
for the
pathrequest parametercollaboratorId, the format changed from no format touuid
- breaking