Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

PropertyTypeDefaultRequiredNotes
idstring
NUUID - system generated if not specified
namestring
YUnique
descriptionstring
N
codestring
YUnique
ledger_statusstring
Yenum: Active, Inactive, Frozen

allocated

number
Nnot persisted
unavailablenumber
Nnot persisted
availablenumber
Nnot persisted
currencystring
Ncurrency code 
acquisitionUnitsarray<string>
NArray of UUIDs corresponding to the acquisition units assigned to this ledger.
metadatametadata
NoSystem generated metadata (createdBy/updatedBy/createdOn/etc.)

ledgerFY

PropertyTypeDefaultRequiredUpdated On TransactionNotes
idstring
N

N

UUID - system generated if not specified
ledgerIdstring
YNUUID of ledger
fiscalYearIdstring
YNUUID of fiscal year

allocated

number
NY
unavailablenumber
NY
availablenumber
NY
currencystring
YNcurrency code for this fiscal year 

...

  • Essentially a Fund/FY object

budget

PropertyTypeDefaultRequiredUpdated On TransactionNotes
idstring
NNUUID - system generated if not specified
namestring
YN= <fund.code>-<fiscal_year.code>, eg. AFRICAHIST-FY19.  Unique
budgetStatusstring
YNenum: Active, Frozen, Planned, Closed
allowableEncumbrancenumber
NN
allowableExpenditurenumber
NN
allocatednumber
YYRunning total of all the allocation transactions against the budget.
awaitingPaymentnumber
NY (encumbrance only)Running total of all the invoiced amounts (i.e. waiting to be paid)
availablenumber
NY = allocation - awaiting_payment - encumbered - expenditures
encumberednumber
NY (encumbrance only)Running total of money set aside for purchases
expendituresnumber
NY (encumbrance only)Running total of all the payments recorded by the fund
unavailablenumber
NYTBD
overEncumbrancenumber
NY (encumbrance only)Amount the budget is over encumbered. Is this needed?
overExpendednumber
NY (encumbrance only)Amount the budget is over expended. Is this needed?
fundIdstring
YNUUID of fund
fiscalYearIdstring
YNUUID of fiscal year
acquisitionUnitsarray<string>
NNArray of UUIDs corresponding to the acquisition units assigned to this budget.
tagstags
NNinherited from fund
metadatametadata
NYSystem generated metadata (createdBy/updatedBy/createdOn/etc.)

TODO - Add a column indicating which values are static and which need to be updated on an ongoing basis

APIs

Business Logic Module

...