Get accounting period

GET /api/v1/accounting-periods/{period_id}

Get details of a specific accounting period.

Operation ID: get_period_api_v1_accounting_periods__period_id__get · View as markdown · OpenAPI slice

Authentication

Bearer token authentication. Pass your DayZero API token in the Authorization header and the target business UUID in x-business-id.

Parameters

Path

period_id string required

Responses

200 Successful Response

Schema: AccountingPeriodResponse

id string required: Period UUID
business_id string required: Business UUID
period_start string · date required: Start date of the period
period_end string · date required: End date of the period
status string required: Status: open, closed, or locked
closed_at string · date-time: When period was closed
closed_by_user_id string: User who closed the period
lock_reason string: Reason period was closed
reopen_reason string: Reason period was reopened
reopened_at string · date-time: When period was reopened
reopened_by_user_id string: User who reopened the period
created_at string · date-time required: Creation timestamp
updated_at string · date-time required: Last update timestamp

401 Unauthorized - Authentication required

403 Forbidden - Insufficient permissions

404 Not Found - Resource does not exist

422 Validation Error

Schema: HTTPValidationError

detail array · ValidationError ValidationError

5 fields

loc array · string | integer required
msg string required
type string required
input object
ctx object

Code samples

GET /api/v1/accounting-periods/{period_id}

bash

curl -X GET 'https://api.ondayzero.com/api/v1/accounting-periods/{period_id}' \
  -H 'Authorization: Bearer dz_your_token' \
  -H 'x-business-id: YOUR_BUSINESS_ID'

javascript

const response = await fetch('https://api.ondayzero.com/api/v1/accounting-periods/{period_id}', {
  method: 'GET',
  headers: {
    Authorization: 'Bearer dz_your_token',
    'x-business-id': 'YOUR_BUSINESS_ID',
  },
});
const data = await response.json();

python

import httpx

headers = {
    "Authorization": "Bearer dz_your_token",
    "x-business-id": "YOUR_BUSINESS_ID",
}

response = httpx.get("https://api.ondayzero.com/api/v1/accounting-periods/{period_id}", headers=headers)
data = response.json()