API docs by Redocly

PHPR API (3.7.0)

Download OpenAPI specification:

PHPR API USING API-PLATFORM

payrolls

Retrieves the collection of payrolls resources.

Retrieves the collection of payrolls 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[t4]
boolean
exists[cumulativeT4]
boolean
exists[timesheetDateStart]
boolean
exists[timesheetDateEnd]
boolean
exists[bonis]
boolean
exists[allowances]
boolean
exists[timesheets]
boolean
exists[payments]
boolean
exists[followups]
boolean
exists[notes]
boolean
exists[vacancyBoni]
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[timesheetDateStart]
string
Default: "asc"
Enum: "asc" "desc"
order[timesheetDateEnd]
string
Default: "asc"
Enum: "asc" "desc"
order[createdDate]
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"
order[nbHours]
string
Default: "asc"
Enum: "asc" "desc"
order[holidayNbHours]
string
Default: "asc"
Enum: "asc" "desc"
order[employeeHourSalary]
string
Default: "asc"
Enum: "asc" "desc"
order[vacancyPaid]
string
Default: "asc"
Enum: "asc" "desc"
order[vacancyAmount]
string
Default: "asc"
Enum: "asc" "desc"
order[employeeVacancy]
string
Default: "asc"
Enum: "asc" "desc"
order[bonus]
string
Default: "asc"
Enum: "asc" "desc"
order[grossSalary]
string
Default: "asc"
Enum: "asc" "desc"
order[employeeAssemp]
string
Default: "asc"
Enum: "asc" "desc"
order[employeeRrq]
string
Default: "asc"
Enum: "asc" "desc"
order[employeeRqap]
string
Default: "asc"
Enum: "asc" "desc"
order[employeeRpc]
string
Default: "asc"
Enum: "asc" "desc"
order[employeeImpotFed]
string
Default: "asc"
Enum: "asc" "desc"
order[employeeImpotProv]
string
Default: "asc"
Enum: "asc" "desc"
order[employeeTaxableBenefits]
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[employerAssemp]
string
Default: "asc"
Enum: "asc" "desc"
order[employerRrq]
string
Default: "asc"
Enum: "asc" "desc"
order[employerRqap]
string
Default: "asc"
Enum: "asc" "desc"
order[employerRpc]
string
Default: "asc"
Enum: "asc" "desc"
order[employerFss]
string
Default: "asc"
Enum: "asc" "desc"
order[employerCsst]
string
Default: "asc"
Enum: "asc" "desc"
order[allowanceTotal]
string
Default: "asc"
Enum: "asc" "desc"
order[netSalary]
string
Default: "asc"
Enum: "asc" "desc"
order[notes]
string
Default: "asc"
Enum: "asc" "desc"
order[id]
string
Default: "asc"
Enum: "asc" "desc"
order[slug]
string
Default: "asc"
Enum: "asc" "desc"
allowanceTotal_range[between]
string
allowanceTotal_range[gt]
string
allowanceTotal_range[gte]
string
allowanceTotal_range[lt]
string
allowanceTotal_range[lte]
string
allowanceTotal
string
allowanceTotal[]
Array of strings
bonus_range[between]
string
bonus_range[gt]
string
bonus_range[gte]
string
bonus_range[lt]
string
bonus_range[lte]
string
bonus
string
bonus[]
Array of strings
createdAt[before]
string
createdAt[strictly_before]
string
createdAt[after]
string
createdAt[strictly_after]
string
createdDate[before]
string
createdDate[strictly_before]
string
createdDate[after]
string
createdDate[strictly_after]
string
cumulativeT4
string
cumulativeT4[]
Array of strings
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
employee
string
employee[]
Array of strings
employeeAssemp_range[between]
string
employeeAssemp_range[gt]
string
employeeAssemp_range[gte]
string
employeeAssemp_range[lt]
string
employeeAssemp_range[lte]
string
employeeAssemp
string
employeeAssemp[]
Array of strings
employeeHourSalary_range[between]
string
employeeHourSalary_range[gt]
string
employeeHourSalary_range[gte]
string
employeeHourSalary_range[lt]
string
employeeHourSalary_range[lte]
string
employeeHourSalary
string
employeeHourSalary[]
Array of strings
employeeImpotFed_range[between]
string
employeeImpotFed_range[gt]
string
employeeImpotFed_range[gte]
string
employeeImpotFed_range[lt]
string
employeeImpotFed_range[lte]
string
employeeImpotFed
string
employeeImpotFed[]
Array of strings
employeeImpotProv_range[between]
string
employeeImpotProv_range[gt]
string
employeeImpotProv_range[gte]
string
employeeImpotProv_range[lt]
string
employeeImpotProv_range[lte]
string
employeeImpotProv
string
employeeImpotProv[]
Array of strings
employeeRpc_range[between]
string
employeeRpc_range[gt]
string
employeeRpc_range[gte]
string
employeeRpc_range[lt]
string
employeeRpc_range[lte]
string
employeeRpc
string
employeeRpc[]
Array of strings
employeeRqap_range[between]
string
employeeRqap_range[gt]
string
employeeRqap_range[gte]
string
employeeRqap_range[lt]
string
employeeRqap_range[lte]
string
employeeRqap
string
employeeRqap[]
Array of strings
employeeRrq_range[between]
string
employeeRrq_range[gt]
string
employeeRrq_range[gte]
string
employeeRrq_range[lt]
string
employeeRrq_range[lte]
string
employeeRrq
string
employeeRrq[]
Array of strings
employeeTaxableBenefits_range[between]
string
employeeTaxableBenefits_range[gt]
string
employeeTaxableBenefits_range[gte]
string
employeeTaxableBenefits_range[lt]
string
employeeTaxableBenefits_range[lte]
string
employeeTaxableBenefits
string
employeeTaxableBenefits[]
Array of strings
employeeVacancy_range[between]
string
employeeVacancy_range[gt]
string
employeeVacancy_range[gte]
string
employeeVacancy_range[lt]
string
employeeVacancy_range[lte]
string
employeeVacancy
string
employeeVacancy[]
Array of strings
employerAssemp_range[between]
string
employerAssemp_range[gt]
string
employerAssemp_range[gte]
string
employerAssemp_range[lt]
string
employerAssemp_range[lte]
string
employerAssemp
string
employerAssemp[]
Array of strings
employerCsst_range[between]
string
employerCsst_range[gt]
string
employerCsst_range[gte]
string
employerCsst_range[lt]
string
employerCsst_range[lte]
string
employerCsst
string
employerCsst[]
Array of strings
employerFss_range[between]
string
employerFss_range[gt]
string
employerFss_range[gte]
string
employerFss_range[lt]
string
employerFss_range[lte]
string
employerFss
string
employerFss[]
Array of strings
employerRpc_range[between]
string
employerRpc_range[gt]
string
employerRpc_range[gte]
string
employerRpc_range[lt]
string
employerRpc_range[lte]
string
employerRpc
string
employerRpc[]
Array of strings
employerRqap_range[between]
string
employerRqap_range[gt]
string
employerRqap_range[gte]
string
employerRqap_range[lt]
string
employerRqap_range[lte]
string
employerRqap
string
employerRqap[]
Array of strings
employerRrq_range[between]
string
employerRrq_range[gt]
string
employerRrq_range[gte]
string
employerRrq_range[lt]
string
employerRrq_range[lte]
string
employerRrq
string
employerRrq[]
Array of strings
grossSalary_range[between]
string
grossSalary_range[gt]
string
grossSalary_range[gte]
string
grossSalary_range[lt]
string
grossSalary_range[lte]
string
grossSalary
string
grossSalary[]
Array of strings
holidayNbHours_range[between]
string
holidayNbHours_range[gt]
string
holidayNbHours_range[gte]
string
holidayNbHours_range[lt]
string
holidayNbHours_range[lte]
string
holidayNbHours
string
holidayNbHours[]
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
nbHours_range[between]
string
nbHours_range[gt]
string
nbHours_range[gte]
string
nbHours_range[lt]
string
nbHours_range[lte]
string
nbHours
string
nbHours[]
Array of strings
netSalary_range[between]
string
netSalary_range[gt]
string
netSalary_range[gte]
string
netSalary_range[lt]
string
netSalary_range[lte]
string
netSalary
string
netSalary[]
Array of strings
notes_end_with
string
notes_partial
string
notes_start_with
string
notes
string
notes[]
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
slug_end_with
string
slug_partial
string
slug_start_with
string
slug
string
slug[]
Array of strings
status
string
status[]
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
timesheetDateEnd[before]
string
timesheetDateEnd[strictly_before]
string
timesheetDateEnd[after]
string
timesheetDateEnd[strictly_after]
string
timesheetDateStart[before]
string
timesheetDateStart[strictly_before]
string
timesheetDateStart[after]
string
timesheetDateStart[strictly_after]
string
timesheets
string
timesheets[]
Array of strings
updatedAt[before]
string
updatedAt[strictly_before]
string
updatedAt[after]
string
updatedAt[strictly_after]
string
vacancyAmount_range[between]
string
vacancyAmount_range[gt]
string
vacancyAmount_range[gte]
string
vacancyAmount_range[lt]
string
vacancyAmount_range[lte]
string
vacancyAmount
string
vacancyAmount[]
Array of strings
vacancyBoni
string
vacancyBoni[]
Array of strings
vacancyPaid_range[between]
string
vacancyPaid_range[gt]
string
vacancyPaid_range[gte]
string
vacancyPaid_range[lt]
string
vacancyPaid_range[lte]
string
vacancyPaid
string
vacancyPaid[]
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

Responses

Response samples

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