API docs by Redocly

PHPR API (3.7.0)

Download OpenAPI specification:

PHPR API USING API-PLATFORM

person_corporations

Retrieves the collection of person_corporations resources.

Retrieves the collection of person_corporations 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[code]
boolean
exists[creationDate]
boolean
exists[yearEndDate]
boolean
exists[firstPaymentDate]
boolean
exists[users]
boolean
exists[number]
boolean
exists[employerNumberCan]
boolean
exists[employerNumberQc]
boolean
exists[noTps]
boolean
exists[noTvq]
boolean
exists[paymentsTerms]
boolean
exists[paymentPeriodicity]
boolean
exists[userForDefault]
boolean
exists[keyValue]
boolean
exists[notes]
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[code]
string
Default: "asc"
Enum: "asc" "desc"
order[number]
string
Default: "asc"
Enum: "asc" "desc"
order[employerNumberCan]
string
Default: "asc"
Enum: "asc" "desc"
order[employerNumberQc]
string
Default: "asc"
Enum: "asc" "desc"
order[noTps]
string
Default: "asc"
Enum: "asc" "desc"
order[noTvq]
string
Default: "asc"
Enum: "asc" "desc"
order[slug]
string
Default: "asc"
Enum: "asc" "desc"
order[creationDate]
string
Default: "asc"
Enum: "asc" "desc"
order[yearEndDate]
string
Default: "asc"
Enum: "asc" "desc"
order[firstPaymentDate]
string
Default: "asc"
Enum: "asc" "desc"
order[paymentsNbDays]
string
Default: "asc"
Enum: "asc" "desc"
order[id]
string
Default: "asc"
Enum: "asc" "desc"
order[monthlyFee]
string
Default: "asc"
Enum: "asc" "desc"
order[paymentsTerms]
string
Default: "asc"
Enum: "asc" "desc"
order[notes]
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"
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
creationDate[before]
string
creationDate[strictly_before]
string
creationDate[after]
string
creationDate[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
employerNumberCan_end_with
string
employerNumberCan_partial
string
employerNumberCan_start_with
string
employerNumberCan
string
employerNumberCan[]
Array of strings
employerNumberQc_end_with
string
employerNumberQc_partial
string
employerNumberQc_start_with
string
employerNumberQc
string
employerNumberQc[]
Array of strings
firstPaymentDate[before]
string
firstPaymentDate[strictly_before]
string
firstPaymentDate[after]
string
firstPaymentDate[strictly_after]
string
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
monthlyFee_range[between]
string
monthlyFee_range[gt]
string
monthlyFee_range[gte]
string
monthlyFee_range[lt]
string
monthlyFee_range[lte]
string
monthlyFee
string
monthlyFee[]
Array of strings
noTps_end_with
string
noTps_partial
string
noTps_start_with
string
noTps
string
noTps[]
Array of strings
noTvq_end_with
string
noTvq_partial
string
noTvq_start_with
string
noTvq
string
noTvq[]
Array of strings
notes_end_with
string
notes_partial
string
notes_start_with
string
notes
string
notes[]
Array of strings
number_end_with
string
number_partial
string
number_start_with
string
number
string
number[]
Array of strings
paymentPeriodicity
string
paymentPeriodicity[]
Array of strings
paymentsNbDays_range[between]
string
paymentsNbDays_range[gt]
string
paymentsNbDays_range[gte]
string
paymentsNbDays_range[lt]
string
paymentsNbDays_range[lte]
string
paymentsNbDays
integer
paymentsNbDays[]
Array of integers
paymentsTerms_end_with
string
paymentsTerms_partial
string
paymentsTerms_start_with
string
paymentsTerms
string
paymentsTerms[]
Array of strings
person
string
person[]
Array of strings
slug_end_with
string
slug_partial
string
slug_start_with
string
slug
string
slug[]
Array of strings
updatedAt[before]
string
updatedAt[strictly_before]
string
updatedAt[after]
string
updatedAt[strictly_after]
string
yearEndDate[before]
string
yearEndDate[strictly_before]
string
yearEndDate[after]
string
yearEndDate[strictly_after]
string

Responses

Response samples

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