GET
View an export (client account)
Client space Accounting module For: Accountant · Permission: accounting_exports.retrieve Conditions
  • The accounting module must be part of the organization’s plan.
  • The book must have accounting set up.
Part of Export and share accounting files.

Authorizations

Authorization
string
header
required

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

Path Parameters

export
string
required

Identifier of the accounting export (27-character KSUID string); it must belong to the selected book.

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, kind, fiscal_year_id, params, original_name, mime_type, size, generated_at, generated_by, generated_by_type, 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.

id

Identifier of the stored export (27-character KSUID string).

owner_type

Kind of book that owns the export: organization, company or client account.

kind

Kind of file: fec is the journal entries CSV in the audit-file layout; liasse is the PDF of the filed annual statements.

fiscal_year_id

Fiscal year the export covers (27-character KSUID string).

params

Filters sent when the file was generated: journal_id, from and to. They are stored as sent but only used for a fec export; a liasse export ignores them.

original_name

File name offered when the file is downloaded.

mime_type

Content type of the file: text/csv; charset=UTF-8 for fec, application/pdf for liasse.

size
integer

Size of the stored file in bytes.

generated_at

Date and time the file was generated (ISO 8601).

generated_by

Identifier of the member or agent account who generated the file; null when the actor could not be resolved.

generated_by_type

Type of the actor who generated the file (its morph alias); null when the actor could not be resolved.

created_at

Date and time the record was created (ISO 8601, UTC).

updated_at

Date and time the record was last changed (ISO 8601, UTC).