API docs by Redocly

PHPR API (3.7.0)

Download OpenAPI specification:

PHPR API USING API-PLATFORM

accounting_transactions

Retrieves the collection of accounting_transactions resources.

Retrieves the collection of accounting_transactions 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[child]
boolean
exists[comment]
boolean
exists[systemTrace]
boolean
exists[origin]
boolean
exists[refTable]
boolean
exists[refRowId]
boolean
exists[entries]
boolean
exists[period]
boolean
exists[notes]
boolean
exists[metadata]
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[date]
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[comment]
string
Default: "asc"
Enum: "asc" "desc"
order[systemTrace]
string
Default: "asc"
Enum: "asc" "desc"
order[notes]
string
Default: "asc"
Enum: "asc" "desc"
order[metadata]
string
Default: "asc"
Enum: "asc" "desc"
order[origin]
string
Default: "asc"
Enum: "asc" "desc"
order[refTable]
string
Default: "asc"
Enum: "asc" "desc"
order[slug]
string
Default: "asc"
Enum: "asc" "desc"
order[refRowId]
string
Default: "asc"
Enum: "asc" "desc"
order[id]
string
Default: "asc"
Enum: "asc" "desc"
comment_end_with
string
comment_partial
string
comment_start_with
string
comment
string
comment[]
Array of strings
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
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
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
origin_end_with
string
origin_partial
string
origin_start_with
string
origin
string
origin[]
Array of strings
parent
string
parent[]
Array of strings
period
string
period[]
Array of strings
refRowId_range[between]
string
refRowId_range[gt]
string
refRowId_range[gte]
string
refRowId_range[lt]
string
refRowId_range[lte]
string
refRowId
integer
refRowId[]
Array of integers
refTable_end_with
string
refTable_partial
string
refTable_start_with
string
refTable
string
refTable[]
Array of strings
slug_end_with
string
slug_partial
string
slug_start_with
string
slug
string
slug[]
Array of strings
systemTrace_end_with
string
systemTrace_partial
string
systemTrace_start_with
string
systemTrace
string
systemTrace[]
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 accounting_transactions resource.

Creates a accounting_transactions resource.

Authorizations:
JWT
Request Body schema:
required

The new accounting_transactions resource

accounting_transactions.jsonld-add_post (object) or null
accounting_transactions.jsonld-add_post (object) or null
date
string <date-time>
comment
string or null
systemTrace
string or null
origin
string or null
refTable
string or null
refRowId
integer or null
Array of objects (accounting_entries.jsonld-add_post)

Get entries.

accounting_periods.jsonld-add_post (object) or null

Get period.

notes
string or null
required
object (accounting_transactiontypes.jsonld-add_post)

TransactionType.

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

DB Identifier

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

Responses

Request samples

Content type
{
  • "child": { },
  • "parent": { },
  • "date": "2019-08-24T14:15:22Z",
  • "comment": "string",
  • "systemTrace": "string",
  • "origin": "string",
  • "refTable": "string",
  • "refRowId": 0,
  • "entries": [
    ],
  • "period": {
    },
  • "notes": "string",
  • "type": {
    },
  • "deletedAt": "2019-08-24T14:15:22Z",
  • "slug": "string",
  • "customData": [
    ],
  • "disabledAt": "2019-08-24T14:15:22Z"
}

Response samples

Content type
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "child": { },
  • "parent": { },
  • "date": "2019-08-24T14:15:22Z",
  • "comment": "string",
  • "ref": "string",
  • "systemTrace": "string",
  • "origin": "string",
  • "refTable": "string",
  • "refRowId": 0,
  • "period": {
    },
  • "type": {
    },
  • "shortcode": "N",
  • "metadata": "string",
  • "deletedAt": "2019-08-24T14:15:22Z",
  • "id": 0,
  • "slug": "string",
  • "customProperties": null,
  • "customData": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "disabledAt": "2019-08-24T14:15:22Z",
  • "toString": "string",
  • "transactionRawComment": "string",
  • "entriesListing": "string",
  • "transactionSum": 0,
  • "transactionTotalAmount": 0,
  • "anonymousToken": "string",
  • "uniqueId": "string",
  • "taggingListing": "string",
  • "enabled": true,
  • "disabled": true
}