QuickBooks: Full update a term

← term operations · Get started · OpenAPI downloads

Contract 2026-10-20 · Operation quickbooks.term.full_update_a_term

Provider route: POST /v3/company/{realmID}/term. 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["term"]["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.term.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.term.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.Active	JSON	Optional	If true, this entity is currently enabled for use by QuickBooks.
body.Active (anyOf 1)	boolean	Alternative
body.Active (anyOf 2)	string	Alternative	One of: true, false
body.DayOfMonthDue	JSON	Optional	Payment must be received by this day of the month. Required if DueDays not present Conditionally required
body.DayOfMonthDue (anyOf 1)	integer	Alternative
body.DayOfMonthDue (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+$
body.DiscountDayOfMonth	JSON	Optional	Discount applies if paid before this day of month. Required if DueDays not present Minimum: 1
body.DiscountDayOfMonth (anyOf 1)	integer	Alternative
body.DiscountDayOfMonth (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+$
body.DiscountDays	JSON	Optional	Discount applies if paid within this number of days. Used only when DueDays is specified.
body.DiscountDays (anyOf 1)	integer	Alternative
body.DiscountDays (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+$
body.DiscountPercent	JSON	Optional	Discount percentage available against an amount if paid within the days specified by DiscountDays . Decimal string
body.DiscountPercent (anyOf 1)	number	Alternative
body.DiscountPercent (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?$
body.DueDays	JSON	Optional	Number of days from delivery of goods or services until the payment is due. Required if DayOfMonthDue not present Conditionally required
body.DueDays (anyOf 1)	integer	Alternative
body.DueDays (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+$
body.DueNextMonthDays	JSON	Optional	Payment due next month if issued that many days before the DayOfMonthDue . Required if DueDays not present. Minimum: 1
body.DueNextMonthDays (anyOf 1)	integer	Alternative
body.DueNextMonthDays (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+$
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 term. For example, Net 30 .
body.SyncToken	string	Required within parent
body.Type	string	Optional	Type of the Sales Term. Valid values: STANDARD —Used if DueDays is not null. DATE_DRIVEN —Used if DueDays is null.
body.domain	string	Optional
body.sparse	boolean	Optional	Must equal: false

Referenced models: Read a bill — response body — Bill Meta Data

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
Term	Model	Optional	Expand Read a term — response body — Term

Referenced models: Read a term — response body — Term

Policy, approvals and errors

SDK function policy ID: quickbooks.term.full_update_a_term. Catalog operation: term/create_a_term. 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