Skip to main content
GET
List accounting periods

Authorizations

X-API-Key
string
header
required

Your organization API key. Some operations also need a key that is associated with a user; their pages say so.

Query Parameters

start_date
string<date>

Exact start date of the period (YYYY-MM-DD), such as 2026-09-01. Not a lower bound.

accounting_period_ids
string[]

IDs to return, separated by commas. The other filters also apply.

Required array length: 1 - 100 elements
Minimum string length: 1

Filter by one or more legal entity IDs. Omit to include all authorized entities. An empty list is invalid.

include_count
boolean

Include the total number of matching records. If the count cannot be calculated, the request fails.

limit
integer
default:25

Maximum number of records to return.

Required range: 1 <= x <= 100
cursor
string

The next_cursor value from the previous page. Keep the other filters unchanged.

status
enum<string>

Filter by period status.

Available options:
open,
soft_closed,
closed

Response

The matching records.

data
object[]
required

The records.

has_more
boolean
required

Whether another page is available.

next_cursor
string | null
required

Cursor for the next page, or null on the last page.

total_count
integer

Total matching records across all pages. Present when include_count=true.

Required range: x >= 0