API docs by Redocly

PHPR API (3.7.0)

Download OpenAPI specification:

PHPR API USING API-PLATFORM

invoices

Retrieves the collection of invoices resources.

Retrieves the collection of invoices 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[taxes]
boolean
exists[coordinate]
boolean
exists[project]
boolean
exists[notes]
boolean
exists[conditions]
boolean
exists[payments]
boolean
exists[lines]
boolean
exists[inventoryEntries]
boolean
exists[chargedBillLines]
boolean
exists[chargedRents]
boolean
exists[chargedTimesheets]
boolean
exists[chargedAllowances]
boolean
exists[followups]
boolean
exists[clientRef]
boolean
exists[shipments]
boolean
exists[batches]
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[date]
string
Default: "asc"
Enum: "asc" "desc"
order[deliveryDate]
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[notes]
string
Default: "asc"
Enum: "asc" "desc"
order[conditions]
string
Default: "asc"
Enum: "asc" "desc"
order[clientRef]
string
Default: "asc"
Enum: "asc" "desc"
order[slug]
string
Default: "asc"
Enum: "asc" "desc"
order[autoEmail]
string
Default: "asc"
Enum: "asc" "desc"
order[autoInterests]
string
Default: "asc"
Enum: "asc" "desc"
order[conversionRate]
string
Default: "asc"
Enum: "asc" "desc"
order[id]
string
Default: "asc"
Enum: "asc" "desc"

Responses

Response samples

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