API docs by Redocly

PHPR API (3.7.0)

Download OpenAPI specification:

PHPR API USING API-PLATFORM

invoice_payments

Retrieves the collection of invoice_payments resources.

Retrieves the collection of invoice_payments 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[ref]
boolean
exists[note]
boolean
exists[metadata]
boolean
exists[confirmedAt]
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[depositDate]
string
Default: "asc"
Enum: "asc" "desc"
order[confirmedAt]
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[amount]
string
Default: "asc"
Enum: "asc" "desc"
order[ref]
string
Default: "asc"
Enum: "asc" "desc"
order[slug]
string
Default: "asc"
Enum: "asc" "desc"
order[note]
string
Default: "asc"
Enum: "asc" "desc"
order[metadata]
string
Default: "asc"
Enum: "asc" "desc"
order[id]
string
Default: "asc"
Enum: "asc" "desc"
amount_range[between]
string
amount_range[gt]
string
amount_range[gte]
string
amount_range[lt]
string
amount_range[lte]
string
amount
string
amount[]
Array of strings
confirmedAt[before]
string
confirmedAt[strictly_before]
string
confirmedAt[after]
string
confirmedAt[strictly_after]
string
createdAt[before]
string
createdAt[strictly_before]
string
createdAt[after]
string
createdAt[strictly_after]
string
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
depositDate[before]
string
depositDate[strictly_before]
string
depositDate[after]
string
depositDate[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
invoice
string
invoice[]
Array of strings
metadata_end_with
string
metadata_partial
string
metadata_start_with
string
metadata
string
metadata[]
Array of strings
note_end_with
string
note_partial
string
note_start_with
string
note
string
note[]
Array of strings
ref_end_with
string
ref_partial
string
ref_start_with
string
ref
string
ref[]
Array of strings
slug_end_with
string
slug_partial
string
slug_start_with
string
slug
string
slug[]
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": {
    }
}