Update an account. Disabling preserves history and excludes the account from default reads. Accessing or re-enabling an already-disabled account requires include_disabled=true in the query.

patch/api/v2/accounts/{id}

Request

  • Base URL: https://fintable.io
  • URL: https://fintable.io/api/v2/accounts/{id}
  • Auth: HTTP bearer

Path parameters

idstring required

Query parameters

workspace_idstring

Optional Workspace ID (ws_...) from GET /workspaces. Omit to act on the calculated default Workspace (the oldest one the person owns, otherwise the oldest one they belong to; is_default in GET /workspaces); omission returns validation_failed (422) only when the person belongs to no Workspace. Always a query parameter — on POST/PATCH/DELETE too; a body field never selects a Workspace. Unknown and unauthorized Workspace IDs return the standard not_found error.

include_disabledboolean

Include disabled accounts and their stored data. Defaults to false. Disabled IDs return 404 without this opt-in; connection counts exclude disabled accounts by default. On GET /accounts, the legacy enabled filter takes precedence. This flag never changes Workspace access or re-enables an account. Disabled balances must not be counted in current totals.

Request body

display_namestring nullable

Requires the write scope.

sync_start_datestring date nullable

A read scope may send this field alone, and only to move the date EARLIER; clearing it (null) and moving it later both require write.

enabledboolean

Requires the write scope.

reverse_balance_signboolean

Reverse the primary balance sign for this account. Available balance is unchanged. Defaults to false; requires write scope.

reverse_transaction_signboolean

Reverse existing and future transaction amounts, pending items and report totals for this account. Raw bank data is unchanged. Existing spreadsheet rows need an overwrite re-sync. Defaults to false; requires write scope.

balance_sourcestring nullable

A source returned by balance_sources_available on GET /accounts/{id}; null restores Fintable's default. Changes only this account's primary balance and leaves balance_available unchanged. Requires the write scope.

description_partsstring[] nullable

Which pieces the transaction description is built from, in order. Each entry is either a curated part (reference, statement, memo, counterparty) or raw:<field> naming any field the bank itself sends, e.g. raw:creditorAccount.iban. See description_parts_available and description_fields_available on the account. null restores the provider default. Changing this recomposes the transactions already stored (spreadsheets need a Force Re-Sync). Requires the write scope.

Example request

{
  "description_parts": [
    "reference"
  ]
}

Response

A {"data": {...}} envelope.

dataobject
workspace_idstring

Public ID of the Workspace this successful response was resolved against (workspace-bound endpoints only).

Changes

No recorded changes to this operation across all 1 revision of this API.