PHPR API (3.7.0)

Download OpenAPI specification:

PHPR API USING API-PLATFORM

person_employees

Retrieves a person_employees resource.

Retrieves a person_employees resource.

Authorizations:
JWT
path Parameters
id
required
string

person_employees identifier

Responses

Response samples

Content type
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "person": {
    },
  • "responsible": { },
  • "sector": {
    },
  • "type": {
    },
  • "workingType": {
    },
  • "hourSalary": 15,
  • "hiringDate": "2019-08-24T14:15:22Z",
  • "dateEndOfContract": "2019-08-24T14:15:22Z",
  • "vacancy": 0.04,
  • "nas": "stringstr",
  • "inSchedule": true,
  • "reservable": true,
  • "overtime": true,
  • "payRrq": true,
  • "payAssemp": true,
  • "payFss": true,
  • "payRqap": true,
  • "payRpc": true,
  • "payCsst": true,
  • "payFedTaxes": true,
  • "payProvTaxes": true,
  • "annualDeductionFed": "string",
  • "annualDeductionProv": "string",
  • "annualTaxableBenefits": "string",
  • "voluntaryRetirementSavingsPlan": "string",
  • "registeredRetirementSavingsPlan": "string",
  • "taxFreeSavingAccount": "string",
  • "code": "string",
  • "notes": "string",
  • "holidayPaymentAnnually": true,
  • "estimatedTime": 40,
  • "paymentTime": 0,
  • "owningCorporation": {
    },
  • "shortcode": "E",
  • "deletedAt": "2019-08-24T14:15:22Z",
  • "id": 0,
  • "slug": "string",
  • "customProperties": null,
  • "customData": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "disabledAt": "2019-08-24T14:15:22Z",
  • "toString": "string",
  • "employeeType": {
    },
  • "prospectsListing": "string",
  • "projectsListing": "string",
  • "inchargeProjectsListing": "string",
  • "clientsListing": "string",
  • "suppliersListing": "string",
  • "allowancesListing": "string",
  • "tasksListing": "string",
  • "tasksSentListing": "string",
  • "projectSectorsListing": "string",
  • "followupsListing": "string",
  • "recallFollowupsListing": "string",
  • "invoicesListing": "string",
  • "timesheetsListing": "string",
  • "payrollsListing": "string",
  • "t4sListing": "string",
  • "billsListing": "string",
  • "rentsListing": "string",
  • "responsibleRentsListing": "string",
  • "bonisListing": "string",
  • "sentBonisListing": "string",
  • "responsibleSectorsListing": [
    ],
  • "schedulesListing": "string",
  • "madeSchedulesListing": "string",
  • "employeeHolidayAmountToPay": 0,
  • "customPropertiesListing": "string",
  • "employeesListing": "string",
  • "defaultCoordinate": null,
  • "anonymousToken": "string",
  • "uniqueId": "string",
  • "taggingListing": "string",
  • "enabled": true,
  • "disabled": true
}

Replaces the person_employees resource.

Replaces the person_employees resource.

Authorizations:
JWT
path Parameters
id
required
string

person_employees identifier

Request Body schema:
required

The updated person_employees resource

required
object (people.jsonld-add_post)

Get person.

person_employees.jsonld-add_post (object) or null
object (project_sectors.jsonld-add_post)

Sector.

object (person_employee_types.jsonld-add_post)

EmployesTypes.

object (person_workingtypes.jsonld-add_post)

EmployesWorkingTypes.

hourSalary
required
string
Default: 15
hiringDate
string <date-time>
dateEndOfContract
string or null <date-time>
vacancy
required
string
Default: 0.04
nas
string or null = 9 characters
inSchedule
boolean
reservable
boolean
overtime
boolean
Default: true
payRrq
boolean
Default: true
payAssemp
boolean
Default: true
payFss
boolean
Default: true
payRqap
boolean
Default: true
payRpc
boolean
Default: true
payCsst
boolean
Default: true
payFedTaxes
boolean
Default: true
payProvTaxes
boolean
Default: true
annualDeductionFed
required
string
annualDeductionProv
required
string
annualTaxableBenefits
required
string
voluntaryRetirementSavingsPlan
required
string
registeredRetirementSavingsPlan
required
string
taxFreeSavingAccount
required
string
code
string or null
notes
string or null
internalNotes
string or null
holidayPaymentAnnually
boolean
estimatedTime
required
string
Default: 40
paymentTime
integer or null
deletedAt
string or null <date-time>
slug
required
string

DB Identifier

customData
Array of strings or null
disabledAt
string or null <date-time>

Responses

Request samples

Content type
{
  • "person": {
    },
  • "responsible": { },
  • "sector": {
    },
  • "type": {
    },
  • "workingType": {
    },
  • "hourSalary": 15,
  • "hiringDate": "2019-08-24T14:15:22Z",
  • "dateEndOfContract": "2019-08-24T14:15:22Z",
  • "vacancy": 0.04,
  • "nas": "stringstr",
  • "inSchedule": true,
  • "reservable": true,
  • "overtime": true,
  • "payRrq": true,
  • "payAssemp": true,
  • "payFss": true,
  • "payRqap": true,
  • "payRpc": true,
  • "payCsst": true,
  • "payFedTaxes": true,
  • "payProvTaxes": true,
  • "annualDeductionFed": "string",
  • "annualDeductionProv": "string",
  • "annualTaxableBenefits": "string",
  • "voluntaryRetirementSavingsPlan": "string",
  • "registeredRetirementSavingsPlan": "string",
  • "taxFreeSavingAccount": "string",
  • "code": "string",
  • "notes": "string",
  • "internalNotes": "string",
  • "holidayPaymentAnnually": true,
  • "estimatedTime": 40,
  • "paymentTime": 0,
  • "deletedAt": "2019-08-24T14:15:22Z",
  • "slug": "string",
  • "customData": [
    ],
  • "disabledAt": "2019-08-24T14:15:22Z"
}

Response samples

Content type
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "person": {
    },
  • "responsible": { },
  • "sector": {
    },
  • "type": {
    },
  • "workingType": {
    },
  • "hourSalary": 15,
  • "hiringDate": "2019-08-24T14:15:22Z",
  • "dateEndOfContract": "2019-08-24T14:15:22Z",
  • "vacancy": 0.04,
  • "nas": "stringstr",
  • "inSchedule": true,
  • "reservable": true,
  • "overtime": true,
  • "payRrq": true,
  • "payAssemp": true,
  • "payFss": true,
  • "payRqap": true,
  • "payRpc": true,
  • "payCsst": true,
  • "payFedTaxes": true,
  • "payProvTaxes": true,
  • "annualDeductionFed": "string",
  • "annualDeductionProv": "string",
  • "annualTaxableBenefits": "string",
  • "voluntaryRetirementSavingsPlan": "string",
  • "registeredRetirementSavingsPlan": "string",
  • "taxFreeSavingAccount": "string",
  • "code": "string",
  • "notes": "string",
  • "holidayPaymentAnnually": true,
  • "estimatedTime": 40,
  • "paymentTime": 0,
  • "owningCorporation": {
    },
  • "shortcode": "E",
  • "deletedAt": "2019-08-24T14:15:22Z",
  • "id": 0,
  • "slug": "string",
  • "customProperties": null,
  • "customData": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "disabledAt": "2019-08-24T14:15:22Z",
  • "toString": "string",
  • "employeeType": {
    },
  • "prospectsListing": "string",
  • "projectsListing": "string",
  • "inchargeProjectsListing": "string",
  • "clientsListing": "string",
  • "suppliersListing": "string",
  • "allowancesListing": "string",
  • "tasksListing": "string",
  • "tasksSentListing": "string",
  • "projectSectorsListing": "string",
  • "followupsListing": "string",
  • "recallFollowupsListing": "string",
  • "invoicesListing": "string",
  • "timesheetsListing": "string",
  • "payrollsListing": "string",
  • "t4sListing": "string",
  • "billsListing": "string",
  • "rentsListing": "string",
  • "responsibleRentsListing": "string",
  • "bonisListing": "string",
  • "sentBonisListing": "string",
  • "responsibleSectorsListing": [
    ],
  • "schedulesListing": "string",
  • "madeSchedulesListing": "string",
  • "employeeHolidayAmountToPay": 0,
  • "customPropertiesListing": "string",
  • "employeesListing": "string",
  • "defaultCoordinate": null,
  • "anonymousToken": "string",
  • "uniqueId": "string",
  • "taggingListing": "string",
  • "enabled": true,
  • "disabled": true
}

Removes the person_employees resource.

Removes the person_employees resource.

Authorizations:
JWT
path Parameters
id
required
string

person_employees identifier

Responses