Preview what to remember

Preview what to remember in the credential-bound company. This preview validates and describes the proposed effects without writing changes. The required Idempotency-Key coordinates this operation but does not provide durable response replay. Requires the memory:write OAuth scope.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Proposed values used to preview what to remember without persisting changes.

What memory.remember.preview and memory.remember (Brain foundation
M6w) ask memory to keep: the kinds the public surface offers, in the
columns of §8.4. Only the request's own shape is checked here; what the
write may say (subjects, objects and slots a kind takes, figures, payroll,
permissions) is the memory seam's, which refuses with a code.

Never also_rule: a rule is saved only by a person's own tap in the app
(OD5), and every write here is a proposal (MD15).

string
enum
required

What to keep: a ruling or another instruction about a supplier, a customer or the company (instruction), a note (note), VAT returns filed outside Cybooks for a period (vat_filed_elsewhere), or your own preference (prefers).

Allowed:
string | null

What it is about: vendor:, customer:, payment_account:, vat_quarter:

string | null
enum

An instruction's ruling class (fee_lines, no_vat_invoice, private_spend, what_it_is, standing_reference, dividends or customs_documents; omit for a free instruction), or a preference's family (style or language)

string | null

What a ruling names (account:, tax_rule:, or for customs_documents document_kind:courier_customs_invoice or document_kind:ordinary_bill), or a preference's value (style:short, style:detailed, language:el, language:en)

string | null

The words, at most 280 characters once kept. An account code or a tax rule's name in them becomes a placeholder the preview shows. Never an amount, a percentage or a rate, never payroll

date | null

From this day (YYYY-MM-DD); for vat_filed_elsewhere, the first day of the period filed elsewhere

date | null

Until this day (YYYY-MM-DD); for vat_filed_elsewhere, the last day of the period filed elsewhere

Headers
string
required
length ≤ 191

Required operation-specific request key. This requirement does not imply durable public API response replay.

Responses

Language
Credentials
OAuth2
Missing 1 required scope
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
*/*