API docs by Redocly

PHPR API (3.7.0)

Download OpenAPI specification:

PHPR API USING API-PLATFORM

bills

Retrieves the collection of bills resources.

Retrieves the collection of bills 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[lines]
boolean
exists[inventoryEntries]
boolean
exists[payments]
boolean
exists[number]
boolean
exists[project]
boolean
exists[taxes]
boolean
exists[shipments]
boolean
exists[batches]
boolean
exists[notes]
boolean
exists[conditions]
boolean
exists[coordinate]
boolean
exists[followups]
boolean
exists[supplierRef]
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[number]
string
Default: "asc"
Enum: "asc" "desc"
order[supplierRef]
string
Default: "asc"
Enum: "asc" "desc"
order[slug]
string
Default: "asc"
Enum: "asc" "desc"
order[notes]
string
Default: "asc"
Enum: "asc" "desc"
order[conditions]
string
Default: "asc"
Enum: "asc" "desc"
order[conversionRate]
string
Default: "asc"
Enum: "asc" "desc"
order[id]
string
Default: "asc"
Enum: "asc" "desc"
conditions_end_with
string
conditions_partial
string
conditions_start_with
string
conditions
string
conditions[]
Array of strings
conversionRate_range[between]
string
conversionRate_range[gt]
string
conversionRate_range[gte]
string
conversionRate_range[lt]
string
conversionRate_range[lte]
string
conversionRate
string
conversionRate[]
Array of strings
coordinate
string
coordinate[]
Array of strings
createdAt[before]
string
createdAt[strictly_before]
string
createdAt[after]
string
createdAt[strictly_after]
string
currency
string
currency[]
Array of strings
date[before]
string
date[strictly_before]
string
date[after]
string
date[strictly_after]
string
deletedAt[before]
string
deletedAt[strictly_before]
string
deletedAt[after]
string
deletedAt[strictly_after]
string
deliveryDate[before]
string
deliveryDate[strictly_before]
string
deliveryDate[after]
string
deliveryDate[strictly_after]
string
disabledAt[before]
string
disabledAt[strictly_before]
string
disabledAt[after]
string
disabledAt[strictly_after]
string
distributionType
string
distributionType[]
Array of strings
employee
string
employee[]
Array of strings
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
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
payer
string
payer[]
Array of strings
project
string
project[]
Array of strings
slug_end_with
string
slug_partial
string
slug_start_with
string
slug
string
slug[]
Array of strings
status
string
status[]
Array of strings
supplier
string
supplier[]
Array of strings
supplierRef_end_with
string
supplierRef_partial
string
supplierRef_start_with
string
supplierRef
string
supplierRef[]
Array of strings
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": {
    }
}