QuickBooks: Create a recurring transaction

← recurringtransaction operations · Get started · OpenAPI downloads

Contract 2026-10-20 · Operation quickbooks.recurringtransaction.create_a_recurring_transaction

Provider route: POST /v3/company/{realmID}/recurringtransaction. 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["recurringtransaction"]["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.recurringtransaction.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.recurringtransaction.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	Minimum fields: 1 Maximum fields: 1 Fields not accepted: Id, SyncToken Additional keys: not allowed
body.Bill	Model	Optional	Expand Create a recurring transaction — request body — body Bill
body.Deposit	Model	Optional	Expand Create a recurring transaction — request body — body Deposit
body.Estimate	Model	Optional	Expand Create a recurring transaction — request body — body Estimate
body.Invoice	Model	Optional	Expand Create a recurring transaction — request body — body Invoice
body.JournalEntry	Model	Optional	Expand Create a recurring transaction — request body — body Journal Entry
body.Purchase	Model	Optional	Expand Create a recurring transaction — request body — body Purchase
body.RefundReceipt	Model	Optional	Expand Create a recurring transaction — request body — body Refund Receipt
body.SalesReceipt	Model	Optional	Expand Create a recurring transaction — request body — body Sales Receipt
body.Transfer	Model	Optional	Expand Create a recurring transaction — request body — body Transfer
body.VendorCredit	Model	Optional	Expand Create a recurring transaction — request body — body Vendor Credit

Referenced models: Create a recurring transaction — request body — body Bill, Create a recurring transaction — request body — body Deposit, Create a recurring transaction — request body — body Estimate, Create a recurring transaction — request body — body Invoice, Create a recurring transaction — request body — body Journal Entry, Create a recurring transaction — request body — body Purchase, Create a recurring transaction — request body — body Refund Receipt, Create a recurring transaction — request body — body Sales Receipt, Create a recurring transaction — request body — body Transfer, Create a recurring transaction — request body — body Vendor Credit

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
RecurringTransaction	Model	Optional	Expand Create a recurring transaction — response body — Recurring Transaction

Referenced models: Create a recurring transaction — response body — Recurring Transaction

Policy, approvals and errors

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