QuickBooks: Full update preferences

← preferences operations · Get started · OpenAPI downloads

Contract 2026-10-20 · Operation quickbooks.preferences.full_update_preferences

Provider route: POST /v3/company/{realmID}/preferences. 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["preferences"]["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.preferences.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.preferences.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.AccountingInfoPrefs	Model	Optional	Expand Full update preferences — request body — body Accounting Info Prefs The following settings are available for QuickBooks Online Plus editions, only. To determine this edition type, query the value of the OfferingSku CustomerInfo.Name name/value pair for QuickBooks Online Plus .
body.CurrencyPrefs	Model	Optional	Expand Full update preferences — request body — body Currency Prefs
body.EmailMessagesPrefs	Model	Optional	Expand Full update preferences — request body — body Email Messages Prefs
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.OtherPrefs	object	Optional	Specifies extension of Preference resource to allow extension of Name-Value pair based extension at the top level. Additional keys: allowed
body.ProductAndServicesPrefs	Model	Optional	Expand Full update preferences — request body — body Product And Services Prefs
body.ReportPrefs	Model	Optional	Expand Full update preferences — request body — body Report Prefs
body.SalesFormsPrefs	Model	Optional	Expand Full update preferences — request body — body Sales Forms Prefs
body.SyncToken	string	Required within parent
body.TaxPrefs	Model	Optional	Expand Full update preferences — request body — body Tax Prefs
body.TimeTrackingPrefs	Model	Optional	Expand Full update preferences — request body — body Time Tracking Prefs
body.VendorAndPurchasesPrefs	Model	Optional	Expand Full update preferences — request body — body Vendor And Purchases Prefs
body.domain	string	Optional
body.sparse	boolean	Optional	Must equal: false

Referenced models: Full update preferences — request body — body Email Messages Prefs, Read a bill — response body — Bill Meta Data, Full update preferences — request body — body Accounting Info Prefs, Full update preferences — request body — body Currency Prefs, Full update preferences — request body — body Product And Services Prefs, Full update preferences — request body — body Report Prefs, Full update preferences — request body — body Sales Forms Prefs, Full update preferences — request body — body Tax Prefs, Full update preferences — request body — body Time Tracking Prefs, Full update preferences — request body — body Vendor And Purchases Prefs

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
Preferences	Model	Optional	Expand Read preferences — response body — Preferences

Referenced models: Read preferences — response body — Preferences

Policy, approvals and errors

SDK function policy ID: quickbooks.preferences.full_update_preferences. Catalog operation: preferences/full_update_preferences. 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