List Suggestions

GET

/suggestions

curl --request GET \
  --url 'https://example.com/suggestions?status=open&include_snoozed=false&limit=25'

The inbox: open suggestions by confidence (snoozed ones hidden until their date unless include_snoozed). kind narrows it to schedules, to the transfer-link rules manual confirms proposed, or to the matcher’s open match proposals.

Parameters

Query Parameters

status

Status

string

default: open

Allowed values: open accepted rejected withdrawn all

kind

Any of:

string

string

Allowed values: schedule transfer_link match

null

null

account

Any of:

string

string

null

null

Account id or path (either side)

include_snoozed

Include Snoozed

boolean

limit

Limit

integer

default: 25 >= 1 <= 25

Responses

200

Successful Response

Media typeapplication/json

Response List Suggestions Suggestions Get

Array<object>

SuggestionOut

object

confidence

required

Any of:

string

string

null

null

created_at

required

Created At

string

decided_at

required

Any of:

string

string

null

null

draft

required

Draft

The typed draft accept applies unchanged. schedule: name, account, counterparty_account, rrule, dtstart, amount_type, amount, estimate_basis, payee, category, autopost_policy. transfer_link: from_account, to_account, payee, payee_id, amount_exact, window_days, effective_from. match: expected_id, posted_id, account, label, expected_date, expected_amount, posted_date, posted_amount, variance (posted - expected).

object

key

additional properties

any

evidence

Any of:

object

object

key

additional properties

any

null

null

evidence_summary

required

Evidence Summary

object

key

additional properties

any

headline

required

Headline

string

id

required

Id

string format: uuid

kind

required

Kind

Schedule: a recurring bill or transfer to expect (draft = a schedule). transfer_link: proposed by a manual transfer confirm (draft = a transfer_link rule for that account pair, scoped to the payee and its aliases). match: an open match proposal pairing an expected row with a bank row (draft = the pair; accept confirms it, reject rejects it for good).

string

Allowed values: schedule transfer_link match

reject_scope

required

Any of:

string

string

null

null

result_entity_id

required

Any of:

string

string format: uuid

null

null

result_entity_type

required

Any of:

string

string

null

null

seen_count

required

Seen Count

integer

snooze_until

required

Any of:

string

string format: date

null

null

source

required

Source

Detected | agent | account_added | confirm

string

status

required

Status

Open | accepted | rejected | withdrawn (closed by the system: the match proposal it mirrored was rescinded, carried or purged)

string

Example

[
  {
    "kind": "schedule"
  }
]

422

Validation Error

Media typeapplication/json

HTTPValidationError

object

detail

Detail

Array<object>

ValidationError

object

ctx

Context

object

input

Input

loc

required

Location

Array

msg

required

Message

string

type

required

Error Type

string

Example ^generated

{
  "detail": [
    {
      "ctx": {},
      "input": "example",
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}