QuickBooks: Sparse update companyinfo

← companyinfo operations · Get started · OpenAPI downloads

Contract 2026-10-20 · Operation quickbooks.companyinfo.sparse_update_companyinfo

Provider route: POST /v3/company/{realmID}/companyinfo. 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["companyinfo"]["updateSparse"]>[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.companyinfo.updateSparse(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.companyinfo.update_sparse(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.CompanyAddr	Model	Optional	Expand Create a vendor — request body — body Bill Addr Company Address as described in preference. If a physical address is updated from within the transaction object, the QuickBooks Online API flows individual address components differently into the Line elements of the transaction response then when the transaction was first created: Line1 and Line2 elements are populated with the customer name and company name. Original Line1 through Line 5 contents, City , SubDivisionCode , and PostalCode flow into Line3 through Line5 as a free format strings.
body.CompanyName	string	Optional	The name of the company.
body.CompanyStartDate	string	Optional	DateTime when company file was created. This field and Metadata.CreateTime contain the same value. Read only: true
body.Country	string	Optional	Country name to which the company belongs for financial calculations.
body.CustomerCommunicationAddr	Model	Optional	Expand Create a vendor — request body — body Bill Addr Address of the company as given to their customer, sometimes the address given to the customer mail address is different from Company address. If a physical address is updated from within the transaction object, the QuickBooks Online API flows individual address components differently into the Line elements of the transaction response then when the transaction was first created: Line1 and Line2 elements are populated with the customer name and company name. Original Line1 through Line 5 contents, City , SubDivisionCode , and PostalCode flow into Line3 through Line5 as a free format strings.
body.Email	Model	Optional	Expand Full update companyinfo — request body — body Email Default email address.
body.EmployerId	string	Optional	If your QuickBooks company has defined an EIN in company settings, this value is returned.
body.FiscalYearStartMonth	string	Optional	The start month of fiscal year.
body.Id	string	Required within parent
body.LegalAddr	Model	Optional	Expand Create a vendor — request body — body Bill Addr Legal Address given to the government for any government communication. If a physical address is updated from within the transaction object, the QuickBooks Online API flows individual address components differently into the Line elements of the transaction response then when the transaction was first created: Line1 and Line2 elements are populated with the customer name and company name. Original Line1 through Line 5 contents, City , SubDivisionCode , and PostalCode flow into Line3 through Line5 as a free format strings.
body.LegalName	string	Optional	The legal name of the company.
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.NameValue	array	Optional	Any other preference not covered with the standard set of attributes. See Data Services Extensions, below, for special reserved name/value pairs. NameValue.Name—Name of the element. NameValue.Value—Value of the element.
body.NameValue[]	object	Each item	Additional keys: allowed
body.PrimaryPhone	Model	Optional	Expand Create a vendor — request body — body Fax Primary phone number.
body.SupportedLanguages	string	Optional	Comma separated list of languages.
body.SyncToken	string	Required within parent
body.WebAddr	Model	Optional	Expand Create a vendor — request body — body Web Addr Website address.
body.domain	string	Optional
body.sparse	boolean	Required within parent	Must equal: true

Referenced models: Full update companyinfo — request body — body Email, Read a bill — response body — Bill Meta Data, Create a vendor — request body — body Bill Addr, Create a vendor — request body — body Fax, Create a vendor — request body — body Web Addr

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
CompanyInfo	Model	Optional	Expand Read companyinfo — response body — Company Info

Referenced models: Read companyinfo — response body — Company Info

Policy, approvals and errors

SDK function policy ID: quickbooks.companyinfo.sparse_update_companyinfo. Catalog operation: companyinfo/full_update_companyinfo. 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