POST
Share an accounting export (organization)
Organization space Accounting module For: Accountant · Permission: accounting_exports.share 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.
  • The content also needs a permission: journal_entries.export for fec, statement_filings.export for liasse.
  • expires_in_days, when sent, must be an integer from 1 to 30; recipient_label, when sent, is at most 255 characters.
What else happens
  • Creates a share link for the export with a random 64-character token; only the SHA-256 hash of the token is stored, so the token is returned in this response only.
  • Sets the expiry to now plus expires_in_days (7 days when omitted) and records the creator.
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.

Body

application/json
recipient_label
string | null

Optional free-text label saying who the link is for, at most 255 characters. Stored as given and shown in the share list.

Maximum string length: 255
expires_in_days
integer | null

Number of days the share link stays valid, from 1 to 30. Optional; defaults to 7.

Required range: 1 <= x <= 30

Response

The response is of type string.