HTTP status code 200
Returns a list of fiscal-year items
Body
Media type: application/json
Type: json
Content:
{ "$schema": "", "description": "A collection of fiscal years", "type": "object", "properties": { "fiscalYears": { "description": "The list of fiscal year objects in this collection", "type": "array", "id": "fiscal_years", "items": { "type": "object", "$schema": "", "description": "A fiscal year record", "properties": { "id": { "description": "UUID of the fiscal year record", "$schema": "", "type": "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}$" }, "_version": { "type": "integer", "description": "Record version for optimistic locking" }, "acqUnitIds": { "description": "UUIDs of the acquisition units associated with this fiscal year", "type": "array", "items": { "$schema": "", "description": "The UUID format string", "type": "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}$" } }, "name": { "description": "The name of the fiscal year", "type": "string" }, "code": { "description": "The code of the fiscal year", "type": "string" }, "currency": { "description": "Currency code which is recorded when the FY ends, otherwise the system currency can be assumed", "type": "string" }, "description": { "description": "The description of the fiscal year", "type": "string" }, "periodStart": { "description": "The start date of the fiscal year", "type": "string", "format": "date-time" }, "periodEnd": { "description": "The end date of the fiscal year", "type": "string", "format": "date-time" }, "series": { "description": "The fiscal year series", "type": "string" }, "financialSummary": { "description": "Includes Funding information and Financial activity", "$schema": "", "type": "object", "properties": { "allocated": { "description": "Summary of all related to this fiscal year budgets allocated", "type": "number", "readonly": true }, "available": { "description": "Summary of all related to this fiscal year budgets available", "type": "number", "readonly": true }, "unavailable": { "description": "Summary of all related to this fiscal year budgets unavailable", "type": "number", "readonly": true }, "initialAllocation": { "description": "Summary of all related to this fiscal year budgets initialAllocation", "type": "number", "readonly": true }, "allocationTo": { "description": "Summary of all related to this fiscal year budgets allocationTo", "type": "number", "readonly": true }, "allocationFrom": { "description": "Summary of all related to this fiscal year budgets allocationFrom", "type": "number", "readonly": true }, "totalFunding": { "description": "Summary of all related to this fiscal year budgets totalFunding", "type": "number", "readonly": true }, "cashBalance": { "description": "Summary of all related to this fiscal year budgets cashBalance", "type": "number", "readonly": true }, "awaitingPayment": { "description": "Summary of all related to this fiscal year budgets awaitingPayment", "type": "number", "readonly": true }, "encumbered": { "description": "Summary of all related to this fiscal year budgets encumbered", "type": "number", "readonly": true }, "expenditures": { "description": "Summary of all related to this ledger budgets expenditures", "type": "number", "readonly": true }, "overEncumbrance": { "description": "Summary of all related to this ledger budgets overEncumbrance", "type": "number", "readonly": true }, "overExpended": { "description": "Summary of all related to this ledger budgets overExpended", "type": "number", "readonly": true } }, "additionalProperties": false }, "metadata": { "type": "object", "readonly": true, "$schema": "", "id": "metadata.schema", "title": "Metadata Schema", "description": "Metadata about creation and changes to records, provided by the server (client should not provide)", "properties": { "createdDate": { "description": "Date and time when the record was created", "type": "string", "format": "date-time" }, "createdByUserId": { "description": "ID of the user who created the record (when available)", "type": "string", "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}$" }, "createdByUsername": { "description": "Username of the user who created the record (when available)", "type": "string" }, "updatedDate": { "description": "Date and time when the record was last updated", "type": "string", "format": "date-time" }, "updatedByUserId": { "description": "ID of the user who last updated the record (when available)", "type": "string", "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}$" }, "updatedByUsername": { "description": "Username of the user who last updated the record (when available)", "type": "string" } }, "additionalProperties": false, "required": [ "createdDate" ] } }, "additionalProperties": false, "required": [ "code", "name", "periodStart", "periodEnd" ] } }, "totalRecords": { "description": "The number of objects in this collection", "type": "integer" } }, "additionalProperties": false, "required": [ "fiscalYears", "totalRecords" ]
}Example:
{ "fiscalYears": [ { "id": "ac2164c7-ba3d-1bc2-a12c-e35ceccbfaf2", "name": "Fiscal Year 2017", "code": "FY2017", "currency": "USD", "description": "January 1 - December 30", "periodStart": "2017-01-01T00:00:00Z", "periodEnd": "2017-12-30T23:59:59Z", "series": "FY", "metadata": { "createdDate": "2016-12-17T14:12:42.497+0000", "createdByUserId": "bfb64f23-818d-488a-a868-62c40d9510a1", "updatedDate": "2017-12-28T08:37:19.263+0000", "updatedByUserId": "498492aa-f909-42f6-b154-5bf66e6486ba" } }, { "id": "517efc6a-f218-4d25-a832-10de4dc32f25", "name": "Fiscal decade 2020-2029", "code": "FY2029", "description": "January 1 - December 30", "periodStart": "2020-01-01T00:00:00Z", "periodEnd": "2029-12-30T23:59:59Z", "series": "FY", "metadata": { "createdDate": "2019-06-17T14:12:42.497+0000", "createdByUserId": "498492aa-f909-42f6-b154-5bf66e6486ba", "updatedDate": "2019-08-28T08:37:19.263+0000", "updatedByUserId": "7ec56c96-e9f2-4079-9509-86b00f8dacd5" } } ], "totalRecords": 2
}HTTP status code 400
Bad request, e.g. malformed request body or query parameter. Details of the error (e.g. name of the parameter or line/character number with malformed data) provided in the response.
Body
Media type: text/plain
Type: any
Example:
unable to list fiscal-years -- malformed parameter 'query', syntax error at column 6HTTP status code 401
Not authorized to perform requested action
Body
Media type: text/plain
Type: any
Example:
unable to list fiscal-years -- unauthorizedHTTP status code 422
Validation errors
Body
Media type: application/json
Type: json
Content:
{ "$schema": "", "id": "errors.schema", "description": "A set of errors", "type": "object", "properties": { "errors": { "description": "List of errors", "id": "errors", "type": "array", "items": { "type": "object", "$schema": "", "id": "error.schema", "description": "An error", "properties": { "message": { "type": "string", "description": "Error message text" }, "type": { "type": "string", "description": "Error message type" }, "code": { "type": "string", "description": "Error message code" }, "parameters": { "description": "Error message parameters", "$schema": "", "id": "parameters.schema", "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string" }, "value": { "type": "string" } } } } }, "required": [ "message" ] } }, "total_records": { "description": "Total number of errors", "type": "integer" } }
}Example:
{ "errors": [ { "message": "may not be null", "type": "1", "code": "-1", "parameters": [ { "key": "moduleTo", "value": "null" } ] } ]
}HTTP status code 500
Internal server error, e.g. due to misconfiguration
Body
Media type: text/plain
Type: any
Example:
internal server error, contact administrator
