Capabilities

memories.save

Changed on

Save a long-term memory, preference, canonical mapping, workflow hint, or deterministic document policy.

post/capabilities/memories.save

Request

  • Base URL: https://developer.api.receiptor.ai/v1
  • URL: https://developer.api.receiptor.ai/v1/capabilities/memories.save
  • Auth: one of:
    • API key in header x-receiptor-api-key
    • HTTP bearer

Request body

titlestring required
summarystring required
textstring
kind'preference' | 'canonical_mapping' | 'workflow_hint' | 'document_policy'
scope'user' | 'org' | 'document'
documentIdstring
mappingType'merchant_canonicalization' | 'category_preference' | 'label_preference'
fromstring
tostring
merchantstring
labelsstring[]
chartOfAccountsIdstring
chartAccountIdstring
policyDomain'recurring'

Document policy domain. Use recurring for subscription or repeat-charge decisions.

policyAction'not_recurring' | 'stopped' | 'set_recurring_schedule'

Deterministic action to apply when the document policy matcher applies.

amountinteger nullable

Optional amount in the currency's minor units.

currencystring nullable

Optional ISO currency code for amount matching.

amountToleranceinteger nullable

Optional amount tolerance in minor currency units.

recurringType'subscription' | 'retainer' | 'membership' | 'license' | 'lease' | 'installment' nullable

Optional recurring type matcher.

recurringFrequency'weekly' | 'bi-weekly' | 'monthly' | 'quarterly' | 'semi-annual' | 'annual' nullable

Optional recurring frequency matcher.

setRecurringType'subscription' | 'retainer' | 'membership' | 'license' | 'lease' | 'installment' nullable

Recurring type to set when policyAction is set_recurring_schedule.

setRecurringFrequency'weekly' | 'bi-weekly' | 'monthly' | 'quarterly' | 'semi-annual' | 'annual' nullable

Recurring frequency to set when policyAction is set_recurring_schedule.

sourceDocumentIdstring nullable

Optional source document ID.

notestring nullable

Optional user note explaining the policy.

Response

Successful response

successboolean
codeinteger

Example response

{
  "success": true,
  "code": 200
}

Changes