Skip to main content
GL

GLBudgetLine

PX.Objects.GLScreenGL505510Release 2025.2

Represents a budget article. The class is used for both group (see IsGroup) and leaf articles. To maintain tree structure, the class stores a link to the parent budget article in the ParentGroupID field. The budget article holds the amount allocated to a particular account-subaccount pair (or a group of accounts and subaccounts, such as AccountMask) for a particular year. Distribution of this amount between the periods of the year is stored in the corresponding GLBudgetLineDetail records. Records of this type are created on the Budgets (GL302010) form (see the GLBudgetEntry graph) either manually or by the preload mechanism that creates GLBudgetLine from GLBudgetTree records."/>

Field NameTypeDisplay NameForeign Key
AccountID API Default Navigation
intAccountAccount
Description:The identifier of the GL account of the budget article. Corresponds to the Account.AccountID field. The value of the field can be empty for the group articles (see IsGroup).
AccountMask
nvarchar(10)Account Mask-
Description:For a group article (see IsGroup), defines the mask for selection of the child budget articles by their accounts. The selector on the AccountID field of the child articles allows only accounts whose Account.AccountCD matches the specified mask.
AllocatedAmount API
decimalDistributed Amount-
Description:The total amount of the budget article distributed between the periods of the year. The value of this field is calculated as a sum of amounts of the detail lines of the budget article (see GLBudgetLineDetail.Amount) and cannot be edited by a user. A budget article cannot be released until its Amount and AllocatedAmount are equal to each other.
Amount API
decimalAmount-
Description:The amount that is budgeted for the article for a particular year. The value can be edited by a user and indicates the decision to allocate the specified amount to the particular budget article. After the article is released, the amount can still be edited. If the amount is changed, the article will be marked as unreleased (see Released) and can be released again, which will result in updating the budget ledger figures to match the current state of the article.
BranchID API Default Navigation
intBranchBranch
Description:The identifier of the branch to which the budget article belongs. This field is a part of the compound key. Corresponds to the Branch.BranchID field.
ClearedNonexistent in DB
bool?-
Description:The field is reserved for internal use.
ComparisonNonexistent in DB
bool?-
Description:No description available
CreatedByID API Default Navigation
uniqueidentifierCreated ByUsers
Description:No description available
CreatedByScreenID
char(8)-
Description:No description available
CreatedDateTime
datetime-
Description:No description available
Description API
nvarchar(150)Description-
Description:The description of the budget article. Defaults to the description of the account, but can be overwritten by user.
FinYear API
char(4)Financial Year-
Description:The financial year to which the budget article belongs. This field is a part of the compound key. Corresponds to the FinYear.year field.
GroupID API
uniqueidentifierGroupID-
Description:The unique identifier of the budget article. This field is a part of the compound key.
GroupMask
varbinary-
Description:The group mask showing which restriction groups the budget article belongs to. The value of this field is inherited from the group mask of the corresponding budget tree node, because access to budgets is managed through the budget tree configuration.
IsGroup API
bitNode-
Description:Specifies (if set to "true") that the budget article represents a group of other articles. That is, the article has child articles, which are linked to this article by their ParentGroupID field.
IsPreloaded
bitPreloaded-
Description:No description available
IsRolledUpNonexistent in DB
bool?-
Description:No description available
IsUploadedNonexistent in DB
bool?-
Description:No description available
LastModifiedByID API Default Navigation
uniqueidentifierLast Modified ByUsers
Description:No description available
LastModifiedByScreenID
char(8)-
Description:No description available
LastModifiedDateTime
datetime-
Description:No description available
LedgerID API Default Navigation
intLedger
Description:The identifier of the ledger to which the budget article belongs. This field is a part of the compound key. Corresponds to the Ledger.LedgerID field.
NoteID
uniqueidentifier-
Description:No description available
ParentGroupID
uniqueidentifierParentGroupID-
Description:The identifier of the parent budget article. This field is a part of the compound key. Corresponds to the GLBudgetLine.GroupID field of the parent. The value is equal to Guid.Empty for the nodes on the first level of the tree.
Released API
bitReleased-
Description:Specifies (if set to "true") that the budget article has been released at least once. A released article can be released again if its Amount is not equal to its ReleasedAmount.
ReleasedAmount
decimalReleased Amount-
Description:The currently released amount of the article, which matches the figures in the budget ledger. This field is updated with the value of the Amount field upon release of the budget article. The difference between the values of this field and the Amount field shows the difference between the current state of the article and the corresponding figures in the budget ledger.
Rollup
bitRollup-
Description:No description available
SelectedNonexistent in DB
bool?Selected-
Description:No description available
SortOrderNonexistent in DB
int?-
Description:The internal field that defines the order in which non-group budget articles appear relative to each other. This field is populated only in the GLBudgetEntry graph and is not stored in the database.
SubID API Default Navigation
intSubaccountSub
Description:The identifier of the GL subaccount of the budget article. Corresponds to the Sub.SubID field. Can be empty for the group articles (see IsGroup).
SubMask
nvarchar(30)Subaccount Mask-
Description:For a group article (see IsGroup), defines the mask for selection of the child budget articles by their subaccounts. The selector on the SubID field of the child articles allows only subaccounts whose Sub.SubCD matches the specified mask.
TreeSortOrder
intTreeSortOrder-
Description:An integer field that defines the order in which group budget articles (see IsGroup) that belong to one parent appear relative to each other in the tree view. The value of this field is automatically assigned during budget tree preload from GLBudgetTree.SortOrder of the corresponding tree node.
WasReleased
bit-
Description:Specifies (if set to "true") that the article was released at least once. Different from Released in that the latter will be reset to "false" upon edits of a released article, while this field will still be "true" even if the article can be released again.
tstamp
timestamp-
Description:No description available