/
budget.json
144 lines (144 loc) · 3.88 KB
/
budget.json
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
{
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "A budget",
"type": "object",
"javaName": "budget",
"extends" : {
"$ref" : "../../common/schemas/entity.json"
},
"properties": {
"id": {
"description": "UUID of this budget",
"$ref": "../../common/schemas/uuid.json"
},
"_version": {
"type": "integer",
"description": "Record version for optimistic locking"
},
"name": {
"description": "The name of the budget",
"type": "string"
},
"budgetStatus": {
"description": "The status of the budget",
"type": "string",
"enum": [
"Active",
"Frozen",
"Inactive",
"Planned",
"Closed"
]
},
"allowableEncumbrance": {
"description": "The encumbrance percentage limit for this budget",
"type": "number"
},
"allowableExpenditure": {
"description": "The expenditure percentage limit for this budget",
"type": "number"
},
"allocated": {
"description": "The amount currently allocated to this budget",
"type": "number",
"readonly": true
},
"awaitingPayment": {
"default": 0,
"description": "The amount currently awaiting payment for this budget",
"type": "number"
},
"available": {
"description": "The amount currently available for this budge",
"type": "number",
"readonly": true
},
"encumbered": {
"default": 0,
"description": "The amount currently encumbered for this budget",
"type": "number"
},
"expenditures": {
"default": 0,
"description": "The amount currently expended for this budget",
"type": "number"
},
"netTransfers": {
"default": 0,
"description": "Summing all the transfers on this budget",
"type": "number"
},
"unavailable" : {
"description": "Unavailable amount for this budget",
"type": "number",
"readonly": true
},
"overEncumbrance": {
"description": "The amount currently over-encumbered for this budget",
"type": "number",
"readonly": true
},
"overExpended": {
"description": "Amount the budget is over expended.",
"type": "number",
"readonly": true
},
"fundId": {
"description": "UUID of fund",
"$ref": "../../common/schemas/uuid.json"
},
"fiscalYearId": {
"description": "UUID of fiscal year",
"$ref": "../../common/schemas/uuid.json"
},
"acqUnitIds": {
"description": "acquisition unit ids associated with this budget",
"type": "array",
"items": {
"$ref": "../../common/schemas/uuid.json"
}
},
"tags": {
"type": "object",
"description": "arbitrary tags associated with this budget",
"$ref": "../../../raml-util/schemas/tags.schema"
},
"metadata": {
"type": "object",
"$ref": "../../../raml-util/schemas/metadata.schema",
"readonly": true
},
"initialAllocation": {
"default": 0,
"description": "The amount of the first allocation made to this budget",
"type": "number"
},
"allocationTo": {
"default": 0,
"description": "The sum of all allocation transaction amounts made TO this budget not including the Initial allocation",
"type": "number"
},
"allocationFrom": {
"default": 0,
"description": "The sum of all allocation transaction amounts made FROM this budget not including the Initial allocation",
"type": "number"
},
"totalFunding": {
"description": "budget.allocated + budget.netTransfers",
"type": "number",
"readonly": true
},
"cashBalance": {
"description": "Total Funding minus Expended",
"type": "number",
"readonly": true
}
},
"additionalProperties": false,
"required": [
"budgetStatus",
"name",
"fundId",
"fiscalYearId"
]
}