Developers
API referenceReferenceReports

Accounting period - Retrieve

Retrieve one accounting period (`period_id`) for the selected business (`business_slug`).

GET
/v1/business/{business_slug}/period/{period_id}/

Path Parameters

business_slug*string

Business slug that scopes this request. If you do not have one yet, call common_accessible_businesses_list and pick a slug from the response.

period_id*integer

Identifier of the target period. If the ID is not known, use the corresponding list endpoint with relevant filters and/or the search parameter to discover valid IDs.

Response Body

application/json

curl -X GET "https://example.com/v1/business/string/period/0/"
{  "id": 0,  "created_at": "2019-08-24T14:15:22Z",  "updated_at": "2019-08-24T14:15:22Z",  "start_date": "2019-08-24",  "end_date": "2019-08-24",  "has_began": true,  "has_ended": true,  "is_ensured": true,  "is_depreciations_recorded": true,  "is_depreciations_ensured": true,  "is_deferrals_recorded": true,  "is_taxed": true,  "is_deducted": true,  "is_locked": true,  "is_reported": true}