QuickBooks: Full update a vendorcredit

← vendorcredit operations · Get started · OpenAPI downloads

Contract 2026-10-20 · Operation quickbooks.vendorcredit.full_update_a_vendorcredit

Provider route: POST /v3/company/{realmID}/vendorcredit. 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["vendorcredit"]["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.vendorcredit.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.vendorcredit.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.APAccountRef	Model	Optional	Expand Create a purchase order — request body — body Ship To Specifies to which AP account the bill is credited. Query the Account name list resource to determine the appropriate Account object for this reference. Use Account.Id and Account.Name from that object for APAccountRef.value and APAccountRef.name , respectively. The specified account must have Account.Classification set to Liability and Account.AccountSubType set to AccountsPayable . If the company has a single AP account, the account is implied. However, it is recommended that the AP Account be explicitly specified in all cases to prevent unexpected errors when relating transactions to each other.
body.Balance	JSON	Optional	The current amount of the vendor credit reflecting any adjustments to the original credit amount. Initially set to the value of TotalAmt . Calculated by QuickBooks business logic; any value you supply is over-written by QuickBooks. Decimal string Read only: true
body.Balance (anyOf 1)	number	Alternative
body.Balance (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?$
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.DepartmentRef	Model	Optional	Expand Create a purchase order — request body — body Ship To A reference to a Department object specifying the location of the transaction. Available if Preferences.AccountingInfoPrefs.TrackDepartments is set to true . Query the Department name list resource to determine the appropriate department object for this reference. Use Department.Id and Department.Name from that object for DepartmentRef.value and DepartmentRef.name , respectively.
body.DocNumber	string	Optional	Reference number for the transaction. If not explicitly provided at create time, this field is populated based on the setting of Preferences:OtherPrefs:NameValue.Name = VendorAndPurchasesPrefs.UseCustomTxnNumbers as follows: If Preferences:OtherPrefs:NameValue.Name = VendorAndPurchasesPrefs.UseCustomTxnNumbers is true a custom value can be provided. If no value is supplied, the resulting DocNumber is null. If Preferences:OtherPrefs:NameValue.Name = VendorAndPurchasesPrefs.UseCustomTxnNumbers is false, resulting DocNumber is system generated by incrementing the last number by 1. Throws an error when duplicate DocNumber is sent in the request. Recommended best practice: check the setting of Preferences:OtherPrefs:NameValue.Name = VendorAndPurchasesPrefs.UseCustomTxnNumbers 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.
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 , and NotApplicable . Not applicable to US companies; required for non-US companies. Conditionally required
body.Id	string	Required within parent
body.IncludeInAnnualTPAR	JSON	Optional	Include the supplier in the annual TPAR. TPAR stands for Taxable Payments Annual Report. The TPAR is mandated by ATO to get the details payments that businesses make to contractors for providing services. Some government entities also need to report the grants they have paid in a TPAR.
body.IncludeInAnnualTPAR (anyOf 1)	boolean	Alternative
body.IncludeInAnnualTPAR (anyOf 2)	string	Alternative	One of: true, false
body.Line	array	Optional	Individual line items of a transaction. Valid Line types include: ItemBasedExpenseLine and AccountBasedExpenseLine
body.Line[]	JSON	Each item
body.Line[] (anyOf 1)	Model	Alternative	Expand Create a purchase order — request body — body Line item
body.Line[] (anyOf 2)	Model	Alternative	Expand Create a bill — request body — body Line item
body.LinkedTxn	array	Optional	Zero or more transactions linked to this object. The LinkedTxn.TxnType can be set to ReimburseCharge . The LinkedTxn.TxnId can be set as the ID of the transaction.
body.LinkedTxn[]	Model	Each item	Expand Create a bill — request body — body Linked Txn item
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. This note does not appear on the transaction to the vendor. This field maps to the Memo field on the transaction form.
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 VendorCredit was created from. Read only: true
body.SyncToken	string	Required within parent
body.TotalAmt	JSON	Optional	Indicates the total credit amount, determined by taking the total of all all lines of the transaction. This includes all charges, allowances, discounts, and taxes. 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.VendorRef	Model	Optional	Expand Create a purchase order — request body — body Ship To The vendor reference for this transaction.
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 Line item, Create a bill — request body — body Currency Ref, Create a purchase order — request body — body Line item, Create a bill — request body — body Linked Txn item, 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
VendorCredit	Model	Optional	Expand Read a vendorcredit — response body — Vendor Credit

Referenced models: Read a vendorcredit — response body — Vendor Credit

Policy, approvals and errors

SDK function policy ID: quickbooks.vendorcredit.full_update_a_vendorcredit. Catalog operation: vendorcredit/create_a_vendorcredit. 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