API docs by Redocly

PHPR API (3.7.0)

Download OpenAPI specification:

PHPR API USING API-PLATFORM

accounting_periods

Retrieves the collection of accounting_periods resources.

Retrieves the collection of accounting_periods 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[closedAt]
boolean
exists[periodicity]
boolean
exists[transactions]
boolean
exists[child]
boolean
exists[notes]
boolean
exists[closingAmount]
boolean
exists[closingDiff]
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[closedAt]
string
Default: "asc"
Enum: "asc" "desc"
order[dateStart]
string
Default: "asc"
Enum: "asc" "desc"
order[dateEnd]
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[yearEnd]
string
Default: "asc"
Enum: "asc" "desc"
order[notes]
string
Default: "asc"
Enum: "asc" "desc"
order[closingAmount]
string
Default: "asc"
Enum: "asc" "desc"
order[closingDiff]
string
Default: "asc"
Enum: "asc" "desc"
order[id]
string
Default: "asc"
Enum: "asc" "desc"
order[slug]
string
Default: "asc"
Enum: "asc" "desc"
closedAt[before]
string
closedAt[strictly_before]
string
closedAt[after]
string
closedAt[strictly_after]
string
closingAmount_range[between]
string
closingAmount_range[gt]
string
closingAmount_range[gte]
string
closingAmount_range[lt]
string
closingAmount_range[lte]
string
closingAmount
string
closingAmount[]
Array of strings
closingDiff_range[between]
string
closingDiff_range[gt]
string
closingDiff_range[gte]
string
closingDiff_range[lt]
string
closingDiff_range[lte]
string
closingDiff
string
closingDiff[]
Array of strings
createdAt[before]
string
createdAt[strictly_before]
string
createdAt[after]
string
createdAt[strictly_after]
string
dateEnd[before]
string
dateEnd[strictly_before]
string
dateEnd[after]
string
dateEnd[strictly_after]
string
dateStart[before]
string
dateStart[strictly_before]
string
dateStart[after]
string
dateStart[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
notes_end_with
string
notes_partial
string
notes_start_with
string
notes
string
notes[]
Array of strings
parent
string
parent[]
Array of strings
periodicity
string
periodicity[]
Array of strings
slug_end_with
string
slug_partial
string
slug_start_with
string
slug
string
slug[]
Array of strings
updatedAt[before]
string
updatedAt[strictly_before]
string
updatedAt[after]
string
updatedAt[strictly_after]
string
yearEnd
boolean

Responses

Response samples

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

Creates a accounting_periods resource.

Creates a accounting_periods resource.

Authorizations:
JWT
Request Body schema:
required

The new accounting_periods resource

closedAt
string or null <date-time>
dateStart
required
string <date-time>
dateEnd
string <date-time>
parameter_periods.jsonld-add_post (object) or null
yearEnd
required
boolean
accounting_periods.jsonld-add_post (object) or null
accounting_periods.jsonld-add_post (object) or null
notes
string or null
closingAmount
string or null
closingDiff
string or null
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
{
  • "closedAt": "2019-08-24T14:15:22Z",
  • "dateStart": "2019-08-24T14:15:22Z",
  • "dateEnd": "2019-08-24T14:15:22Z",
  • "periodicity": {
    },
  • "yearEnd": true,
  • "child": { },
  • "parent": { },
  • "notes": "string",
  • "closingAmount": "string",
  • "closingDiff": "string",
  • "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",
  • "closedAt": "2019-08-24T14:15:22Z",
  • "dateStart": "2019-08-24T14:15:22Z",
  • "dateEnd": "2019-08-24T14:15:22Z",
  • "periodicity": "https://example.com/",
  • "yearEnd": true,
  • "transactions": [],
  • "child": "https://example.com/",
  • "parent": "https://example.com/",
  • "notes": "string",
  • "shortcode": "AP",
  • "closingAmount": "string",
  • "closingDiff": "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",
  • "tags": [
    ],
  • "disabledAt": "2019-08-24T14:15:22Z",
  • "entityFiles": {
    },
  • "toString": "string",
  • "transactionsListing": "string",
  • "closed": true,
  • "periodClosed": true,
  • "numberDays": 0,
  • "periodNumberDays": 0,
  • "periodNumber": 0,
  • "accountingPeriodNumber": 0,
  • "customPropertiesListing": "string",
  • "apiShortname": "string",
  • "fullEntityString": "string",
  • "anonymousToken": "string",
  • "tokenString": "string",
  • "entityMetatadaEndpoint": "string",
  • "filesListing": "string",
  • "modificationHistoryListing": "string",
  • "notesListing": "string",
  • "ownershipsListing": "string",
  • "approvalsListing": "string",
  • "tableName": "string",
  • "fQCN": "string",
  • "uniqueId": "string",
  • "apiCustomData": null,
  • "timestamp": "2019-08-24T14:15:22Z",
  • "deleted": true,
  • "taggableType": "string",
  • "taggableId": 0,
  • "taggingListing": "string",
  • "enabled": true,
  • "enabledVirtual": true,
  • "disabled": true,
  • "entityStorageFolder": "string"
}