https://github.com/folio-org/mod-finance
APIs used to manage ledger rollover budgets.
Entity representing a ledger-rollovers-budget
Get list of rollovers budgets
GET /finance/ledger-rollovers-budgetsA query expressed as a CQL string (see dev.folio.org/reference/glossary#cql) using valid searchable fields. The first example below shows the general form of a full CQL query, but those fields might not be relevant in this context.
with valid searchable fields: for example 'budgetStatus'
Example:
(username=="ab*" or personal.firstName=="ab*" or personal.lastName=="ab*") and active=="true" sortby personal.lastName personal.firstName barcode
["budgetStatus", "Active", "="]
How to calculate the totalRecords property. "exact" for the correct number, "estimated" for an estimation, "auto" to automatically select "exact" or "estimated", "none" for suppressing the totalRecords property. For details see https://github.com/folio-org/raml-module-builder#estimated-totalrecords
Example:
noneSkip over a number of elements by specifying an offset value for the query
Example:
0Limit the number of elements returned in the response. Using limit=0 will return totalRecords with the exact value. For details about totalRecords see https://github.com/folio-org/raml-module-builder#estimated-totalrecords
Example:
10Returns item with a given ID
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Contains a list of budgets generated during the rollover. Also budgets include all calculated mounts",
"type": "object",
"properties": {
"ledgerFiscalYearRolloverBudgets": {
"description": "The list of fiscal year rollover errors",
"type": "array",
"items": {
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "A budget",
"type": "object",
"properties": {
"id": {
"description": "UUID of this budget",
"$schema": "http://json-schema.org/draft-04/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"
},
"budgetId": {
"description": "Ledger fiscal year rollover budget UUID",
"$schema": "http://json-schema.org/draft-04/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}$"
},
"ledgerRolloverId": {
"description": "Ledger fiscal year rollover UUID",
"$schema": "http://json-schema.org/draft-04/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}$"
},
"name": {
"description": "The name of the budget",
"type": "string"
},
"fundDetails": {
"description": "Fund details for a budget",
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema#",
"properties": {
"id": {
"description": "UUID of this fund",
"$schema": "http://json-schema.org/draft-04/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}$"
},
"name": {
"description": "The name of the fund",
"type": "string"
},
"code": {
"description": "The code of the fund",
"type": "string"
},
"fundStatus": {
"description": "The current status of this fund",
"type": "string",
"enum": [
"Active",
"Frozen",
"Inactive"
]
},
"fundTypeId": {
"description": "UUID of the fund type associated with this fund",
"$schema": "http://json-schema.org/draft-04/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}$"
},
"fundTypeName": {
"description": "Name of the fund type associated with this fund",
"type": "string"
},
"externalAccountNo": {
"description": "Corresponding account in the financial system. Will be recorded in payment generated as well.",
"type": "string"
},
"description": {
"description": "The description of this fund",
"type": "string"
},
"acqUnitIds": {
"description": "acquisition unit ids associated with this fund",
"type": "array",
"items": {
"$schema": "http://json-schema.org/draft-04/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}$"
}
},
"donorOrganizationIds": {
"description": "donor organization ids associated with this fund",
"type": "array",
"items": {
"$schema": "http://json-schema.org/draft-04/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}$"
}
},
"restrictByLocations": {
"description": "restrict usage of this fund by locations",
"type": "boolean",
"default": false
},
"locations": {
"description": "Locations associated with this fund",
"type": "array",
"items": {
"type": "object",
"properties": {
"locationId": {
"$schema": "http://json-schema.org/draft-04/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}$"
},
"tenantId": {
"description": "Tenant id of the associated location",
"type": "string"
}
},
"additionalProperties": false,
"required": [
"locationId"
]
}
},
"allocatedFromIds": {
"description": "All the funds ids that this fund is allowed to receive money from. This would be 1 fund or none. If this field is blank their is no restriction on allocating to this fund",
"type": "array",
"items": {
"$schema": "http://json-schema.org/draft-04/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}$"
}
},
"allocatedFromNames": {
"description": "All the funds names that this fund is allowed to receive money from. This would be 1 fund or none. If this field is blank their is no restriction on allocating to this fund",
"type": "array",
"items": {
"description": "UUID of the fund this fund is allowed to receive money from",
"type": "string"
}
},
"allocatedToIds": {
"description": "All the fund ids that this fund is allowed to send money to. This could be one or many.",
"type": "array",
"items": {
"$schema": "http://json-schema.org/draft-04/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}$"
}
},
"allocatedToNames": {
"description": "All the fund names that this fund is allowed to send money to. This could be one or many.",
"type": "array",
"items": {
"description": "UUID of the fund this fund is allowed to send money to",
"type": "string"
}
}
},
"additionalProperties": false,
"required": [
"code",
"fundStatus",
"name"
]
},
"expenseClassDetails": {
"description": "Expense class details for a budget",
"type": "array",
"items": {
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Budget expense class totals schema",
"javaType": "org.folio.rest.jaxrs.model.BudgetExpenseClassTotal",
"properties": {
"id": {
"description": "UUID of related expense class",
"$schema": "http://json-schema.org/draft-04/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}$"
},
"expenseClassName": {
"description": "The name of the expense class",
"type": "string"
},
"expenseClassCode": {
"description": "The name of the expense class",
"type": "string"
},
"expenseClassStatus": {
"description": "Status for expense class within the budget ",
"type": "string",
"enum": [
"Active",
"Inactive"
]
},
"encumbered": {
"description": "Total encumbered for expense class within a given budget",
"type": "number"
},
"awaitingPayment": {
"description": "Total awaitingPayment for expense class within a given budget",
"type": "number"
},
"credited": {
"description": "Total credited for expense class within a given budget",
"type": "number"
},
"percentageCredited": {
"description": "The percentage credited for the class on the total credited on a given budget",
"type": "number"
},
"expended": {
"description": "Total expended for expense class within a given budget",
"type": "number"
},
"percentageExpended": {
"description": "The percentage expended for the class on the total spent on a given budget",
"type": "number"
}
},
"additionalProperties": false
}
},
"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"
},
"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"
},
"credits": {
"default": 0,
"description": "The amount currently credited to this budget",
"type": "number"
},
"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"
},
"overEncumbrance": {
"description": "The amount currently over-encumbered for this budget",
"type": "number"
},
"overExpended": {
"description": "Amount the budget is over expended.",
"type": "number"
},
"fundId": {
"$schema": "http://json-schema.org/draft-04/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}$"
},
"fiscalYearId": {
"$schema": "http://json-schema.org/draft-04/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}$"
},
"acqUnitIds": {
"description": "acquisition unit ids associated with this budget",
"type": "array",
"items": {
"$schema": "http://json-schema.org/draft-04/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}$"
}
},
"tags": {
"type": "object",
"description": "arbitrary tags associated with this budget",
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "tags.schema",
"title": "tags",
"properties": {
"tagList": {
"description": "List of tags",
"type": "array",
"items": {
"type": "string"
}
}
},
"additionalProperties": false
},
"metadata": {
"type": "object",
"readonly": true,
"$schema": "http://json-schema.org/draft-04/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"
]
},
"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"
},
"cashBalance": {
"description": "Total Funding minus Expended",
"type": "number"
}
},
"additionalProperties": false,
"required": [
"budgetStatus",
"name",
"fundId",
"fiscalYearId"
]
}
},
"totalRecords": {
"description": "The number of records contained in this collection",
"type": "integer",
"minimum": 0
}
},
"additionalProperties": false,
"required": [
"ledgerFiscalYearRolloverBudgets",
"totalRecords"
]
}Example:
{
"budgets": [
{
"id": "47ac60b4-159d-4e1c-9acb-8293df67d16d",
"budgetId": "47ac60b4-159d-4e1c-9acb-8293df67d16d",
"ledgerRolloverId": "56ac60b4-122d-1e1c-9acb-8293df12d16d",
"name": "History 2017",
"fundDetails": {
"id": "6e2fbba3-d557-4480-bca3-b6f5c645de04",
"allocatedFromIds": [
"1a490199-833d-4876-b2ff-2bd61f8324f1",
"d69a001c-ac69-4348-bee1-f9f3ef8a3f32"
],
"allocatedFromNames": [
"Biology",
"Mathematics"
],
"allocatedToIds": [
"c08a5b0c-6717-4788-9df5-b0e8338c1172"
],
"allocatedToNames": [
"Geography"
],
"code": "HIST",
"description": "Tracking fund for the History department",
"externalAccountNo": "1121112569489",
"fundStatus": "Active",
"fundTypeId": "c93373df-e7ec-4d31-b200-719736610d89",
"fundTypeName": "Approvals",
"name": "History",
"acqUnitIds": [
"1895e539-8dac-441e-b1f5-aab62b3fde60",
"47f504bd-0c1b-498e-a2ae-e2f0a0cea273"
]
},
"expenseClassDetails": [
{
"id": "9e662186-7d3e-4732-baaa-93967ccc597e",
"expenseClassName": "Electronic",
"expenseClassCode": "Elec",
"expenseClassStatus": "Active",
"encumbered": "30.05",
"awaitingPayment": "0.0",
"expended": "103.0",
"percentageExpended": "51.5"
}
],
"budgetStatus": "Active",
"allowableEncumbrance": 95,
"allowableExpenditure": 100,
"allocated": 20000,
"netTransfers": 0,
"awaitingPayment": 3500,
"available": 10000,
"credits": 0,
"encumbered": 2000,
"expenditures": 4500,
"unavailable": 10000,
"overEncumbrance": 0,
"overExpended": 0,
"fundId": "172364c7-aaaa-10c2-b12c-e35ceccbfaf2",
"fiscalYearId": "ac2164c7-ba3d-2bc2-a12c-e35ceccbfaf2",
"acqUnitIds": [
"7ec2ed06-0504-40dc-bc53-7515955ff0cb"
],
"tags": {
"tagList": [
"important"
]
},
"metadata": {
"createdDate": "2018-07-19T00:00:00.000+0000",
"createdByUserId": "28d1057c-d137-11e8-a8d5-f2801f1b9fd1"
}
}
],
"totalRecords": 1
}
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.
Media type: text/plain
Type: any
Example:
"unable to list ledger-rollovers-budgets -- malformed parameter 'query', syntax error at column 6"
Not authorized to perform requested action
Media type: text/plain
Type: any
Example:
"unable to list ledger-rollovers-budgets -- unauthorized"
Item with a given ID not found
Media type: text/plain
Type: any
Example:
"ledger-rollovers-budget not found"
Validation errors
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/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": "http://json-schema.org/draft-04/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": "http://json-schema.org/draft-04/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"
}
]
}
]
}
Internal server error, e.g. due to misconfiguration
Media type: text/plain
Type: any
Example:
internal server error, contact administratorRetrieve ledger-rollovers-budget item with given {ledger-rollovers-budgetId}
GET /finance/ledger-rollovers-budgets/{id}The UUID of a rollover budgets record
Returns item with a given ID
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "A budget",
"type": "object",
"properties": {
"id": {
"description": "UUID of this budget",
"$schema": "http://json-schema.org/draft-04/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"
},
"budgetId": {
"description": "Ledger fiscal year rollover budget UUID",
"$schema": "http://json-schema.org/draft-04/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}$"
},
"ledgerRolloverId": {
"description": "Ledger fiscal year rollover UUID",
"$schema": "http://json-schema.org/draft-04/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}$"
},
"name": {
"description": "The name of the budget",
"type": "string"
},
"fundDetails": {
"description": "Fund details for a budget",
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema#",
"properties": {
"id": {
"description": "UUID of this fund",
"$schema": "http://json-schema.org/draft-04/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}$"
},
"name": {
"description": "The name of the fund",
"type": "string"
},
"code": {
"description": "The code of the fund",
"type": "string"
},
"fundStatus": {
"description": "The current status of this fund",
"type": "string",
"enum": [
"Active",
"Frozen",
"Inactive"
]
},
"fundTypeId": {
"description": "UUID of the fund type associated with this fund",
"$schema": "http://json-schema.org/draft-04/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}$"
},
"fundTypeName": {
"description": "Name of the fund type associated with this fund",
"type": "string"
},
"externalAccountNo": {
"description": "Corresponding account in the financial system. Will be recorded in payment generated as well.",
"type": "string"
},
"description": {
"description": "The description of this fund",
"type": "string"
},
"acqUnitIds": {
"description": "acquisition unit ids associated with this fund",
"type": "array",
"items": {
"$schema": "http://json-schema.org/draft-04/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}$"
}
},
"donorOrganizationIds": {
"description": "donor organization ids associated with this fund",
"type": "array",
"items": {
"$schema": "http://json-schema.org/draft-04/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}$"
}
},
"restrictByLocations": {
"description": "restrict usage of this fund by locations",
"type": "boolean",
"default": false
},
"locations": {
"description": "Locations associated with this fund",
"type": "array",
"items": {
"type": "object",
"properties": {
"locationId": {
"$schema": "http://json-schema.org/draft-04/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}$"
},
"tenantId": {
"description": "Tenant id of the associated location",
"type": "string"
}
},
"additionalProperties": false,
"required": [
"locationId"
]
}
},
"allocatedFromIds": {
"description": "All the funds ids that this fund is allowed to receive money from. This would be 1 fund or none. If this field is blank their is no restriction on allocating to this fund",
"type": "array",
"items": {
"$schema": "http://json-schema.org/draft-04/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}$"
}
},
"allocatedFromNames": {
"description": "All the funds names that this fund is allowed to receive money from. This would be 1 fund or none. If this field is blank their is no restriction on allocating to this fund",
"type": "array",
"items": {
"description": "UUID of the fund this fund is allowed to receive money from",
"type": "string"
}
},
"allocatedToIds": {
"description": "All the fund ids that this fund is allowed to send money to. This could be one or many.",
"type": "array",
"items": {
"$schema": "http://json-schema.org/draft-04/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}$"
}
},
"allocatedToNames": {
"description": "All the fund names that this fund is allowed to send money to. This could be one or many.",
"type": "array",
"items": {
"description": "UUID of the fund this fund is allowed to send money to",
"type": "string"
}
}
},
"additionalProperties": false,
"required": [
"code",
"fundStatus",
"name"
]
},
"expenseClassDetails": {
"description": "Expense class details for a budget",
"type": "array",
"items": {
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Budget expense class totals schema",
"javaType": "org.folio.rest.jaxrs.model.BudgetExpenseClassTotal",
"properties": {
"id": {
"description": "UUID of related expense class",
"$schema": "http://json-schema.org/draft-04/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}$"
},
"expenseClassName": {
"description": "The name of the expense class",
"type": "string"
},
"expenseClassCode": {
"description": "The name of the expense class",
"type": "string"
},
"expenseClassStatus": {
"description": "Status for expense class within the budget ",
"type": "string",
"enum": [
"Active",
"Inactive"
]
},
"encumbered": {
"description": "Total encumbered for expense class within a given budget",
"type": "number"
},
"awaitingPayment": {
"description": "Total awaitingPayment for expense class within a given budget",
"type": "number"
},
"credited": {
"description": "Total credited for expense class within a given budget",
"type": "number"
},
"percentageCredited": {
"description": "The percentage credited for the class on the total credited on a given budget",
"type": "number"
},
"expended": {
"description": "Total expended for expense class within a given budget",
"type": "number"
},
"percentageExpended": {
"description": "The percentage expended for the class on the total spent on a given budget",
"type": "number"
}
},
"additionalProperties": false
}
},
"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"
},
"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"
},
"credits": {
"default": 0,
"description": "The amount currently credited to this budget",
"type": "number"
},
"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"
},
"overEncumbrance": {
"description": "The amount currently over-encumbered for this budget",
"type": "number"
},
"overExpended": {
"description": "Amount the budget is over expended.",
"type": "number"
},
"fundId": {
"$schema": "http://json-schema.org/draft-04/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}$"
},
"fiscalYearId": {
"$schema": "http://json-schema.org/draft-04/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}$"
},
"acqUnitIds": {
"description": "acquisition unit ids associated with this budget",
"type": "array",
"items": {
"$schema": "http://json-schema.org/draft-04/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}$"
}
},
"tags": {
"type": "object",
"description": "arbitrary tags associated with this budget",
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "tags.schema",
"title": "tags",
"properties": {
"tagList": {
"description": "List of tags",
"type": "array",
"items": {
"type": "string"
}
}
},
"additionalProperties": false
},
"metadata": {
"type": "object",
"readonly": true,
"$schema": "http://json-schema.org/draft-04/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"
]
},
"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"
},
"cashBalance": {
"description": "Total Funding minus Expended",
"type": "number"
}
},
"additionalProperties": false,
"required": [
"budgetStatus",
"name",
"fundId",
"fiscalYearId"
]
}Example:
{
"id": "47ac60b4-159d-4e1c-9acb-8293df67d16d",
"budgetId": "47ac60b4-159d-4e1c-9acb-8293df67d16d",
"ledgerRolloverId": "56ac60b4-122d-1e1c-9acb-8293df12d16d",
"name": "History 2017",
"fundDetails": {
"id": "6e2fbba3-d557-4480-bca3-b6f5c645de04",
"allocatedFromIds": [
"1a490199-833d-4876-b2ff-2bd61f8324f1",
"d69a001c-ac69-4348-bee1-f9f3ef8a3f32"
],
"allocatedFromNames": [
"Biology",
"Mathematics"
],
"allocatedToIds": [
"c08a5b0c-6717-4788-9df5-b0e8338c1172"
],
"allocatedToNames": [
"Geography"
],
"code": "HIST",
"description": "Tracking fund for the History department",
"externalAccountNo": "1121112569489",
"fundStatus": "Active",
"fundTypeId": "c93373df-e7ec-4d31-b200-719736610d89",
"fundTypeName": "Approvals",
"name": "History",
"acqUnitIds": [
"1895e539-8dac-441e-b1f5-aab62b3fde60",
"47f504bd-0c1b-498e-a2ae-e2f0a0cea273"
]
},
"expenseClassDetails": [
{
"id": "9e662186-7d3e-4732-baaa-93967ccc597e",
"expenseClassName": "Electronic",
"expenseClassCode": "Elec",
"expenseClassStatus": "Active",
"encumbered": "30.05",
"awaitingPayment": "0.0",
"expended": "103.0",
"percentageExpended": "51.5"
}
],
"budgetStatus": "Active",
"allowableEncumbrance": 95,
"allowableExpenditure": 100,
"allocated": 20000,
"netTransfers": 0,
"awaitingPayment": 3500,
"available": 10000,
"credits": 3000,
"encumbered": 2000,
"expenditures": 4500,
"unavailable": 10000,
"overEncumbrance": 0,
"overExpended": 0,
"fundId": "172364c7-aaaa-10c2-b12c-e35ceccbfaf2",
"fiscalYearId": "ac2164c7-ba3d-2bc2-a12c-e35ceccbfaf2",
"acqUnitIds": [
"7ec2ed06-0504-40dc-bc53-7515955ff0cb"
],
"tags": {
"tagList": [
"important"
]
},
"metadata": {
"createdDate": "2018-07-19T00:00:00.000+0000",
"createdByUserId": "28d1057c-d137-11e8-a8d5-f2801f1b9fd1"
}
}
Not authorized to perform requested action
Media type: text/plain
Type: any
Example:
unable to get retrieve ledger-rollovers-budget -- unauthorizedItem with a given ID not found
Media type: text/plain
Type: any
Example:
"ledger-rollovers-budget not found"
Validation errors
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/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": "http://json-schema.org/draft-04/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": "http://json-schema.org/draft-04/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"
}
]
}
]
}
Internal server error, e.g. due to misconfiguration
Media type: text/plain
Type: any
Example:
internal server error, contact administrator