QuickBooks: Full update a payment

← payment operations · Get started · OpenAPI downloads

Contract 2026-10-20 · Operation quickbooks.payment.full_update_a_payment

Provider route: POST /v3/company/{realmID}/payment. 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["payment"]["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.payment.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.payment.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.CreditCardPayment	Model	Optional	Expand Void a payment — request body — body Credit Card Payment Information about a payment received by credit card. Inject with data only if the payment was transacted through Intuit Payments API.
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.CustomerRef	Model	Optional	Expand Create a purchase order — request body — body Ship To Reference to a customer or job. Query the Customer name list resource to determine the appropriate Customer object for this reference. Use Customer.Id and Customer.DisplayName from that object for CustomerRef.value and CustomerRef.name , respectively.
body.DepositToAccountRef	Model	Optional	Expand Create a purchase order — request body — body Ship To Identifies the account to be used for this payment. Query the Account name list resource to determine the appropriate Account object for this reference, where Account.AccountType is Other Current Asset or Bank . Use Account.Id and Account.Name from that object for DepositToAccountRef.value and DepostiToAccountRef.name , respectively. If you do not specify this account, payment is applied to the Undeposited Funds account.
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.Id	string	Required within parent
body.Line	array	Optional	Zero or more transactions accounting for this payment. Values for Line.LinkedTxn.TxnType can be one of the following: Expense —Payment is reimbursement for expense paid by cash made on behalf of the customer Check —Payment is reimbursement for expense paid by check made on behalf of the customer CreditCardCredit —Payment is reimbursement for a credit card credit made on behalf of the customer JournalEntry —Payment is linked to the representative journal entry CreditMemo —Payment is linked to the credit memo the customer has with the business Invoice —The invoice to which payment is applied Use Line.LinkedTxn.TxnId as the ID in a separate read request for the specific resource to retrieve details of the linked object.
body.Line[]	Model	Each item	Expand Void a payment — request body — body Line item
body.MetaData	Model	Optional	Expand Read a bill — response body — Bill Meta Data Descriptive information about the entity. The MetaData values are set by Data Services and are read only for all applications.
body.PaymentMethodRef	Model	Optional	Expand Create a purchase order — request body — body Ship To Reference to a PaymentMethod associated with this transaction. Query the PaymentMethod name list resource to determine the appropriate PaymentMethod object for this reference. Use PaymentMethod.Id and PaymentMethod.Name from that object for PaymentMethodRef.value and PaymentMethodRef.name , respectively.
body.PaymentRefNum	string	Optional	The reference number for the payment received. For example, Check # for a check, envelope # for a cash donation.
body.PrivateNote	string	Optional	User entered, organization-private note about the transaction.
body.ProjectRef	Model	Optional	Expand Create a purchase order — request body — body Ship To Reference to the Project ID associated with this transaction. Conditionally required
body.SyncToken	string	Required within parent
body.TaxExemptionRef	Model	Optional	Expand Create a purchase order — request body — body Ship To Reference to the TaxExepmtion ID associated with this object. Available for companies that have automated sales tax enabled. TaxExemptionRef.Name : The Tax Exemption Id for the customer to which this object is associated. This Id is typically issued by the state. TaxExemptionRef.value : The system-generated Id of the exemption type. For internal use only Read only: true
body.TotalAmt	JSON	Optional	Indicates the total amount of the transaction. This includes the total of all the charges, allowances, and taxes. If you process a linked refund transaction against a specific transaction, the totalAmt value won’t change. It will remain the same. However, voiding the linked refund will change the totalAmt value to O. Decimal string
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.TxnSource	string	Optional	Used internally to specify originating source of a credit card transaction.
body.UnappliedAmt	JSON	Optional	Indicates the amount that has not been applied to pay amounts owed for sales transactions. Decimal string Read only: true
body.UnappliedAmt (anyOf 1)	number	Alternative
body.UnappliedAmt (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?$
body.domain	string	Optional
body.sparse	boolean	Optional	Must equal: false

Referenced models: Read a bill — response body — Bill Meta Data, Void a payment — request body — body Credit Card Payment, Create a bill — request body — body Currency Ref, Void a payment — request body — body Line 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
Payment	Model	Optional	Expand Read a payment — response body — Payment

Referenced models: Read a payment — response body — Payment

Policy, approvals and errors

SDK function policy ID: quickbooks.payment.full_update_a_payment. Catalog operation: payments/create. 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