QuickBooks: Sparse update a creditcardpayment

← creditcardpayment operations · Get started · OpenAPI downloads

Contract 2026-10-20 · Operation quickbooks.creditcardpayment.sparse_update_a_creditcardpayment

Provider route: POST /v3/company/{realmID}/creditcardpayment. 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["creditcardpayment"]["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.creditcardpayment.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.creditcardpayment.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.Amount	JSON	Optional	Total amount of the payment. Denominated in the currency of the credit card account. Decimal string
body.Amount (anyOf 1)	number	Alternative
body.Amount (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?$
body.BankAccountRef	Model	Optional	Expand Create a purchase order — request body — body Ship To Bank account used to pay the Credit Card balance. Must be a Bank account.
body.CheckNum	string	Optional	User entered, Check number. This field maps to the Check no. field on the Pay down credit card form.
body.CreditCardAccountRef	Model	Optional	Expand Create a purchase order — request body — body Ship To Credit Card account for which a payment is being entered. Must be a Credit Card account.
body.Id	string	Required within parent
body.Memo	string	Optional	User entered, organization-private note about the transaction. This field maps to the Memo field on the Pay down credit card form.
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.PrintStatus	string	Optional	Printing status of the credit-card-payment. Valid values: NotSet , NeedToPrint , PrintComplete .
body.PrivateNote	string	Optional	User entered, organization-private note about the transaction. This field maps to the Memo field on the Pay down credit card form.
body.SyncToken	string	Required within parent
body.TxnDate	string	Optional	Date of transaction.
body.VendorRef	Model	Optional	Expand Create a purchase order — request body — body Ship To Reference to the vendor for this transaction. Query the Vendor name list resource to determine the appropriate Vendor object for this reference. Use Vendor.Id and Vendor.Name from that object for VendorRef.value and VendorRef.name , respectively.
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 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
CreditCardPayment	Model	Optional	Expand Read a creditcardpayment — response body — Credit Card Payment

Referenced models: Read a creditcardpayment — response body — Credit Card Payment

Policy, approvals and errors

SDK function policy ID: quickbooks.creditcardpayment.sparse_update_a_creditcardpayment. Catalog operation: creditcardpayment/create_a_creditcardpayment. 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