PUT
Save a statement note (organization)
Organization space Accounting module For: Accountant · Permission: journal_entries.viewreports, statement_note_inputs.update 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 fiscal_year_id is required and must be a fiscal year of the book.
  • The note must be one filled in by hand (declarative mode); computed and sourced notes are refused with a business-rule error (note_not_declarative).
  • The payload must not exceed 65536 bytes once encoded as JSON (UTF-8 unescaped); a larger payload is refused.
  • The note code must exist in the catalogue, otherwise the call answers 404.
What else happens
  • Creates the stored entry of this note for the book and fiscal year on the first call; later calls replace its payload entirely, and the previous content is not kept.
  • Records the caller as the last editor (updated_by and updated_by_type) and refreshes updated_at.
  • Later reads of the notes list or the note view of the same book and year return the new content.
Part of Official annual statements.

Authorizations

Authorization
string
header
required

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

Path Parameters

noteCode
string
required

Code of the note in the statement note catalogue (for example 3A). Matched exactly; a code that is not in the catalogue answers 404. In the organization space the OpenAPI path repeats this name where the book identifier belongs: the first segment is the book identifier and the last is the note code.

Query Parameters

response
enum<string>
default:none

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

Available options:
none,
resource
fields
string

Comma-separated JSON keys of the root resource (id is always rendered). Available: id, owner_type, fiscal_year_id, note_code, payload, updated_by, updated_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: .

Body

application/json

Whether the note accepts input at all is decided by the service (note_not_declarative).

fiscal_year_id
string
required

Identifier of the fiscal year (27-character KSUID string) the note belongs to. Required; it must be a fiscal year of the selected book.

payload
required

Content of the note, entered by a member: a JSON object or array whose shape follows the note. Required. Its JSON encoding must not exceed 65536 bytes. It replaces the previous content of this note for the book and year.

Response

Resource (only with response=resource).

id

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

owner_type

Kind of owner of the book the note belongs to, as stored on its accounting records.

fiscal_year_id

Identifier of the fiscal year the note belongs to (27-character KSUID string).

note_code

Code of the note in the statement catalogue, as sent in the URL.

payload

Content saved for the note, as sent in the request: a JSON object or array.

updated_by

Identifier of the member or agent account who last saved the note (27-character KSUID string). Set by the server from the caller; may be null.

updated_by_type

Kind of actor recorded in updated_by. Set by the server from the caller; may be null.

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).