budgetresponse

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/quickbooks/json-schema/quickbooks-budgetresponse-schema.json",
  "title": "budgetresponse",
  "x-generated": "2026-11-10",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/quickbooks-budget-api-openapi.yml#/components/schemas/budgetresponse",
  "type": "object",
  "properties": {
    "SyncToken": {
      "type": "string",
      "description": "Version number of the object. It is used to lock an object for use by one app at a time. As soon as an application modifies an object, its SyncToken is incremented. Attempts to modify an object specifying an older SyncToken fails. Only the latest version of the object is maintained by QuickBooks Online.",
      "x-intuit-required": "Required for update"
    },
    "BudgetEntryType": {
      "type": "string",
      "description": "Period that this budget detail covers..\n Valid values include: Monthly, Quarterly, Annually.",
      "x-intuit-required": "Optional"
    },
    "EndDate": {
      "type": "string",
      "format": "date-time",
      "description": "Budget end date.",
      "x-intuit-required": "Required"
    },
    "Name": {
      "type": "string",
      "description": "User recognizable name for the Account.\nAccount.Name attribute must not contain double quotes (\") or colon (:).",
      "x-intuit-required": "Optional",
      "x-intuit-filterable": true,
      "x-intuit-sortable": true
    },
    "BudgetDetail": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/budgetdetail"
      },
      "description": "Container for the budget items.",
      "x-intuit-required": "Optional"
    },
    "StartDate": {
      "type": "string",
      "format": "date-time",
      "description": "Budget begin date.",
      "x-intuit-required": "Required"
    },
    "BudgetType": {
      "type": "string",
      "description": "Budget types.\n The only value currently supported is ProfitAndLoss.",
      "x-intuit-required": "Optional",
      "x-intuit-filterable": true,
      "x-intuit-sortable": true
    },
    "CustomExtensions": {
      "allOf": [
        {
          "$ref": "#/$defs/customextensions"
        }
      ],
      "description": "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.",
      "x-intuit-required": "Optional"
    },
    "Active": {
      "type": "boolean",
      "description": "Whether or not active inactive accounts may be hidden from most display purposes and may not be posted to.",
      "x-intuit-required": "Optional",
      "x-intuit-default": "true",
      "x-intuit-filterable": true
    },
    "Id": {
      "type": "string",
      "description": "Unique identifier for this object.",
      "x-intuit-required": "Required for update",
      "x-intuit-filterable": true
    },
    "MetaData": {
      "allOf": [
        {
          "$ref": "#/$defs/modificationmetadata"
        }
      ],
      "description": "Descriptive information about the object. The MetaData values are set by Data Services and are read only for all applications.",
      "x-intuit-required": "Optional"
    }
  },
  "required": [
    "EndDate",
    "StartDate"
  ],
  "$defs": {
    "associatedvalues": {
      "type": "object",
      "title": "associatedvalues",
      "properties": {
        "Value": {
          "type": "string",
          "description": "For ExtensionType=DIMENSION, the unique ID of the selected dimension value.",
          "x-intuit-required": "Required"
        },
        "Key": {
          "type": "string",
          "description": "For ExtensionType=DIMENSION, the unique ID of the dimension definition.",
          "x-intuit-required": "Required"
        }
      },
      "required": [
        "Key",
        "Value"
      ]
    },
    "budgetdetail": {
      "type": "object",
      "title": "budgetdetail",
      "properties": {
        "ClassRef": {
          "allOf": [
            {
              "$ref": "#/$defs/referencetype"
            }
          ],
          "description": "Reference to the Class associated with the transaction. Available if Preferences.AccountingInfoPrefs.ClassTrackingPerLine is set to true. Query the Class name list resource to determine the appropriate Class object for this reference. Use Class.Id and Class.Name from that object for ClassRef.value and ClassRef.name, respectively.",
          "x-intuit-required": "Optional"
        },
        "DepartmentRef": {
          "allOf": [
            {
              "$ref": "#/$defs/referencetype"
            }
          ],
          "description": "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.",
          "x-intuit-required": "Optional"
        },
        "Amount": {
          "type": "number",
          "description": "Amount assigned to a BudgetDetail.",
          "x-intuit-required": "Optional"
        },
        "BudgetDate": {
          "type": "string",
          "format": "date-time",
          "description": "Date of the individual BudgetDetail.",
          "x-intuit-required": "Optional"
        },
        "AccountRef": {
          "allOf": [
            {
              "$ref": "#/$defs/referencetype"
            }
          ],
          "description": "Reference to the Account associated with this BudgetDetail. Query the Account name list resource to determine the appropriate Account object for this reference, where Account.AccountType=Expense. Use Account.Id and Account.Name from that object for AccountRef.value and AccountRef.name, respectively.",
          "x-intuit-required": "Optional"
        },
        "CustomerRef": {
          "allOf": [
            {
              "$ref": "#/$defs/referencetype"
            }
          ],
          "description": "Reference to the Customer associated with this BudgetDetail. 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.",
          "x-intuit-required": "Optional"
        }
      }
    },
    "customextensions": {
      "type": "object",
      "title": "customextensions",
      "properties": {
        "AssociatedValues": {
          "allOf": [
            {
              "$ref": "#/$defs/associatedvalues"
            }
          ],
          "description": "Array of key/value pairs associated with this extension. For ExtensionType=DIMENSION, each pair maps a dimension definition (Key) to a dimension value (Value).",
          "x-intuit-required": "Required"
        },
        "ExtensionType": {
          "type": "string",
          "description": "The type of extension applied to the line. Currently supported value: DIMENSION.",
          "x-intuit-required": "Required"
        }
      },
      "required": [
        "AssociatedValues",
        "ExtensionType"
      ]
    },
    "modificationmetadata": {
      "type": "object",
      "title": "modificationmetadata",
      "properties": {
        "CreateTime": {
          "type": "string",
          "format": "date-time",
          "description": "Time the entity was created in the source domain.",
          "x-intuit-filterable": true,
          "x-intuit-sortable": true
        },
        "LastUpdatedTime": {
          "type": "string",
          "format": "date-time",
          "description": "Time the entity was last updated in the source domain.",
          "x-intuit-filterable": true,
          "x-intuit-sortable": true
        }
      }
    },
    "referencetype": {
      "type": "object",
      "title": "referencetype",
      "properties": {
        "name": {
          "type": "string",
          "description": "An identifying name for the object being referenced by value and is derived from the field that holds the common name of that object. This varies by context and specific type of object referenced. For example, references to a Customer object use Customer.DisplayName to populate this field. Optionally returned in responses, implementation dependent.",
          "x-intuit-required": "Optional"
        },
        "value": {
          "type": "string",
          "description": "The ID for the referenced object as found in the Id field of the object payload. The context is set by the type of reference and is specific to the QuickBooks company file.",
          "x-intuit-required": "Required"
        }
      },
      "required": [
        "value"
      ]
    }
  }
}