Budget details

Budget details for a general ledger account. Create and maintain budget details from the owning budget object.

Budget details include reporting periods for the budget, the budget amount for each period and dimensions, such as departments or locations. Once saved, dimensions added to budget details cannot be changed.

To track budget data by dimension, create a separate budget detail for each dimension value. For example, to budget travel expenses across three locations, add three budget detail objects, one for each location.

For more information, read the overview of creating budgets in the Sage Intacct Help Center.

List budget details

get/objects/general-ledger/budget-detail

Returns a collection with a key, ID, and link for each budget detail object. This operation is mostly for use in testing; use the query service to find budget details that meet certain criteria and to specify the properties that you want in the response.

SecurityOAuth2
Responses
200

OK

400

Bad Request

Request samples
Response samples
application/json
{
  • "ia::result": [
    • {
      • "key": "284",
      • "id": "284",
      • "href": "/objects/general-ledger/budget-detail/284"
      },
    • {
      • "key": "285",
      • "id": "285",
      • "href": "/objects/general-ledger/budget-detail/285"
      },
    • {
      • "key": "286",
      • "id": "286",
      • "href": "/objects/general-ledger/budget-detail/286"
      }
    ],
  • "ia::meta": {
    • "totalCount": 3,
    • "start": 1,
    • "pageSize": 100,
    • "next": null,
    • "previous": null
    }
}

Get budget details

get/objects/general-ledger/budget-detail/{key}

Returns detailed information for a specified budget detail.

SecurityOAuth2
Request
path Parameters
key
required
string

System-assigned key for the budget detail.

Example: 153
Responses
200

OK

400

Bad Request

Request samples
Response samples
application/json
{
  • "ia::result": {
    • "id": "13",
    • "key": "13",
    • "budget": {
      • "key": "5",
      • "id": "Employee Expense Budget",
      • "href": "/objects/general-ledger/budget/5"
      },
    • "currency": {
      • "txnCurrency": "USD"
      },
    • "reportingPeriod": {
      • "key": "79",
      • "id": "Month End May 2025",
      • "startDate": "2025-05-01",
      • "endDate": "2025-05-31",
      • "href": "/objects/general-ledger/reporting-period/79"
      },
    • "glAccount": {
      • "key": "9",
      • "id": "REVENUE_4000",
      • "name": "Revenue",
      • "href": "/objects/general-ledger/account/9"
      },
    • "dimensions": {
      • "department": {
        },
      • "location": {
        },
      • "customer": {
        },
      • "vendor": {
        },
      • "employee": {
        },
      • "item": {
        },
      • "contract": {
        },
      • "project": {
        },
      • "class": {
        }
      },
    • "amount": "1229.00",
    • "budgetGrowth": {
      • "basedOn": "budget",
      • "growBy": "9.00",
      • "perPeriod": "percentage"
      },
    • "notes": "Budget amount includes supply of new printers",
    • "audit": {
      • "createdDateTime": "2025-04-24T12:10:25Z",
      • "modifiedDateTime": "2025-04-24T12:10:25Z",
      • "createdByUser": {
        },
      • "createdBy": "159",
      • "modifiedByUser": {
        },
      • "modifiedBy": "159"
      },
    • "entity": {
      • "key": "1",
      • "id": "1",
      • "name": "United States of America",
      • "href": "/objects/company-config/entity/1"
      },
    • "href": "/objects/general-ledger/budget-detail/13"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}

Delete budget detail

delete/objects/general-ledger/budget-detail/{key}

Deletes a budget detail.

SecurityOAuth2
Request
path Parameters
key
required
string

System-assigned key for the budget detail.

Example: 153
Responses
204

No Content

400

Bad Request

Request samples
Response samples
application/json
{
  • "ia::result": {
    • "ia::error": {
      • "code": "invalidRequest",
      • "message": "A POST request requires a payload",
      • "errorId": "REST-1028",
      • "additionalInfo": {
        },
      • "supportId": "Kxi78%7EZuyXBDEGVHD2UmO1phYXDQAAAAo"
      }
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 0,
    • "totalError": 1
    }
}