Skip to content
Purser

Get Suggestion

GET
/suggestions/{suggestion_id}
curl --request GET \
  --url https://example.com/suggestions/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0

One suggestion with its full evidence (the occurrences behind it, or for a transfer_link the confirmed pairs).

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
suggestion_id
required
Suggestion Id
string format: uuid

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
SuggestionOut
object
confidence
required
Any of:
string
created_at
required
Created At
string
decided_at
required
Any of:
string
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
key
additional properties
any
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
result_entity_id
required
Any of:
string format: uuid
result_entity_type
required
Any of:
string
seen_count
required
Seen Count
integer
snooze_until
required
Any of:
string format: date
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

Section titled “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"
    }
  ]
}