Reset Instance

POST

/transactions/{tx_id}/reset-instance

curl --request POST \
  --url https://example.com/transactions/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/reset-instance

Hand a schedule instance back to its rule: unpinned, with the rule’s date (its slot), name, payee and current estimate — both legs of a transfer. When the rule no longer produces the slot, or estimates nothing, the instance is voided and its slot released instead. Live instances of active schedules only.

Parameters

Path Parameters

tx_id

required

Tx Id

string format: uuid

Responses

200

Successful Response

Media typeapplication/json

TransactionDetail

Full detail: postings and provenance links.

object

account_path

required

Any of:

string

string

null

null

amount

required

Any of:

string

string

null

null

balance

Any of:

string

string

null

null

category_path

required

Any of:

string

string

null

null

category_source

Any of:

string

string

null

null

content_hash

required

Any of:

string

string

null

null

created_at

required

Created At

string format: date-time

created_by

required

Any of:

string

string format: uuid

null

null

date

required

Date

string format: date

description

required

Any of:

string

string

null

null

escalated_at

Any of:

string

string format: date-time

null

null

has_linked_originals

Has Linked Originals

boolean

id

required

Id

string format: uuid

is_transfer

required

Is Transfer

boolean

needs_review

required

Needs Review

True when the row is in the unreviewed set (#175): the same test as GET /transactions?reviewed=false and the review count

boolean

origin

required

Origin

string

payee

required

Any of:

string

string

null

null

postings

required

Postings

Array<object>

PostingOut

object

account_id

required

Account Id

string format: uuid

account_path

Any of:

string

string

null

null

amount

required

Amount

string

currency

required

Currency

string

id

required

Id

string format: uuid

memo

required

Any of:

string

string

null

null

remainder_amount

Any of:

string

string

null

null

reverses_id

required

Any of:

string

string format: uuid

null

null

reviewed_at

Any of:

string

string format: date-time

null

null

schedule_id

Any of:

string

string format: uuid

null

null

schedule_pinned

Schedule Pinned

boolean

source_fetch_id

required

Any of:

string

string format: uuid

null

null

split_lines

Split Lines

Category legs of a split transaction (one real leg plus two or more category legs, decision 87); 0 for every other row. Split rows are read-only.

integer

0

status

required

Status

string

superseded_by

required

Any of:

string

string format: uuid

null

null

transfer_account_path

required

Any of:

string

string

null

null

Example

{
  "has_linked_originals": false,
  "schedule_pinned": false,
  "split_lines": 0
}

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"
    }
  ]
}