QuickBooks: Sparse update a journalentry

← journalentry operations · Get started · OpenAPI downloads

Contract 2026-10-20 · Operation quickbooks.journalentry.sparse_update_a_journalentry

Provider route: POST /v3/company/{realmID}/journalentry. 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["journalentry"]["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.journalentry.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.journalentry.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.Adjustment	JSON	Optional	Indicates whether this transaction is a journal entry adjustment.
body.Adjustment (anyOf 1)	boolean	Alternative
body.Adjustment (anyOf 2)	string	Alternative	One of: true, false
body.CurrencyRef	Model	Optional	Expand Create a bill — request body — body Currency Ref Reference to the currency in which all amounts on the associated transaction are expressed. This must be defined if multicurrency is enabled for the company. Multicurrency is enabled for the company if Preferences.MultiCurrencyEnabled is set to true . Read more about multicurrency support here . Required if multicurrency is enabled for the company Conditionally required
body.DocNumber	string	Optional	Reference number for the transaction. Throws an error when duplicate DocNumber is sent in the request and if Preferences:OtherPrefs:NameValue.Name = WarnDuplicateJournalNumber is true. Recommended best practice: check the setting of Preferences:OtherPrefs:NameValue.Name = WarnDuplicateJournalNumber before setting DocNumber. If a duplicate DocNumber needs to be supplied, add the query parameter name/value pair, include=allowduplicatedocnum to the URI. Sort order is ASC by default. If null value is sent in the request null will be saved. If there is a need to support assigning a docNumber when null, it can be achieved through include param, include=allowautodocnum
body.ExchangeRate	JSON	Optional	The number of home currency units it takes to equal one unit of currency specified by CurrencyRef . Applicable if multicurrency is enabled for the company. Decimal string
body.ExchangeRate (anyOf 1)	number	Alternative
body.ExchangeRate (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?$
body.GlobalTaxCalculation	string	Optional	Method in which tax is applied. Allowed values are: TaxExcluded , TaxInclusive . Not applicable to US companies; required for non-US companies. Conditionally required
body.HomeTotalAmt	JSON	Optional	The value of this field will always be set to zero. Applicable if multicurrency is enabled for the company. Decimal string Read only: true
body.HomeTotalAmt (anyOf 1)	number	Alternative
body.HomeTotalAmt (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?$
body.Id	string	Required within parent
body.Line	array	Optional	Individual line items of a transaction. There must be at least one pair of Journal Entry Line elements, representing a debit and a credit, called distribution lines. Valid Line types include: JournalEntryLine and DescriptionOnlyLine
body.Line[]	JSON	Each item
body.Line[] (anyOf 1)	Model	Alternative	Expand Create a journalentry — request body — body Line item
body.Line[] (anyOf 2)	Model	Alternative	Expand Void an invoice — request body — body Line item Amount, Description, Description Line Detail, Detail Type, Id, Line Num
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.PrivateNote	string	Optional	User entered, organization-private note about the transaction.
body.RecurDataRef	Model	Optional	Expand Create a purchase order — request body — body Ship To A reference to the Recurring Transaction. It captures what recurring transaction template the JournalEntry was created from. Read only: true
body.SyncToken	string	Required within parent
body.TaxRateRef	Model	Optional	Expand Create a purchase order — request body — body Ship To Reference to the Tax Adjustment Rate Ids for this item. Query the TaxRate list resource to determine the appropriate TaxRate object for this reference. Use TaxRate.Id and TaxRate.Name from that object for TaxRateRef.value and TaxRateRef.name, respectively.
body.TotalAmt	JSON	Optional	The value of this field will always be set to zero. Calculated by QuickBooks business logic; any value you supply is over-written by QuickBooks. Decimal string Read only: true
body.TotalAmt (anyOf 1)	number	Alternative
body.TotalAmt (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?$
body.TxnDate	string	Optional	The date entered by the user when this transaction occurred. For posting transactions, this is the posting date that affects the financial statements. If the date is not supplied, the current date on the server is used. Sort order is ASC by default.
body.TxnTaxDetail	Model	Optional	Expand Create a bill — request body — body Txn Tax Detail This data type provides information for taxes charged on the transaction as a whole. It captures the details sales taxes calculated for the transaction based on the tax codes referenced by the transaction. This can be calculated by QuickBooks business logic or you may supply it when adding a transaction. See Global tax model for more information about this element. If sales tax is disabled ( Preferences.TaxPrefs.UsingSalesTax is set to false ) then TxnTaxDetail is ignored and not stored.
body.domain	string	Optional
body.sparse	boolean	Required within parent	Must equal: true

Referenced models: Read a bill — response body — Bill Meta Data, Create a bill — request body — body Currency Ref, Void an invoice — request body — body Line item Amount, Description, Description Line Detail, Detail Type, Id, Line Num, Create a journalentry — request body — body Line item, Create a purchase order — request body — body Ship To, Create a bill — request body — body Txn Tax Detail

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
JournalEntry	Model	Optional	Expand Read a journalentry — response body — Journal Entry

Referenced models: Read a journalentry — response body — Journal Entry

Policy, approvals and errors

SDK function policy ID: quickbooks.journalentry.sparse_update_a_journalentry. Catalog operation: journalentry/create_a_journalentry. 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