PApayfit
Contract

Get a contract 🌍

Changed on

Returns a contract information by ID.
Required scopes: contracts:read

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

Request

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

Changes