v1

latestOpenAPI 3.0.02026-07-24310185.2 KB

Contract

Get a contract 🇫🇷

Returns a contract information by ID with french specific data.
Required scopes: contracts:read

get/companies/{companyId}/contracts-fr/{contractId}

Path parameters

companyIdstring required

The id of the company

contractIdstring required

The id of the contract

Response

Detail of a contract by ID

standardWeeklyHoursnumber nullable required

Weekly hours defined in the contract. It will be available if contracts:time-information:read scope is set on the token.

fullTimeEquivalentnumber nullable required

Percentage of weekly hours in the contract. It will be available if contracts:time-information:read scope is set on the token.

isFullTimeboolean nullable required

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.

contractIdstring required

Id of the contract.

companyIdstring required

Id of the contract's company.

startDatestring date required

Contract start date.

endDatestring date nullable

Contract end date.

probationEndDatestring date nullable

Contract probation end date.

jobNamestring nullable required

Job name of the employee.

status'ACTIVE' | 'ARCHIVED' | 'PENDING' required

Status of the contrat.

collaboratorIdstring required

The id of the collaborator linked to the contract.

natureContratDsn'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' nullable required

The nature of the contract. Correspond to the variable DSN "S21.G00.40.007" as described in the "Cahier technique DSN". Can be null if the contract is in PENDING status.

motifRuptureDeContratDsn'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' nullable required

The reason of contract termination. Correspond to the variable DSN "S21.G00.62.002" as described in the "Cahier technique DSN".

statutConventionnelDsn'01' | '02' | '03' | '04' | '05' | '06' | '07' | '08' | '09' | '10' | 'null' nullable required

The status of the contract. Correspond to the variable DSN "S21.G00.40.002" as described in the "Cahier technique DSN". Can be null if the contract is in PENDING status.

idccstring nullable required

The "identifiant de convention collective" of the contract. Correspond to the variable DSN "S21.G00.40.017" as described in the "Cahier technique DSN". If the status of the contract is ARCHIVED, this value might be null.

healthInsuranceContractIdsstring[] nullable required

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.

providentFundContractIdsstring[] nullable required

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.

estCadreDirigeantboolean required

Indicates whether the contract is a contract "cadre dirigeant" or not.

Contractual working time modality. It will be available if contracts:time-information:read scope is set on the token.