Update Account

PATCH

/accounts/{account_id}

curl --request PATCH \
  --url https://example.com/accounts/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Content-Type: application/json' \
  --data '{ "description": "example", "drift_basis_override": "pending_inclusive", "feed_invert": true, "feed_start": "2026-04-15", "hidden": true, "holdings_source": "feed", "name": "example", "path": "example" }'

Rename / re-describe / hide / move a real account.

A new path moves the account and every account beneath it, keeping their relative paths; the move is audited (account.move) and emits account.moved. Balances and history are unaffected: transactions point at accounts by id.

Parameters

Path Parameters

account_id

required

Account Id

string format: uuid

Request Body^required

Media typeapplication/json

AccountUpdate

Rename / re-describe / hide / move a real account (DESIGN §3.4). hidden toggles the display-only hidden_at timestamp; path moves the account and everything beneath it (decision 72).

feed_start (§7.1, decision 40) is admin-only: explicit null clears, absent leaves unchanged (model_fields_set distinguishes the two). feed_invert (§7.1, decision 43) is admin-only feed configuration too; a plain bool, so absent/None simply leaves it unchanged. drift_basis_override (§7.3, decision 83) is admin-only as well, with feed_start’s explicit-null-clears rule. holdings_source (§8, decision 88) is admin-only too; absent/None leaves it unchanged.

object

description

Any of:

string

string

null

null

drift_basis_override

Any of:

string

string

Allowed values: pending_inclusive posted_only

null

null

feed_invert

Any of:

boolean

boolean

null

null

feed_start

Any of:

string

string format: date

null

null

hidden

Any of:

boolean

boolean

null

null

holdings_source

Any of:

string

string

Allowed values: feed manual

null

null

name

Any of:

string

string

>= 1 characters

null

null

path

Any of:

string

string

null

null

Responses

200

Successful Response

Media typeapplication/json

AccountOut

object

balance

Any of:

string

string

null

null

balance_as_of

Any of:

string

string format: date

null

null

balance_method

Any of:

string

string

null

null

closed_at

required

Any of:

string

string format: date-time

null

null

connection_id

required

Any of:

string

string format: uuid

null

null

created_at

required

Created At

string format: date-time

currency

required

Currency

string

description

required

Any of:

string

string

null

null

drift_basis_override

Any of:

string

string

Allowed values: pending_inclusive posted_only

null

null

external_id

required

Any of:

string

string

null

null

feed_invert

Feed Invert

boolean

feed_start

Any of:

string

string format: date

null

null

hidden_at

required

Any of:

string

string format: date-time

null

null

holdings_source

Holdings Source

string

default: feed

Allowed values: feed manual

id

required

Id

string format: uuid

is_virtual

required

Is Virtual

boolean

min_balance

required

Any of:

string

string

null

null

name

required

Name

string

parent_id

required

Any of:

string

string format: uuid

null

null

path

required

Path

string

postings_balance

Any of:

string

string

null

null

reconciled_through

Any of:

string

string format: date

null

null

reconciliation

Any of:

ReconciliationOut

ReconciliationOut

A recorded reconciliation (issue #268), re-checked against the ledger when it is read — so a backdated import, edit or replay that moved the balance on as_of shows up here as a nonzero difference instead of leaving the reconciled-through marker silently wrong.

statement_balance is the figure as the statement shows it (positive = money held; for a credit card, the amount owed). Every other amount is in ledger sign (a card is negative when owed).

object

adjustment

required

Adjustment

string

adjustment_tx_id

required

Any of:

string

string format: uuid

null

null

as_of

required

As Of

string format: date

basis

required

Basis

string

Allowed values: posted pending_inclusive

created_at

required

Created At

string format: date-time

difference

required

Difference

string

id

required

Id

string format: uuid

in_balance

required

In Balance

boolean

ledger_balance

required

Ledger Balance

string

statement_balance

required

Statement Balance

string

target_balance

required

Target Balance

string

null

null

type

required

Type

string

Example

{
  "drift_basis_override": "pending_inclusive",
  "feed_invert": false,
  "holdings_source": "feed",
  "reconciliation": {
    "basis": "posted"
  }
}

409

The new path is taken: an account already sits at it or beneath it.

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