-
Notifications
You must be signed in to change notification settings - Fork 6
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[MODFISTO-500] - Implement endpoint to return all finance data for FY
- Loading branch information
Showing
2 changed files
with
97 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,73 @@ | ||
{ | ||
"$schema": "http://json-schema.org/draft-04/schema#", | ||
"description": "Finance data for a fiscal year", | ||
"type": "object", | ||
"properties": { | ||
"fiscalYearCode": { | ||
"description": "The code of the fiscal year", | ||
"type": "string" | ||
}, | ||
"fundId": { | ||
"description": "Fund UUID", | ||
"$ref": "../../common/schemas/uuid.json" | ||
}, | ||
"fundCode": { | ||
"description": "A unique code associated with the fund", | ||
"$ref": "../../common/schemas/fund_code.json" | ||
}, | ||
"fundName": { | ||
"description": "The name of this fund", | ||
"type": "string" | ||
}, | ||
"fundStatus": { | ||
"description": "The current status of this fund", | ||
"type": "string", | ||
"enum": [ | ||
"Active", | ||
"Frozen", | ||
"Inactive" | ||
] | ||
}, | ||
"fundTags": { | ||
"type": "object", | ||
"description": "Arbitrary tags associated with this fund", | ||
"$ref": "../../../raml-util/schemas/tags.schema" | ||
}, | ||
"budgetId": { | ||
"description": "UUID of this budget", | ||
"$ref": "../../common/schemas/uuid.json" | ||
}, | ||
"budgetName": { | ||
"description": "The name of the budget", | ||
"type": "string" | ||
}, | ||
"budgetStatus": { | ||
"description": "The status of the budget", | ||
"type": "string", | ||
"enum": [ | ||
"Active", | ||
"Frozen", | ||
"Inactive", | ||
"Planned", | ||
"Closed" | ||
] | ||
}, | ||
"budgetInitialAllocation": { | ||
"default": 0, | ||
"description": "The amount of the first allocation made to this budget", | ||
"type": "number" | ||
}, | ||
"budgetAllowableExpenditure": { | ||
"description": "The expenditure percentage limit for this budget", | ||
"type": "number" | ||
}, | ||
"budgetAllowableEncumbrance": { | ||
"description": "The encumbrance percentage limit for this budget", | ||
"type": "number" | ||
} | ||
}, | ||
"required": [ | ||
"fiscalYearCode", | ||
"fundId" | ||
] | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,24 @@ | ||
{ | ||
"$schema": "http://json-schema.org/draft-04/schema#", | ||
"description": "A collection of fiscal year finance data", | ||
"type": "object", | ||
"properties": { | ||
"fyFinanceData": { | ||
"description": "The list of fiscal year finance data objects contained in this collection", | ||
"type": "array", | ||
"items": { | ||
"type": "object", | ||
"$ref": "fund_update_log.json" | ||
} | ||
}, | ||
"totalRecords": { | ||
"description": "The number of objects contained in this collection", | ||
"type": "integer" | ||
} | ||
}, | ||
"additionalProperties": false, | ||
"required": [ | ||
"fyFinanceData", | ||
"totalRecords" | ||
] | ||
} |