AccountBudget
Return and update general ledger account budgets.
Date Released: Feb 2015 Date Updated: Jan 2022
Please note: While accessibility via the API is available to both AccountRight and new Essentials files. Not all features will be displayed in Product for new Essentials or the AccountRight Browser.
The elements list below details information for AccountBudget. To view the descriptions for the elements you can either hover any attribute to reveal details or click here to show all details inline.
Items shown with are required when posting or puting data
Items shown with are read-only elements
Attribute Details
- FinancialYearInteger
- Fiancial year can consist of current FY or next FY only.
- LastMonthInFinancialYearInteger
- Number representing the last month of the financial year. For example, 3 indicates March.
- Budgets []
- An array of account budget information.
- Account
- The following set of information pulls through account details.
- UIDString (6)
- Foreign Key: Unique identifier for the account in the form of a guid.
- NameString (60)
- Name of the account.
- DisplayIDString (6)
- Account code format includes separator ie 4-1100
- URIString
- Uniform resource identifier assoicated with the account object.
- MonthlyBudgets []
- An array of monthly account budget information.
- YearInteger
- Financial year in which the budget was generated i.e. 2018.
- MonthInteger
- Month in which the budget activity was generated i.e. December = 12.
- AmountDecimal (13.6)
- Budget amount for general ledger account (Supports both balance sheet and profit & loss accounts).
- URIString
- Uniform resource identifier encompasses all types of names and addresses that refer to objects on the web.
Paging: default page size is set to 400 with a maximum of 1000 results.
Example json GET response
{ "FinancialYear" : 2019, "LastMonthInFinancialYear" : 6, "Budgets" : [
- {
- "Account" : {
- "UID" : "dc7c6467-d1db-4026-a9bd-126996cef479",
- "Name" : "General Cheque Account 1",
- "DisplayID" : "1-1110",
- "URI" : "{cf_uri}/GeneralLedger/Account/dc7c6467-d1db-4026-a9bd-126996cef479"
- },
- "MonthlyBudgets" : [
- {
- "Year" : 2018,
- "Month" : 7,
- "Amount" : 1569
- },
- {
- "Year" : 2018,
- "Month" : 8,
- "Amount" : 1969
- }
- ]
- }
- ]
"URI" : "{cf_uri}/GeneralLedger/AccountBudget/2019"}
