GET
List filings (organization)
Organization space Accounting module For: Accountant · Permission: statement_filings.list Conditions
  • The accounting module must be part of the organization’s plan.
  • In the organization space, the caller must have access to the book.
  • The book must have accounting set up (at least one journal).
  • fiscal_year_id, when sent, must be a fiscal year of the book.
  • status, when sent, must be draft, filed or superseded.
  • sort_by accepts generated_at or created_at; per_page is 1 to 100.
Part of File annual statements.

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 accounting book (27-character KSUID string) whose records are worked on.

Query Parameters

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, system, status, generated_at, generated_by, generated_by_type, filed_at, filed_by, filed_by_type, supersedes_filing_id, 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: fiscalYear.

Response

Resource.

data
StatementFilingListResource · object[]
required

Items of this page.

meta
object
required

Pagination details.