mod-finance-storage

/finance-storage/group-budgets

Entity representing a group-budget

/finance-storage/group-budgets get

get

Get list of budgets

Request
Response

Query Parameters

query: (string)
A 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 code
Example:
```
(username=="ab*" or personal.firstName=="ab*" or personal.lastName=="ab*") and active=="true" sortby personal.lastName personal.firstName barcode

["code", "MEDGRANT", "="]
```
totalRecords: (string - default: auto - pattern: exact|estimated|none|auto)
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:
```
none
```
offset: (integer - default: 0 - minimum: 0 - maximum: 2147483647)
Skip over a number of elements by specifying an offset value for the query
Example:
```
0
```
limit: (integer - default: 10 - minimum: 0 - maximum: 2147483647)
Limit the number of elements returned in the response
Example:
```
10
```

HTTP status code 200

Returns item with a given ID

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "A collection of budgets",
  "type": "object",
  "properties": {
    "budgets": {
      "description": "The list of budget objects contained in this collection",
      "type": "array",
      "id": "budgets",
      "items": {
        "type": "object",
        "$schema": "http://json-schema.org/draft-04/schema#",
        "description": "A budget",
        "javaName": "budget",
        "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"
          },
          "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",
            "minimum": 0
          },
          "allowableExpenditure": {
            "description": "The expenditure percentage limit for this budget",
            "type": "number",
            "minimum": 0
          },
          "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
          },
          "credits": {
            "default": 0,
            "description": "The amount currently credited for 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",
            "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",
            "$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}$"
          },
          "fiscalYearId": {
            "description": "UUID of fiscal year",
            "$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}$"
          },
          "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",
            "readonly": true
          },
          "cashBalance": {
            "description": "Total Funding minus Expended",
            "type": "number",
            "readonly": true
          }
        },
        "additionalProperties": false,
        "required": [
          "budgetStatus",
          "name",
          "fundId",
          "fiscalYearId"
        ]
      }
    },
    "totalRecords": {
      "description": "The number of objects contained in this collection",
      "type": "integer"
    }
  },
  "additionalProperties": false,
  "required": [
    "budgets",
    "totalRecords"
  ]
}

Example:

{
  "budgets": [
    {
      "id": "47ac60b4-159d-4e1c-9acb-8293df67d16d",
      "name": "History 2017",
      "budgetStatus": "Active",
      "allowableEncumbrance": 95,
      "allowableExpenditure": 100,
      "allocated": 20000,
      "awaitingPayment": 3500,
      "available": 10000,
      "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
}

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 group-budgets -- malformed parameter 'query', syntax error at column 6"

HTTP status code 401

Not authorized to perform requested action

Body

Media type: text/plain

Type: any

Example:

"unable to list group-budgets -- unauthorized"

HTTP status code 404

Item with a given ID not found

Body

Media type: text/plain

Type: any

Example:

"group-budget not found"

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

mod-finance-storage version v1

Budgets

/finance-storage/group-budgets