API docs by Redocly

PHPR API (3.7.0)

Download OpenAPI specification:

PHPR API USING API-PLATFORM

person_employees

Retrieves the collection of person_employees resources.

Retrieves the collection of person_employees resources.

Authorizations:
JWT
query Parameters
page
integer
Default: 1

The collection page number

itemsPerPage
integer [ 0 .. 1000 ]
Default: 30

The number of items per page

exists[prospects]
boolean
exists[projects]
boolean
exists[inchargeProjects]
boolean
exists[tasks]
boolean
exists[tasksSent]
boolean
exists[projectSectors]
boolean
exists[followups]
boolean
exists[recallFollowups]
boolean
exists[invoices]
boolean
exists[clients]
boolean
exists[employees]
boolean
exists[suppliers]
boolean
exists[timesheets]
boolean
exists[payrolls]
boolean
exists[t4s]
boolean
exists[bills]
boolean
exists[allowances]
boolean
exists[bonis]
boolean
exists[sentBonis]
boolean
exists[responsibleRents]
boolean
exists[rents]
boolean
exists[schedules]
boolean
exists[madeSchedules]
boolean
exists[responsible]
boolean
exists[dateEndOfContract]
boolean
exists[nas]
boolean
exists[responsibleSectors]
boolean
exists[code]
boolean
exists[notes]
boolean
exists[internalNotes]
boolean
exists[paymentTime]
boolean
exists[deletedAt]
boolean
exists[customProperties]
boolean
exists[disabledAt]
boolean
properties[]
Array of strings

Allows you to reduce the response to contain only the properties you need. If your desired property is nested, you can address it using nested arrays. Example: properties[]={propertyName}&properties[]={anotherPropertyName}&properties[{nestedPropertyParent}][]={nestedProperty}

enabled
boolean

Filter entities by enabled (1), disabled (0), or all (nothing).

search
string
tag
string

Filter using tag.

order[hourSalary]
string
Default: "asc"
Enum: "asc" "desc"
order[vacancy]
string
Default: "asc"
Enum: "asc" "desc"
order[annualDeductionFed]
string
Default: "asc"
Enum: "asc" "desc"
order[annualDeductionProv]
string
Default: "asc"
Enum: "asc" "desc"
order[annualTaxableBenefits]
string
Default: "asc"
Enum: "asc" "desc"
order[voluntaryRetirementSavingsPlan]
string
Default: "asc"
Enum: "asc" "desc"
order[registeredRetirementSavingsPlan]
string
Default: "asc"
Enum: "asc" "desc"
order[taxFreeSavingAccount]
string
Default: "asc"
Enum: "asc" "desc"
order[estimatedTime]
string
Default: "asc"
Enum: "asc" "desc"
order[hiringDate]
string
Default: "asc"
Enum: "asc" "desc"
order[dateEndOfContract]
string
Default: "asc"
Enum: "asc" "desc"
order[nas]
string
Default: "asc"
Enum: "asc" "desc"
order[code]
string
Default: "asc"
Enum: "asc" "desc"
order[slug]
string
Default: "asc"
Enum: "asc" "desc"
order[inSchedule]
string
Default: "asc"
Enum: "asc" "desc"
order[reservable]
string
Default: "asc"
Enum: "asc" "desc"
order[overtime]
string
Default: "asc"
Enum: "asc" "desc"
order[payRrq]
string
Default: "asc"
Enum: "asc" "desc"
order[payAssemp]
string
Default: "asc"
Enum: "asc" "desc"
order[payFss]
string
Default: "asc"
Enum: "asc" "desc"
order[payRqap]
string
Default: "asc"
Enum: "asc" "desc"
order[payRpc]
string
Default: "asc"
Enum: "asc" "desc"
order[payCsst]
string
Default: "asc"
Enum: "asc" "desc"
order[payFedTaxes]
string
Default: "asc"
Enum: "asc" "desc"
order[payProvTaxes]
string
Default: "asc"
Enum: "asc" "desc"
order[holidayPaymentAnnually]
string
Default: "asc"
Enum: "asc" "desc"
order[notes]
string
Default: "asc"
Enum: "asc" "desc"
order[internalNotes]
string
Default: "asc"
Enum: "asc" "desc"
order[paymentTime]
string
Default: "asc"
Enum: "asc" "desc"
order[id]
string
Default: "asc"
Enum: "asc" "desc"
order[deletedAt]
string
Default: "asc"
Enum: "asc" "desc"
order[createdAt]
string
Default: "asc"
Enum: "asc" "desc"
order[updatedAt]
string
Default: "asc"
Enum: "asc" "desc"
order[disabledAt]
string
Default: "asc"
Enum: "asc" "desc"
annualDeductionFed_range[between]
string
annualDeductionFed_range[gt]
string
annualDeductionFed_range[gte]
string
annualDeductionFed_range[lt]
string
annualDeductionFed_range[lte]
string
annualDeductionFed
string
annualDeductionFed[]
Array of strings
annualDeductionProv_range[between]
string
annualDeductionProv_range[gt]
string
annualDeductionProv_range[gte]
string
annualDeductionProv_range[lt]
string
annualDeductionProv_range[lte]
string
annualDeductionProv
string
annualDeductionProv[]
Array of strings
annualTaxableBenefits_range[between]
string
annualTaxableBenefits_range[gt]
string
annualTaxableBenefits_range[gte]
string
annualTaxableBenefits_range[lt]
string
annualTaxableBenefits_range[lte]
string
annualTaxableBenefits
string
annualTaxableBenefits[]
Array of strings
code_end_with
string
code_partial
string
code_start_with
string
code
string
code[]
Array of strings
createdAt[before]
string
createdAt[strictly_before]
string
createdAt[after]
string
createdAt[strictly_after]
string
dateEndOfContract[before]
string
dateEndOfContract[strictly_before]
string
dateEndOfContract[after]
string
dateEndOfContract[strictly_after]
string
deletedAt[before]
string
deletedAt[strictly_before]
string
deletedAt[after]
string
deletedAt[strictly_after]
string
disabledAt[before]
string
disabledAt[strictly_before]
string
disabledAt[after]
string
disabledAt[strictly_after]
string
estimatedTime_range[between]
string
estimatedTime_range[gt]
string
estimatedTime_range[gte]
string
estimatedTime_range[lt]
string
estimatedTime_range[lte]
string
estimatedTime
string
estimatedTime[]
Array of strings
hiringDate[before]
string
hiringDate[strictly_before]
string
hiringDate[after]
string
hiringDate[strictly_after]
string
holidayPaymentAnnually
boolean
hourSalary_range[between]
string
hourSalary_range[gt]
string
hourSalary_range[gte]
string
hourSalary_range[lt]
string
hourSalary_range[lte]
string
hourSalary
string
hourSalary[]
Array of strings
id_range[between]
string
id_range[gt]
string
id_range[gte]
string
id_range[lt]
string
id_range[lte]
string
id
integer
id[]
Array of integers
inSchedule
boolean
internalNotes_end_with
string
internalNotes_partial
string
internalNotes_start_with
string
internalNotes
string
internalNotes[]
Array of strings
nas_end_with
string
nas_partial
string
nas_start_with
string
nas
string
nas[]
Array of strings
notes_end_with
string
notes_partial
string
notes_start_with
string
notes
string
notes[]
Array of strings
overtime
boolean
payAssemp
boolean
payCsst
boolean
payFedTaxes
boolean
payFss
boolean
payProvTaxes
boolean
payRpc
boolean
payRqap
boolean
payRrq
boolean
paymentTime_range[between]
string
paymentTime_range[gt]
string
paymentTime_range[gte]
string
paymentTime_range[lt]
string
paymentTime_range[lte]
string
paymentTime
integer
paymentTime[]
Array of integers
person
string
person[]
Array of strings
registeredRetirementSavingsPlan_range[between]
string
registeredRetirementSavingsPlan_range[gt]
string
registeredRetirementSavingsPlan_range[gte]
string
registeredRetirementSavingsPlan_range[lt]
string
registeredRetirementSavingsPlan_range[lte]
string
registeredRetirementSavingsPlan
string
registeredRetirementSavingsPlan[]
Array of strings
reservable
boolean
responsible
string
responsible[]
Array of strings
sector
string
sector[]
Array of strings
slug_end_with
string
slug_partial
string
slug_start_with
string
slug
string
slug[]
Array of strings
taxFreeSavingAccount_range[between]
string
taxFreeSavingAccount_range[gt]
string
taxFreeSavingAccount_range[gte]
string
taxFreeSavingAccount_range[lt]
string
taxFreeSavingAccount_range[lte]
string
taxFreeSavingAccount
string
taxFreeSavingAccount[]
Array of strings
type
string
type[]
Array of strings
updatedAt[before]
string
updatedAt[strictly_before]
string
updatedAt[after]
string
updatedAt[strictly_after]
string
vacancy_range[between]
string
vacancy_range[gt]
string
vacancy_range[gte]
string
vacancy_range[lt]
string
vacancy_range[lte]
string
vacancy
string
vacancy[]
Array of strings
voluntaryRetirementSavingsPlan_range[between]
string
voluntaryRetirementSavingsPlan_range[gt]
string
voluntaryRetirementSavingsPlan_range[gte]
string
voluntaryRetirementSavingsPlan_range[lt]
string
voluntaryRetirementSavingsPlan_range[lte]
string
voluntaryRetirementSavingsPlan
string
voluntaryRetirementSavingsPlan[]
Array of strings
workingType
string
workingType[]
Array of strings

Responses

Response samples

Content type
{
  • "hydra:member": [
    ],
  • "hydra:totalItems": 0,
  • "hydra:view": {
    },
  • "hydra:search": {
    }
}

Creates a person_employees resource.

Creates a person_employees resource.

Authorizations:
JWT
Request Body schema:
required

The new 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
}