--- updatedAt: 2026-06-29T09:41:37.000Z agentTools: projectIndex: https://developers.payfit.io/llms.txt --- # Get a contract 🇫🇷 Returns a contract information by ID with french specific data. \ **Required scopes**: *contracts:read* # OpenAPI definition ```json { "openapi": "3.0.0", "info": { "title": "Partner API", "description": "An API to let third parties communicate with PayFit", "version": "1.0" }, "servers": [ { "url": "https://partner-api.payfit.com", "description": "The PayFit API production server" } ], "paths": { "/companies/{companyId}/contracts-fr/{contractId}": { "get": { "operationId": "GET_contract_fr", "summary": "Get a contract 🇫🇷", "description": "Returns a contract information by ID with french specific data.\n\\\n**Required scopes**: *contracts:read*", "tags": [ "Contract" ], "parameters": [ { "in": "path", "name": "companyId", "schema": { "type": "string" }, "required": true, "description": "The id of the company" }, { "in": "path", "name": "contractId", "schema": { "type": "string" }, "required": true, "description": "The id of the contract" } ], "responses": { "200": { "description": "Detail of a contract by ID", "content": { "application/json": { "schema": { "title": "contract-fr", "allOf": [ { "title": "contract", "allOf": [ { "type": "object", "title": "timeInformation", "description": "It will contain every information related to the time information", "properties": { "standardWeeklyHours": { "type": "number", "nullable": true, "description": "Weekly hours defined in the contract. It will be available if `contracts:time-information:read` scope is set on the token." }, "fullTimeEquivalent": { "type": "number", "nullable": true, "description": "Percentage of weekly hours in the contract. It will be available if `contracts:time-information:read` scope is set on the token." }, "isFullTime": { "type": "boolean", "nullable": true, "description": "Will be set to `true` if `fullTimeEquivalent` is at 1. It will be available if `contracts:time-information:read` scope is set on the token." } }, "required": [ "standardWeeklyHours", "fullTimeEquivalent", "isFullTime" ] }, { "type": "object", "properties": { "contractId": { "type": "string", "description": "Id of the contract." }, "companyId": { "type": "string", "description": "Id of the contract's company." }, "startDate": { "type": "string", "format": "date", "nullable": true, "description": "Contract start date." }, "endDate": { "type": "string", "format": "date", "nullable": true, "description": "Contract end date." }, "probationEndDate": { "type": "string", "format": "date", "nullable": true, "description": "Contract probation end date." }, "jobName": { "type": "string", "nullable": true, "description": "Job name of the employee." }, "status": { "description": "Status of the contrat.", "type": "string", "x-enum-name": "ContractStatusEnum", "enum": [ "ACTIVE", "ARCHIVED", "PENDING" ] }, "collaboratorId": { "type": "string", "description": "The id of the collaborator linked to the contract." } }, "required": [ "contractId", "companyId", "startDate", "jobName", "status", "collaboratorId" ] } ], "type": "object" }, { "type": "object", "properties": { "natureContratDsn": { "description": "The nature of the contract. Correspond to the variable DSN \"S21.G00.40.007\" as described in the [\"Cahier technique DSN\"](https://www.net-entreprises.fr/media/documentation/dsn-cahier-technique-2022.1.pdf#ChangementsContrat.StatutConventionnel). Can be null if the contract is in PENDING status.", "type": "string", "x-enum-name": "FrNatureContractDsnEnum", "nullable": true, "enum": [ "01", "02", "03", "07", "08", "09", "10", "20", "21", "29", "32", "50", "51", "52", "53", "60", "70", "80", "81", "82", "89", "90", "91", "92", "93", null ] }, "motifRuptureDeContratDsn": { "type": "string", "description": "The reason of contract termination. Correspond to the variable DSN \"S21.G00.62.002\" as described in the [\"Cahier technique DSN\"](https://www.net-entreprises.fr/media/documentation/dsn-cahier-technique-2022.1.pdf#ChangementsContrat.StatutConventionnel).", "nullable": true, "x-enum-name": "FrMotifRuptureDeContratDsnEnum", "enum": [ "011", "012", "014", "015", "020", "025", "026", "031", "032", "033", "034", "035", "036", "037", "038", "039", "040", "043", "058", "059", "065", "066", "070", "071", "081", "082", "083", "084", "085", "086", "087", "088", "089", "091", "092", "093", "094", "095", "096", "097", "098", "099", "100", "110", "111", "112", "113", "114", "115", "116", "998", "999", null ] }, "statutConventionnelDsn": { "x-enum-name": "FrStatutConventionnelDsnEnum", "type": "string", "nullable": true, "description": "The status of the contract. Correspond to the variable DSN \"S21.G00.40.002\" as described in the [\"Cahier technique DSN\"](https://www.net-entreprises.fr/media/documentation/dsn-cahier-technique-2022.1.pdf#ChangementsContrat.StatutConventionnel). Can be null if the contract is in PENDING status.", "enum": [ "01", "02", "03", "04", "05", "06", "07", "08", "09", "10", null ] }, "idcc": { "type": "string", "description": "The \"identifiant de convention collective\" of the contract. Correspond to the variable DSN \"S21.G00.40.017\" as described in the [\"Cahier technique DSN\"](https://www.net-entreprises.fr/media/documentation/dsn-cahier-technique-2022.1.pdf). If the status of the contract is ARCHIVED, this value might be null.", "nullable": true }, "healthInsuranceContractIds": { "type": "array", "items": { "type": "string" }, "nullable": true, "description": "List of the health insurance contracts the contract is affiliated to. It will be available if `health-insurance:read` scope is set on the token." }, "providentFundContractIds": { "type": "array", "items": { "type": "string" }, "nullable": true, "description": "List of the provident funds contracts the contract is affiliated to. It will be available if `health-insurance:read` scope is set on the token." }, "estCadreDirigeant": { "type": "boolean", "description": "Indicates whether the contract is a contract \"cadre dirigeant\" or not." }, "workingTimeModality": { "type": "string", "description": "Contractual working time modality. It will be available if `contracts:time-information:read` scope is set on the token.", "enum": [ "standard", "forfait_heures", "forfait_jours", "forfait_annuel_en_heures", "forfait_sans_reference_horaire", null ], "x-enum-name": "FrWorkingTimeModalityEnum", "nullable": true } }, "required": [ "statutConventionnelDsn", "natureContratDsn", "motifRuptureDeContratDsn", "idcc", "healthInsuranceContractIds", "providentFundContractIds", "estCadreDirigeant", "workingTimeModality" ] } ] }, "examples": { "aliceContract": { "summary": "An example of Alice's contract fr", "value": [ { "statutConventionnelDsn": "04", "natureContratDsn": "08", "motifRuptureDeContratDsn": null, "idcc": "0413", "healthInsuranceContractIds": [ "fcaacba9-e790-4cfb-8663-c8531b239d36" ], "providentFundContractIds": [ "fcaacba9-e790-4cfb-8663-c8531b239d37" ], "summary": "An example of Alice's contract", "value": { "contractId": "5b59e7b282ddef55f860d322", "companyId": "5b59e7b182ddef55f860d311", "collaboratorId": "6fe3a703-89f5-414d-8190-88f0d80435a3", "jobName": "Designer", "startDate": "2018-07-12", "endDate": null, "probationEndDate": null, "status": "ACTIVE", "standardWeeklyHours": 35, "fullTimeEquivalent": 1, "isFullTime": true } } ] }, "bobContract": { "summary": "An example of Bob's contract fr", "value": [ { "statutConventionnelDsn": "01", "natureContratDsn": "10", "motifRuptureDeContratDsn": "998", "idcc": "0413", "healthInsuranceContractIds": [ "fcaacba9-e790-4cfb-8663-c8531b239d36" ], "providentFundContractIds": [ "fcaacba9-e790-4cfb-8663-c8531b239d37" ], "summary": "An example of Bob's contract", "value": { "contractId": "5b59e7b282ddef55f860d325", "companyId": "5b59e7b182ddef55f860d311", "collaboratorId": "6fe3a703-89f5-414d-8190-88f0d80435a3", "jobName": "Architect", "startDate": "2017-12-21", "status": "ACTIVE", "endDate": "2020-07-06", "probationEndDate": "2020-07-06", "standardWeeklyHours": null, "fullTimeEquivalent": null, "isFullTime": null } } ] } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "title": "error", "type": "object", "additionalProperties": false, "properties": { "error": { "type": "string", "description": "A human readable error" }, "details": { "oneOf": [ { "type": "object", "additionalProperties": true }, { "type": "string", "additionalProperties": true } ] }, "errors": { "type": "array", "items": { "type": "object", "additionalProperties": true } } }, "required": [ "error" ] }, "examples": { "error": { "summary": "An example of an error message", "value": { "code": 400, "error": "Bad request", "details": "Field \"id\" is required." } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "title": "error", "type": "object", "additionalProperties": false, "properties": { "error": { "type": "string", "description": "A human readable error" }, "details": { "oneOf": [ { "type": "object", "additionalProperties": true }, { "type": "string", "additionalProperties": true } ] }, "errors": { "type": "array", "items": { "type": "object", "additionalProperties": true } } }, "required": [ "error" ] }, "examples": { "error": { "summary": "An example of an error message", "value": { "code": 401, "error": "Unauthorized" } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "title": "error", "type": "object", "additionalProperties": false, "properties": { "error": { "type": "string", "description": "A human readable error" }, "details": { "oneOf": [ { "type": "object", "additionalProperties": true }, { "type": "string", "additionalProperties": true } ] }, "errors": { "type": "array", "items": { "type": "object", "additionalProperties": true } } }, "required": [ "error" ] }, "examples": { "error": { "summary": "An example of an error message", "value": { "code": 403, "error": "Forbidden action", "details": "Missing scope \"contracts:read\"." } } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "title": "error", "type": "object", "additionalProperties": false, "properties": { "error": { "type": "string", "description": "A human readable error" }, "details": { "oneOf": [ { "type": "object", "additionalProperties": true }, { "type": "string", "additionalProperties": true } ] }, "errors": { "type": "array", "items": { "type": "object", "additionalProperties": true } } }, "required": [ "error" ] }, "examples": { "error": { "summary": "An example of an error message", "value": { "code": 404, "error": "Ressource not found", "details": "The provided id is wrong" } } } } } } }, "security": [ { "partner-api-oauth": [ "contracts:read" ] } ] } } }, "components": { "securitySchemes": { "partner-api-oauth": { "type": "oauth2", "flows": { "authorizationCode": { "authorizationUrl": "https://oauth.payfit.com/authorize", "tokenUrl": "https://oauth.payfit.com/token", "scopes": { "contracts:read": "Allow to read contracts information", "collaborators:contracts:write": "Allow to create contracts on a collaborator", "contracts:payslips:read": "Allow to read payslips", "contracts:time-information:read": "Allow to read time related information of contracts", "pension:read": "Allow to read pension documents", "collaborators:read": "Read general information of collaborators.", "collaborators:write": "Allow to create collaborators.", "collaborators:contracts:read": "Read contract information of collaborators.", "collaborators:management:read": "Read information about organisation and management.", "collaborators:meal-vouchers:read": "Read meal vouchers information of collaborators.", "collaborators:personal:read": "Read personal data of collaborators.", "collaborators:social-security:read": "Read the social security identifiers of collaborators.", "collaborators:legal-identity:read": "Read the legal identity information of collaborators.", "collaborators:bank-info:read": "Allow to read the bank info of collaborators.", "accounting:read": "Allow to read company accounting information", "payment-files:read": "Allow to read company payment file information", "time:read": "Allow to read time data", "time:write": "Allow to write time data", "health-insurance:read": "Allow to read health insurance contracts", "health-insurance:write": "Allow to write health insurance contracts" } } } } } }, "tags": [ { "name": "Contract" } ] } ```