Skip to main content

Budget

Budgets. Represents a budget in the system.

type Budget {
  branchId: Int!
  groupId: String!
  ledgerId: Int!
  financialYear: String!
  released: Boolean!
  releasedAmount: Decimal!
  accountId: Int
  subaccountId: Int
  description: String
  amount: Decimal
  distributedAmount: Decimal!
  lastModifiedDateTime: DateTime!
  periods: [Period!]
  companyId: Int!
  id: String!
  createdInDataMartDateTime: DateTime!
  updatedInDataMartDateTime: DateTime!
}

Fields

`Budget.branchId` ● `Int!` non-null scalar

branchId > The unique identifier of the branch.

`Budget.groupId` ● `String!` non-null scalar

groupId > (PK) The unique identifier of the budget line.

`Budget.ledgerId` ● `Int!` non-null scalar

ledgerId > The unique identifier of the ledger.

`Budget.financialYear` ● `String!` non-null scalar

financialYear > The financial year of the budget.

`Budget.released` ● `Boolean!` non-null scalar

released > Indicates whether the budget article has been released.

`Budget.releasedAmount` ● `Decimal!` non-null scalar

releasedAmount > The amount that has been released for this budget article.

`Budget.accountId` ● `Int` scalar

accountId > The account of the budget article if the article is a leaf on the budget tree.

`Budget.subaccountId` ● `Int` scalar

subaccountId > The subaccount of the budget article if the article is a leaf on the budget tree.

`Budget.description` ● `String` scalar

description > A description of the budget article. By default, this displays the account description.

`Budget.amount` ● `Decimal` scalar

amount > The budget article amount.

`Budget.distributedAmount` ● `Decimal!` non-null scalar

distributedAmount > The amount distributed over the periods.

`Budget.lastModifiedDateTime` ● `DateTime!` non-null scalar

lastModifiedDateTime > The last modified date and time of the budget.

`Budget.periods` ● `[Period!]` list object

periods > The collection of budget periods containing the period number and year.

`Budget.companyId` ● `Int!` non-null scalar

companyId > (PK) The unique identifier of the company.

`Budget.id` ● `String!` non-null scalar

id > The unique identifier of the document in DataMart.

`Budget.createdInDataMartDateTime` ● `DateTime!` non-null scalar

createdInDataMartDateTime > The UTC DateTime when this document has been added to DataMart.

`Budget.updatedInDataMartDateTime` ● `DateTime!` non-null scalar

updatedInDataMartDateTime > The UTC DateTime when this document has been updated in DataMart.

Returned By

budgetById query ● budgets query

Fields
Returned By