QuickBooks: Full update an account

← account operations · Get started · OpenAPI downloads

Contract 2026-10-20 · Operation quickbooks.account.full_update_an_account

Provider route: POST /v3/company/{realmID}/account. Alter supplies the connection’s credentials and routing.

Call through Alter

Install @alter-ai/sdk @alter-ai/quickbooks with npm, or alter-sdk-quickbooks with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { QuickBooksIntegration } from "@alter-ai/quickbooks";

async function execute(input: Parameters<QuickBooksIntegration["account"]["update"]>[0]) {
  const app = new App({ apiKey: process.env.ALTER_API_KEY! });
  try {
    const provider = new QuickBooksIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
    const call = await provider.account.update(input);
    const result = await call.wait();
    return result.bodyJson();
  } finally {
    await app.close();
  }
}

import os
from alter_sdk import App
from alter_sdk_quickbooks import QuickBooksIntegration

async def execute(arguments):
    async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
        provider = QuickBooksIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
        call = await provider.account.update(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
query	object	Optional	Additional keys: not allowed
query.minorversion	integer	Optional	Must equal: 75
query.requestid	string	Optional	Minimum length: 1
body	object	Required within parent	Fields not accepted: sparse Additional keys: not allowed
body.AccountSubType	string	Optional	The account sub-type classification and is based on the AccountType value.
body.AccountType	string	Optional	A detailed account classification that specifies the use of this account. The type is based on the Classification.
body.AcctNum	string	Optional	User-defined account number to help the user in identifying the account within the chart-of-accounts and in deciding what should be posted to the account. The Account.AcctNum attribute must not contain colon (:). Name must be unique. Max length for Account.AcctNum : AU & CA: 20 characters. US, UK & IN: 7 characters Conditionally required
body.Active	JSON	Optional	Whether or not active inactive accounts may be hidden from most display purposes and may not be posted to.
body.Active (anyOf 1)	boolean	Alternative
body.Active (anyOf 2)	string	Alternative	One of: true, false
body.Classification	string	Optional	The classification of an account. Not supported for non-posting accounts. Valid values include: Asset , Equity , Expense , Liability , Revenue Read only: true
body.CurrencyRef	Model	Optional	Expand Create a bill — request body — body Currency Ref Reference to the currency in which this account holds amounts. Read only: true
body.CurrentBalance	JSON	Optional	Specifies the balance amount for the current Account. Valid for Balance Sheet accounts. Decimal string Read only: true
body.CurrentBalance (anyOf 1)	number	Alternative
body.CurrentBalance (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?$
body.CurrentBalanceWithSubAccounts	JSON	Optional	Specifies the cumulative balance amount for the current Account and all its sub-accounts. Decimal string Read only: true
body.CurrentBalanceWithSubAccounts (anyOf 1)	number	Alternative
body.CurrentBalanceWithSubAccounts (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?$
body.Description	string	Optional	User entered description for the account, which may include user entered information to guide bookkeepers/accountants in deciding what journal entries to post to the account.
body.FullyQualifiedName	string	Optional	Fully qualified name of the object; derived from Name and ParentRef . The fully qualified name prepends the topmost parent, followed by each subaccount separated by colons and takes the form of Parent:Account1:SubAccount1:SubAccount2 . System generated. Limited to 5 levels. Read only: true
body.Id	string	Required within parent
body.MetaData	Model	Optional	Expand Read a bill — response body — Bill Meta Data Descriptive information about the object. The MetaData values are set by Data Services and are read only for all applications.
body.Name	string	Optional	User recognizable name for the Account. Account.Name attribute must not contain double quotes (”) or colon (:).
body.ParentRef	Model	Optional	Expand Create a purchase order — request body — body Ship To Specifies the Parent AccountId if this represents a SubAccount.
body.SubAccount	JSON	Optional	Specifies whether this object represents a parent (false) or subaccount (true). Please note that accounts of these types - OpeningBalanceEquity , UndepositedFunds , RetainedEarnings , CashReceiptIncome , CashExpenditureExpense , ExchangeGainOrLoss cannot have a sub account and cannot be a sub account of another account. Read only: true
body.SubAccount (anyOf 1)	boolean	Alternative
body.SubAccount (anyOf 2)	string	Alternative	One of: true, false
body.SyncToken	string	Required within parent
body.TaxCodeRef	Model	Optional	Expand Create a purchase order — request body — body Ship To Reference to the default tax code used by this account. Tax codes are referenced by the TaxCode.Id in the TaxCode object. For global locales, only.
body.domain	string	Optional
body.sparse	boolean	Optional	Must equal: false

Referenced models: Read a bill — response body — Bill Meta Data, Create a bill — request body — body Currency Ref, Create a purchase order — request body — body Ship To

Response

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: allowed
time	string	Optional
Account	Model	Optional	Expand Read an account — response body — Account

Referenced models: Read an account — response body — Account

Policy, approvals and errors

SDK function policy ID: quickbooks.account.full_update_an_account. Catalog operation: accounts/create. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Official provider source