API docs by Redocly

PHPR API (3.7.0)

Download OpenAPI specification:

PHPR API USING API-PLATFORM

payrolls

Creates a payrolls resource.

Creates a payrolls resource.

Authorizations:
JWT
path Parameters
id
required
string

payrolls identifier

Request Body schema:
required

The new payrolls resource

cumulativeT4
string or null <iri-reference>
timesheetDateStart
required
string or null <date-time>
timesheetDateEnd
required
string or null <date-time>
status
required
string <iri-reference>

Get status.

createdDate
required
string <date-time>
employee
required
string <iri-reference>

Get employesId.

nbHours
required
string
holidayNbHours
required
string

// To keep track of the number of holiday hours, mostly for prints/reports etc, // does not have an impact since it is counted in the nbHours of the payroll anyway

employeeHourSalary
required
string
vacancyPaid
required
string
vacancyAmount
required
string
employeeVacancy
required
string
bonus
required
string
grossSalary
required
string
employeeAssemp
required
string
employeeRrq
required
string
employeeRqap
required
string
employeeRpc
required
string
employeeImpotFed
required
string
employeeImpotProv
required
string
employeeTaxableBenefits
required
string

EmployeeTaxableBenefits will influence the TaxeFed & TaxeProv as an increase amount

voluntaryRetirementSavingsPlan
required
string

Also call RVER / VRSP EmployeeSavingTaxableReduction will influence the TaxeFed & TaxeProv as an decrease amount

registeredRetirementSavingsPlan
required
string

Also call REER / RRSP EmployeeSavingTaxableReduction will influence the TaxeFed & TaxeProv as an decrease amount

taxFreeSavingAccount
required
string

Also call CELI / TFSA EmployeeSavingTaxableReduction not influence the TaxeFed & TaxeProv so amount will not change

employerAssemp
required
string
employerRrq
required
string
employerRqap
required
string
employerRpc
required
string
employerFss
required
string
employerCsst
required
string
allowanceTotal
required
string
netSalary
required
string
bonis
Array of strings <iri-reference> [ items <iri-reference > ]
allowances
Array of strings <iri-reference> [ items <iri-reference > ]
timesheets
Array of strings <iri-reference> [ items <iri-reference > ]
payments
Array of strings <iri-reference> [ items <iri-reference > ]
followups
Array of strings <iri-reference> [ items <iri-reference > ]
notes
string or null
owningCorporation
string <iri-reference>
vacancyBoni
string or null <iri-reference>
deletedAt
string or null <date-time>
slug
required
string

DB Identifier

customProperties
any

Can contain anything (array, objects, nested objects...).

customData
Array of strings or null
createdAt
string <date-time>
updatedAt
string <date-time>
disabledAt
string or null <date-time>
object (Collection.jsonld)
upload_filename
string
upload_subfolder
string
upload_file
string
upload_file_link
string
timestamp
string <date-time>

Get createdAt.

upload_Subfolder
string
upload_File
string
upload_File_Link
string

Responses

Request samples

Content type
{
  • "cumulativeT4": "https://example.com/",
  • "timesheetDateStart": "2019-08-24T14:15:22Z",
  • "timesheetDateEnd": "2019-08-24T14:15:22Z",
  • "status": "https://example.com/",
  • "createdDate": "2019-08-24T14:15:22Z",
  • "employee": "https://example.com/",
  • "nbHours": "string",
  • "holidayNbHours": "string",
  • "employeeHourSalary": "string",
  • "vacancyPaid": "string",
  • "vacancyAmount": "string",
  • "employeeVacancy": "string",
  • "bonus": "string",
  • "grossSalary": "string",
  • "employeeAssemp": "string",
  • "employeeRrq": "string",
  • "employeeRqap": "string",
  • "employeeRpc": "string",
  • "employeeImpotFed": "string",
  • "employeeImpotProv": "string",
  • "employeeTaxableBenefits": "string",
  • "voluntaryRetirementSavingsPlan": "string",
  • "registeredRetirementSavingsPlan": "string",
  • "taxFreeSavingAccount": "string",
  • "employerAssemp": "string",
  • "employerRrq": "string",
  • "employerRqap": "string",
  • "employerRpc": "string",
  • "employerFss": "string",
  • "employerCsst": "string",
  • "allowanceTotal": "string",
  • "netSalary": "string",
  • "bonis": [],
  • "allowances": [],
  • "timesheets": [],
  • "payments": [],
  • "followups": [],
  • "notes": "string",
  • "owningCorporation": "https://example.com/",
  • "vacancyBoni": "https://example.com/",
  • "deletedAt": "2019-08-24T14:15:22Z",
  • "slug": "string",
  • "customProperties": null,
  • "customData": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "disabledAt": "2019-08-24T14:15:22Z",
  • "entityFiles": { },
  • "upload_filename": "string",
  • "upload_subfolder": "string",
  • "upload_file": "string",
  • "upload_file_link": "string",
  • "t4s": { },
  • "timestamp": "2019-08-24T14:15:22Z",
  • "upload_Subfolder": "string",
  • "upload_File": "string",
  • "upload_File_Link": "string"
}

Response samples

Content type
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "timesheetDateStart": "2019-08-24T14:15:22Z",
  • "timesheetDateEnd": "2019-08-24T14:15:22Z",
  • "status": {
    },
  • "createdDate": "2019-08-24T14:15:22Z",
  • "employee": {
    },
  • "nbHours": "string",
  • "holidayNbHours": "string",
  • "employeeHourSalary": "string",
  • "vacancyPaid": "string",
  • "employeeVacancy": "string",
  • "bonus": "string",
  • "grossSalary": "string",
  • "employeeAssemp": "string",
  • "employeeRrq": "string",
  • "employeeRqap": "string",
  • "employeeRpc": "string",
  • "employeeImpotFed": "string",
  • "employeeImpotProv": "string",
  • "employeeTaxableBenefits": "string",
  • "voluntaryRetirementSavingsPlan": "string",
  • "registeredRetirementSavingsPlan": "string",
  • "taxFreeSavingAccount": "string",
  • "employerAssemp": "string",
  • "employerRrq": "string",
  • "employerRqap": "string",
  • "employerRpc": "string",
  • "employerFss": "string",
  • "employerCsst": "string",
  • "allowanceTotal": "string",
  • "netSalary": "string",
  • "timesheets": [
    ],
  • "notes": "string",
  • "owningCorporation": {
    },
  • "shortcode": "P",
  • "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",
  • "bonisListing": "string",
  • "allowancesListing": "string",
  • "paymentsListing": "string",
  • "anonymousToken": "string",
  • "payrollTotal": 0,
  • "payrollNetSalaryWithSavings": 0,
  • "payrollTotalToPay": 0,
  • "followupsListing": "string",
  • "t4s": {
    },
  • "t4sListing": "string",
  • "customPropertiesListing": "string",
  • "uniqueId": "string",
  • "taggingListing": "string",
  • "enabled": true,
  • "disabled": true
}