GET
List fiscal periods (organization)
Organization space Accounting module For: Accountant · Permission: fiscal_periods.list Conditions
  • The book must be one the caller’s access opens.
  • The accounting module must be part of the organization’s plan.
Part of Fiscal years and periods.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

book
string
required

Identifier of the book (the organization or one of its companies), 27-character KSUID.

Query Parameters

per_page
integer | null

Number of items per page.

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

Position in the list. Pass the meta.next_cursor or meta.prev_cursor value of the previous page; leave it out to get the first page.

sort_by
enum<string> | null

Field the list is sorted by.

Available options:
start_date,
created_at
sort_order
enum<string> | null

asc for ascending order, desc for descending order.

Available options:
asc,
desc
fiscal_year_id
string | null

Identifier of a fiscal year of the book; only the periods of that year are returned. Without it, periods of every year are listed.

response
enum<string>
default:resource

Response mode. Default resource; none answers 204 No Content.

Available options:
resource
fields
string

Comma-separated JSON keys of the root resource (id is always rendered). Available: id, owner_type, fiscal_year_id, label, start_date, end_date, is_closed, closed_at, created_at, updated_at.

include
string

Comma-separated include paths, each optionally followed by its fields in parentheses: units(id,sku),units.uomUnit(id,name). Max depth 6, max 40 paths. Available: .

Response

Resource.

data
FiscalPeriodResource · object[]
required

Items of this page.

meta
object
required

Pagination details.