QuickBooks: Create a billpayment

← billpayment operations · Get started · OpenAPI downloads

Contract 2026-10-20 · Operation quickbooks.billpayment.create_a_billpayment

Provider route: POST /v3/company/{realmID}/billpayment. 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["billpayment"]["create"]>[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.billpayment.create(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.billpayment.create(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: Id, SyncToken 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.CheckPayment	Model	Optional	Expand Void a billpayment — request body — body Check Payment Reference to the vendor for this transaction. Required when PayType is Check . Conditionally required
body.CreditCardPayment	Model	Optional	Expand Void a billpayment — request body — body Credit Card Payment Information about a credit card payment for the transaction. Not applicable to Estimate and SalesOrder. Required when PayType is CreditCard . Conditionally required
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, as defined using location tracking in QuickBooks Online. 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, a custom value can be provided. If no value is supplied, the resulting DocNumber is null. Throws an error when duplicate DocNumber is sent in the request. Recommended best practice: check the setting of Preferences:OtherPrefs 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.Line	array	Required within parent	Individual line items representing zero or more Bill , VendorCredit , and JournalEntry objects linked to this BillPayment object. Valid Line types include: LinkedTxnLine:
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 object. The MetaData values are set by Data Services and are read only for all applications.
body.PayType	string	Required within parent	The payment type. Valid values include: Check , CreditCard
body.PrivateNote	string	Optional	User entered, organization-private note about the transaction. This note does not appear on the invoice to the customer. This field maps to the Memo field on the form.
body.ProcessBillPayment	JSON	Optional	Indicates that the payment should be processed by merchant account service. Valid for QuickBooks companies with credit card processing.
body.ProcessBillPayment (anyOf 1)	boolean	Alternative
body.ProcessBillPayment (anyOf 2)	string	Alternative	One of: true, false
body.TotalAmt	JSON	Required within parent	Indicates the total amount of the associated with this payment. This includes the total of all the payments from the BillPayment Details. 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.VendorRef	Model	Required within parent	Expand Create a purchase order — request body — body Ship To Reference to the vendor for this transaction.
body.domain	string	Optional
body.sparse	boolean	Optional

Referenced models: Read a bill — response body — Bill Meta Data, Void a billpayment — request body — body Check Payment, Void a billpayment — 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
BillPayment	Model	Optional	Expand Read a billpayment — response body — Bill Payment

Referenced models: Read a billpayment — response body — Bill Payment

Policy, approvals and errors

SDK function policy ID: quickbooks.billpayment.create_a_billpayment. Catalog operation: billpayment/create_a_billpayment. 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