QuickBooks: Create a budget

← budget operations · Get started · OpenAPI downloads

Contract 2026-10-20 · Operation quickbooks.budget.create_a_budget

Provider route: POST /v3/company/{realmID}/budget. 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["budget"]["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.budget.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.budget.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.Active	JSON	Optional	Whether or not active inactive accounts may be hidden from most display purposes and may not be posted to.
body.Active (anyOf 1)	boolean	Alternative
body.Active (anyOf 2)	string	Alternative	One of: true, false
body.BudgetDetail	array	Optional	Container for the budget items.
body.BudgetDetail[]	Model	Each item	Expand Create a budget — request body — body Budget Detail item
body.BudgetEntryType	string	Optional	Period that this budget detail covers.. Valid values include: Monthly , Quarterly , Annually . Read only: true
body.BudgetType	string	Optional	Budget types. The only value currently supported is ProfitAndLoss . Read only: true
body.CustomExtensions	Model	Optional	Expand Create an item — request body — body Custom Extensions Array of custom extension objects that associate additional attributes with the item. The ExtensionType field specifies the type of extension. The currently supported value is DIMENSION . The AssociatedValues array contains key/value pairs referencing Dimensions DefinitionID/Dimension ValueID. Multiple key/value pairs per extension type are supported. This field is designed to support additional extension types in the future. Dimensions is available for Intuit Enterprise Suite.
body.EndDate	string	Required within parent	Budget end date.
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.Name	string	Optional	User recognizable name for the Account. Account.Name attribute must not contain double quotes (”) or colon (:). Read only: true
body.StartDate	string	Required within parent	Budget begin date.
body.domain	string	Optional
body.sparse	boolean	Optional

Referenced models: Read a bill — response body — Bill Meta Data, Create a budget — request body — body Budget Detail item, Create an item — request body — body Custom Extensions

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
Budget	Model	Optional	Expand Read a budget — response body — Budget

Referenced models: Read a budget — response body — Budget

Policy, approvals and errors

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