Comparison version: 4.0.1
Comparison date: 2021-04-29T03:38:03+00:00
----
@ ["extends"]
- {"$schema":"http://json-schema.org/draft-04/schema#","additionalProperties":false,"description":"A budget","extends":{"$schema":"http://json-schema.org/draft-04/schema#","additionalProperties":false,"description":"Purchase order number prefix","javaName":"entity","properties":{"id":{"$schema":"http://json-schema.org/draft-04/schema#","description":"UUID identifying this entity","pattern":"^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$","type":"string"}},"type":"object"},"javaName":"budget","properties":{"acqUnitIds":{"description":"acquisition unit ids associated with this budget","items":{"$schema":"http://json-schema.org/draft-04/schema#","description":"The UUID format string","pattern":"^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$","type":"string"},"type":"array"},"allocated":{"default":0,"description":"The amount currently allocated to this budget","type":"number"},"allowableEncumbrance":{"description":"The encumbrance percentage limit for this budget","type":"number"},"allowableExpenditure":{"description":"The expenditure percentage limit for this budget","type":"number"},"available":{"default":0,"description":"The amount currently available for this budge","type":"number"},"awaitingPayment":{"default":0,"description":"The amount currently awaiting payment for this budget","type":"number"},"budgetStatus":{"description":"The status of the budget","enum":["Active","Frozen","Inactive","Planned","Closed"],"type":"string"},"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"},"fiscalYearId":{"$schema":"http://json-schema.org/draft-04/schema#","description":"UUID of fiscal year","pattern":"^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$","type":"string"},"fundId":{"$schema":"http://json-schema.org/draft-04/schema#","description":"UUID of fund","pattern":"^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$","type":"string"},"id":{"$schema":"http://json-schema.org/draft-04/schema#","description":"UUID of this budget","pattern":"^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$","type":"string"},"metadata":{"$schema":"http://json-schema.org/draft-04/schema#","additionalProperties":false,"description":"Metadata about creation and changes to records, provided by the server (client should not provide)","properties":{"createdByUserId":{"description":"ID of the user who created the record (when available)","pattern":"^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$","type":"string"},"createdByUsername":{"description":"Username of the user who created the record (when available)","type":"string"},"createdDate":{"description":"Date and time when the record was created","format":"date-time","type":"string"},"updatedByUserId":{"description":"ID of the user who last updated the record (when available)","pattern":"^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$","type":"string"},"updatedByUsername":{"description":"Username of the user who last updated the record (when available)","type":"string"},"updatedDate":{"description":"Date and time when the record was last updated","format":"date-time","type":"string"}},"readonly":true,"required":["createdDate"],"title":"Metadata Schema","type":"object"},"name":{"description":"The name of the budget","type":"string"},"netTransfers":{"default":0,"description":"Summing all the transfers on this budget","type":"number"},"overEncumbrance":{"default":0,"description":"The amount currently over-encumbered for this budget","type":"number"},"overExpended":{"default":0,"description":"Amount the budget is over expended.","type":"number"},"tags":{"$schema":"http://json-schema.org/draft-04/schema#","additionalProperties":false,"description":"arbitrary tags associated with this budget","properties":{"tagList":{"description":"List of tags","items":{"type":"string"},"type":"array"}},"title":"tags","type":"object"},"unavailable":{"default":0,"description":"Unavailable amount for this budget","type":"number"}},"required":["allocated","budgetStatus","name","fundId","fiscalYearId"],"type":"object"}
@ ["properties","acqUnitIds"]
+ {"description":"acquisition unit ids associated with this budget","items":{"$schema":"http://json-schema.org/draft-04/schema#","description":"The UUID format string","pattern":"^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$","type":"string"},"type":"array"}
@ ["properties","allocated"]
+ {"description":"The amount currently allocated to this budget","type":"number"}
@ ["properties","allocationFrom"]
+ {"description":"The sum of all allocation transaction amounts made FROM this budget not including the Initial allocation","readonly":true,"type":"number"}
@ ["properties","allocationTo"]
+ {"description":"The sum of all allocation transaction amounts made TO this budget not including the Initial allocation","readonly":true,"type":"number"}
@ ["properties","allowableEncumbrance"]
+ {"description":"The encumbrance percentage limit for this budget","type":"number"}
@ ["properties","allowableExpenditure"]
+ {"description":"The expenditure percentage limit for this budget","type":"number"}
@ ["properties","available"]
+ {"description":"The amount currently available for this budge","readonly":true,"type":"number"}
@ ["properties","awaitingPayment"]
+ {"default":0,"description":"The amount currently awaiting payment for this budget","type":"number"}
@ ["properties","budgetStatus"]
+ {"description":"The status of the budget","enum":["Active","Frozen","Inactive","Planned","Closed"],"type":"string"}
@ ["properties","cashBalance"]
+ {"description":"Total Funding minus Expended","readonly":true,"type":"number"}
@ ["properties","encumbered"]
+ {"default":0,"description":"The amount currently encumbered for this budget","type":"number"}
@ ["properties","expenditures"]
+ {"default":0,"description":"The amount currently expended for this budget","type":"number"}
@ ["properties","fiscalYearId"]
+ {"$schema":"http://json-schema.org/draft-04/schema#","description":"UUID of fiscal year","pattern":"^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$","type":"string"}
@ ["properties","fundId"]
+ {"$schema":"http://json-schema.org/draft-04/schema#","description":"UUID of fund","pattern":"^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$","type":"string"}
@ ["properties","id"]
+ {"$schema":"http://json-schema.org/draft-04/schema#","description":"UUID of this budget","pattern":"^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$","type":"string"}
@ ["properties","initialAllocation"]
+ {"description":"The amount of the first allocation made to this budget","readonly":true,"type":"number"}
@ ["properties","metadata"]
+ {"$schema":"http://json-schema.org/draft-04/schema#","additionalProperties":false,"description":"Metadata about creation and changes to records, provided by the server (client should not provide)","properties":{"createdByUserId":{"description":"ID of the user who created the record (when available)","pattern":"^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$","type":"string"},"createdByUsername":{"description":"Username of the user who created the record (when available)","type":"string"},"createdDate":{"description":"Date and time when the record was created","format":"date-time","type":"string"},"updatedByUserId":{"description":"ID of the user who last updated the record (when available)","pattern":"^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$","type":"string"},"updatedByUsername":{"description":"Username of the user who last updated the record (when available)","type":"string"},"updatedDate":{"description":"Date and time when the record was last updated","format":"date-time","type":"string"}},"readonly":true,"required":["createdDate"],"title":"Metadata Schema","type":"object"}
@ ["properties","name"]
+ {"description":"The name of the budget","type":"string"}
@ ["properties","netTransfers"]
+ {"default":0,"description":"Summing all the transfers on this budget","type":"number"}
@ ["properties","overEncumbrance"]
+ {"description":"The amount currently over-encumbered for this budget","readonly":true,"type":"number"}
@ ["properties","overExpended"]
+ {"description":"Amount the budget is over expended.","readonly":true,"type":"number"}
@ ["properties","tags"]
+ {"$schema":"http://json-schema.org/draft-04/schema#","additionalProperties":false,"description":"arbitrary tags associated with this budget","properties":{"tagList":{"description":"List of tags","items":{"type":"string"},"type":"array"}},"title":"tags","type":"object"}
@ ["properties","totalFunding"]
+ {"description":"budget.allocated + budget.netTransfers","readonly":true,"type":"number"}
@ ["properties","unavailable"]
+ {"description":"Unavailable amount for this budget","readonly":true,"type":"number"}
@ ["required"]
+ ["allocated"]
