GET
List fiscal events (client account)
Client space Accounting module For: Accountant · Permission: fiscal_events.list Conditions
  • The accounting module must be part of the organization’s plan.
  • Page size is at most 100; sorting is by created_at only.
Part of Close the fiscal year.

Authorizations

Authorization
string
header
required

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

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:
created_at
sort_order
enum<string> | null

asc for ascending order, desc for descending order.

Available options:
asc,
desc
profile
enum<string> | null

Keeps only events of this profile: provision, regularization (accruals and deferrals), derogatory_depreciation or reinvestment_gain.

Available options:
provision,
regularization,
derogatory_depreciation,
reinvestment_gain
status
enum<string> | null

Keeps only events with this status: open, partially_reversed, reversed or cancelled.

Available options:
open,
partially_reversed,
reversed,
cancelled
subtype
string | null

Keeps only events of this subtype (for example litigation, inventory, cca, pca), up to 64 characters.

Maximum string length: 64
fiscal_year_id
string | null

Keeps only events of the fiscal year with this identifier (27-character KSUID string).

overdue
boolean | null

When true, keeps only events whose expected reversal date is before today and that are still open or partially reversed. Omitted or false applies no such filter.

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, profile, subtype, label, description, fiscal_year_id, provision_account_id, counterpart_account_id, subject_type, subject_id, amount, reversed_amount, status, expected_reversal_on, currency_code, currency_exponent, dotation_journal_entry_id, origin_journal_entry_id, created_by, created_by_type, created_at, updated_at, remaining_amount.

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: provisionAccount, counterpartAccount, fiscalYear, reversals.

Response

Resource.

data
FiscalEventResource · object[]
required

Items of this page.

meta
object
required

Pagination details.