API docs by Redocly

PHPR API (3.7.0)

Download OpenAPI specification:

PHPR API USING API-PLATFORM

invoice_lines

Retrieves the collection of invoice_lines resources.

Retrieves the collection of invoice_lines 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[scan]
boolean
exists[taxCustoms]
boolean
exists[product]
boolean
exists[description]
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[timestamp]
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[priority]
string
Default: "asc"
Enum: "asc" "desc"
order[id]
string
Default: "asc"
Enum: "asc" "desc"
order[code]
string
Default: "asc"
Enum: "asc" "desc"
order[scan]
string
Default: "asc"
Enum: "asc" "desc"
order[slug]
string
Default: "asc"
Enum: "asc" "desc"
order[price]
string
Default: "asc"
Enum: "asc" "desc"
order[discountPrice]
string
Default: "asc"
Enum: "asc" "desc"
order[number]
string
Default: "asc"
Enum: "asc" "desc"
order[convertedPrice]
string
Default: "asc"
Enum: "asc" "desc"
order[taxes]
string
Default: "asc"
Enum: "asc" "desc"
order[discountable]
string
Default: "asc"
Enum: "asc" "desc"
order[description]
string
Default: "asc"
Enum: "asc" "desc"
order[notes]
string
Default: "asc"
Enum: "asc" "desc"
code_end_with
string
code_partial
string
code_start_with
string
code
string
code[]
Array of strings
convertedPrice_range[between]
string
convertedPrice_range[gt]
string
convertedPrice_range[gte]
string
convertedPrice_range[lt]
string
convertedPrice_range[lte]
string
convertedPrice
string
convertedPrice[]
Array of strings
createdAt[before]
string
createdAt[strictly_before]
string
createdAt[after]
string
createdAt[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
discountPrice_range[between]
string
discountPrice_range[gt]
string
discountPrice_range[gte]
string
discountPrice_range[lt]
string
discountPrice_range[lte]
string
discountPrice
string
discountPrice[]
Array of strings
discountable
boolean
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
invoice
string
invoice[]
Array of strings
notes_end_with
string
notes_partial
string
notes_start_with
string
notes
string
notes[]
Array of strings
number_range[between]
string
number_range[gt]
string
number_range[gte]
string
number_range[lt]
string
number_range[lte]
string
number
string
number[]
Array of strings
price_range[between]
string
price_range[gt]
string
price_range[gte]
string
price_range[lt]
string
price_range[lte]
string
price
string
price[]
Array of strings
priority_range[between]
string
priority_range[gt]
string
priority_range[gte]
string
priority_range[lt]
string
priority_range[lte]
string
priority
integer
priority[]
Array of integers
product
string
product[]
Array of strings
scan_end_with
string
scan_partial
string
scan_start_with
string
scan
string
scan[]
Array of strings
slug_end_with
string
slug_partial
string
slug_start_with
string
slug
string
slug[]
Array of strings
taxes
boolean
timestamp[before]
string
timestamp[strictly_before]
string
timestamp[after]
string
timestamp[strictly_after]
string
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": {
    }
}