API docs by Redocly

PHPR API (3.7.0)

Download OpenAPI specification:

PHPR API USING API-PLATFORM

accounts

Retrieves the collection of accounts resources.

Retrieves the collection of accounts 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[entries]
boolean
exists[ref]
boolean
exists[igrf]
boolean
exists[metadata]
boolean
exists[parent]
boolean
exists[children]
boolean
exists[notes]
boolean
exists[deletedAt]
boolean
exists[customProperties]
boolean
exists[disabledAt]
boolean
exists[root]
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[ref]
string
Default: "asc"
Enum: "asc" "desc"
order[igrf]
string
Default: "asc"
Enum: "asc" "desc"
order[slug]
string
Default: "asc"
Enum: "asc" "desc"
order[metadata]
string
Default: "asc"
Enum: "asc" "desc"
order[notes]
string
Default: "asc"
Enum: "asc" "desc"
order[isRepertoire]
string
Default: "asc"
Enum: "asc" "desc"
order[acceptsTransactions]
string
Default: "asc"
Enum: "asc" "desc"
order[budget]
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[id]
string
Default: "asc"
Enum: "asc" "desc"
order[root]
string
Default: "asc"
Enum: "asc" "desc"
order[lvl]
string
Default: "asc"
Enum: "asc" "desc"
order[lft]
string
Default: "asc"
Enum: "asc" "desc"
order[rgt]
string
Default: "asc"
Enum: "asc" "desc"
acceptsTransactions
boolean
budget_range[between]
string
budget_range[gt]
string
budget_range[gte]
string
budget_range[lt]
string
budget_range[lte]
string
budget
string
budget[]
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
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
igrf_end_with
string
igrf_partial
string
igrf_start_with
string
igrf
string
igrf[]
Array of strings
isRepertoire
boolean
lft_range[between]
string
lft_range[gt]
string
lft_range[gte]
string
lft_range[lt]
string
lft_range[lte]
string
lft
integer
lft[]
Array of integers
lvl_range[between]
string
lvl_range[gt]
string
lvl_range[gte]
string
lvl_range[lt]
string
lvl_range[lte]
string
lvl
integer
lvl[]
Array of integers
metadata_end_with
string
metadata_partial
string
metadata_start_with
string
metadata
string
metadata[]
Array of strings
notes_end_with
string
notes_partial
string
notes_start_with
string
notes
string
notes[]
Array of strings
parent
string
parent[]
Array of strings
ref_end_with
string
ref_partial
string
ref_start_with
string
ref
string
ref[]
Array of strings
rgt_range[between]
string
rgt_range[gt]
string
rgt_range[gte]
string
rgt_range[lt]
string
rgt_range[lte]
string
rgt
integer
rgt[]
Array of integers
root_range[between]
string
root_range[gt]
string
root_range[gte]
string
root_range[lt]
string
root_range[lte]
string
root
integer
root[]
Array of integers
slug_end_with
string
slug_partial
string
slug_start_with
string
slug
string
slug[]
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": {
    }
}

Creates a accounts resource.

Creates a accounts resource.

Authorizations:
JWT
Request Body schema:
required

The new accounts resource

object (account_types.jsonld-add_post)

AccountType.

ref
string or null
igrf
string or null
metadata
string or null
isRepertoire
required
boolean
acceptsTransactions
required
boolean
Default: true
budget
required
string
accounts.jsonld-add_post (object) or null
children
Array of objects (accounts.jsonld-add_post)

// MUST BE MAPPED IN ENTITY

deletedAt
string or null <date-time>
slug
required
string

DB Identifier

customData
Array of strings or null
disabledAt
string or null <date-time>
apiTranslations
Array of strings
title
any

Responses

Request samples

Content type
{
  • "type": {
    },
  • "ref": "string",
  • "igrf": "string",
  • "metadata": "string",
  • "isRepertoire": true,
  • "acceptsTransactions": true,
  • "budget": "string",
  • "parent": { },
  • "children": [
    ],
  • "deletedAt": "2019-08-24T14:15:22Z",
  • "slug": "string",
  • "customData": [
    ],
  • "disabledAt": "2019-08-24T14:15:22Z",
  • "apiTranslations": [
    ],
  • "title": null
}

Response samples

Content type
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "type": {
    },
  • "ref": "string",
  • "igrf": "string",
  • "metadata": "string",
  • "isRepertoire": true,
  • "acceptsTransactions": true,
  • "parent": { },
  • "children": [
    ],
  • "notes": "string",
  • "shortcode": "AC",
  • "deletedAt": "2019-08-24T14:15:22Z",
  • "id": 0,
  • "slug": "string",
  • "customData": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "disabledAt": "2019-08-24T14:15:22Z",
  • "root": 0,
  • "lvl": 0,
  • "lft": 0,
  • "rgt": 0,
  • "toString": "string",
  • "accountFullName": "string",
  • "accountToolTip": "string",
  • "accountName": "string",
  • "entriesListing": "string",
  • "translationsListing": "string",
  • "customPropertiesListing": "string",
  • "translationTitlePropertyName": "string",
  • "translationDescriptionPropertyName": "string",
  • "childrenListing": "string",
  • "leaf": true,
  • "leafApi": true,
  • "levelApi": 0,
  • "anonymousToken": "string",
  • "uniqueId": "string",
  • "taggingListing": "string",
  • "enabled": true,
  • "disabled": true
}