API docs by Redocly

PHPR API (3.7.0)

Download OpenAPI specification:

PHPR API USING API-PLATFORM

accounting_periods

Retrieves a accounting_periods resource.

Retrieves a accounting_periods resource.

Authorizations:
JWT
path Parameters
id
required
string

accounting_periods identifier

Responses

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": {
    },
  • "yearEnd": true,
  • "child": { },
  • "parent": { },
  • "shortcode": "AP",
  • "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",
  • "toString": "string",
  • "transactionsListing": "string",
  • "periodClosed": true,
  • "periodNumberDays": 0,
  • "accountingPeriodNumber": 0,
  • "customPropertiesListing": "string",
  • "anonymousToken": "string",
  • "uniqueId": "string",
  • "taggingListing": "string",
  • "enabled": true,
  • "disabled": true
}

Replaces the accounting_periods resource.

Replaces the accounting_periods resource.

Authorizations:
JWT
path Parameters
id
required
string

accounting_periods identifier

Request Body schema:
required

The updated accounting_periods resource

closedAt
string or null <date-time>
dateStart
required
string <date-time>
dateEnd
string <date-time>
parameter_periods.jsonld-post (object) or null
yearEnd
required
boolean
accounting_periods.jsonld-post (object) or null
accounting_periods.jsonld-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": {
    },
  • "yearEnd": true,
  • "child": { },
  • "parent": { },
  • "shortcode": "AP",
  • "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",
  • "toString": "string",
  • "transactionsListing": "string",
  • "periodClosed": true,
  • "periodNumberDays": 0,
  • "accountingPeriodNumber": 0,
  • "customPropertiesListing": "string",
  • "anonymousToken": "string",
  • "uniqueId": "string",
  • "taggingListing": "string",
  • "enabled": true,
  • "disabled": true
}

Removes the accounting_periods resource.

Removes the accounting_periods resource.

Authorizations:
JWT
path Parameters
id
required
string

accounting_periods identifier

Responses