API docs by Redocly

PHPR API (3.7.0)

Download OpenAPI specification:

PHPR API USING API-PLATFORM

rents

Retrieves the collection of rents resources.

Retrieves the collection of rents 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[project]
boolean
exists[location]
boolean
exists[task]
boolean
exists[chargingInvoices]
boolean
exists[chargingProjects]
boolean
exists[dateEnd]
boolean
exists[dateCheckout]
boolean
exists[dateCheckin]
boolean
exists[description]
boolean
exists[note]
boolean
exists[reservedEmployee]
boolean
exists[product]
boolean
exists[chargedProduct]
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[location]
string
Default: "asc"
Enum: "asc" "desc"
order[slug]
string
Default: "asc"
Enum: "asc" "desc"
order[dateStart]
string
Default: "asc"
Enum: "asc" "desc"
order[dateEnd]
string
Default: "asc"
Enum: "asc" "desc"
order[dateCheckout]
string
Default: "asc"
Enum: "asc" "desc"
order[dateCheckin]
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[chargeable]
string
Default: "asc"
Enum: "asc" "desc"
order[description]
string
Default: "asc"
Enum: "asc" "desc"
order[note]
string
Default: "asc"
Enum: "asc" "desc"
order[id]
string
Default: "asc"
Enum: "asc" "desc"
chargeable
boolean
chargedProduct
string
chargedProduct[]
Array of strings
client
string
client[]
Array of strings
createdAt[before]
string
createdAt[strictly_before]
string
createdAt[after]
string
createdAt[strictly_after]
string
dateCheckin[before]
string
dateCheckin[strictly_before]
string
dateCheckin[after]
string
dateCheckin[strictly_after]
string
dateCheckout[before]
string
dateCheckout[strictly_before]
string
dateCheckout[after]
string
dateCheckout[strictly_after]
string
dateEnd[before]
string
dateEnd[strictly_before]
string
dateEnd[after]
string
dateEnd[strictly_after]
string
dateStart[before]
string
dateStart[strictly_before]
string
dateStart[after]
string
dateStart[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
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
location_end_with
string
location_partial
string
location_start_with
string
location
string
location[]
Array of strings
note_end_with
string
note_partial
string
note_start_with
string
note
string
note[]
Array of strings
product
string
product[]
Array of strings
project
string
project[]
Array of strings
reservedEmployee
string
reservedEmployee[]
Array of strings
responsible
string
responsible[]
Array of strings
slug_end_with
string
slug_partial
string
slug_start_with
string
slug
string
slug[]
Array of strings
task
string
task[]
Array of strings
type
string
type[]
Array of strings
updatedAt[before]
string
updatedAt[strictly_before]
string
updatedAt[after]
string
updatedAt[strictly_after]
string

Responses

Response samples

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