mod-funds (v1)

https://github.com/folio-org/mod-funds

Table of contents

mod-funds (Budgets)

CRUD APIs used to manage budgets.

/budget

Collection of budget items.

GET /budget

Get list of budgets

GET /budget
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: e.g.

    Example:

    (username=="ab*" or personal.firstName=="ab*" or personal.lastName=="ab*") and active=="true" sortby personal.lastName personal.firstName barcode
    
    ["code", "MEDGRANT", "="]
    
  • 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
  • lang: (string - default: en - pattern: [a-zA-Z]{2})

    Requested language. Optional. [lang=en]

Response 200

Returns a list of budget items

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",
        "$ref": "budget.json"
      }
    },
    "total_records": {
      "description": "The number of objects contained in this collection",
      "type": "integer"
    },
    "first": {
      "description": "The index of the first object contained in this collection",
      "type": "integer"
    },
    "last": {
      "description": "The index of the last object contained in this collection",
      "type": "integer"
    }
  },
  "additionalProperties": false,
  "required": [
    "budgets",
    "total_records"
  ]
}

Example:

{
  "budgets": [
    {
      "id": "47Ac60b4-159D-4e1c-9aCB-8293Df67D16d",
      "name": "History 2017",
      "code": "HIST-2017",
      "budget_status": "Active",
      "limit_enc_percent": 95,
      "limit_exp_percent": 100,
      "allocation": 20000,
      "awaiting_payment": 3500,
      "available": 10000,
      "encumbered": 2000,
      "expenditures": 4500,
      "over_encumbrance": 0,
      "fund_id": "172364c7-AaAa-A0C2-C12C-e35CeCcbfaF2",
      "fiscal_year_id": "AC2164c7-Ba3d-AbC2-C12C-e35CeCcbfaF2",
      "tags": [
        "570c60b4-159F-4e1c-9ECB-8293Df67D16d",
        "b981e3e2-cd26-dCE2-c6Cd-159eAEfb351d"
      ]
    }
  ],
  "total_records": 1,
  "first": 1,
  "last": 1
}

Response 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 budget -- malformed parameter 'query', syntax error at column 6

Response 401

Not authorized to perform requested action

Body

Media type: text/plain

Type: any

Example:

unable to list budget -- unauthorized

Response 500

Internal server error, e.g. due to misconfiguration

Body

Media type: text/plain

Type: any

Example:

internal server error, contact administrator

POST /budget

Create a new budget item.

POST /budget
Query Parameters
  • lang: (string - default: en - pattern: [a-zA-Z]{2})

    Requested language. Optional. [lang=en]

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "A budget",
  "type": "object",
  "properties": {
    "id": {
      "type": ["string", "null"],
      "description": "UUID",
      "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}$"
    },
    "name": {
      "description": "The name of the budget",
      "type": "string"
    },
    "budget_status": {
      "description": "The status of the budget",
      "type": "string"
    },
    "code": {
      "description": "The code of the budget",
      "type": "string"
    },
    "limit_enc_percent": {
      "description": "The encumbrance percentage limit for this budget",
      "type": "number"
    },
    "limit_exp_percent": {
      "description": "The expenditure percentage limit for this budget",
      "type": "number"
    },
    "allocation": {
      "description": "The amount currently allocated to this budget",
      "type": "number"
    },
    "awaiting_payment": {
      "description": "The amount currently awaiting payment for this budget",
      "type": "number"
    },
    "available": {
      "description": "The amount currently available for this budge",
      "type": "number"
    },
    "encumbered": {
      "description": "The amount currently encumbered for this budget",
      "type": "number"
    },
    "expenditures": {
      "description": "The amount currently expended for this budget",
      "type": "number"
    },
    "over_encumbrance": {
      "description": "The amount currently over-encumbered for this budget",
      "type": "number"
    },
    "fund_id": {
      "type": ["string", "null"],
      "description": "UUID",
      "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}$"
    },
    "fiscal_year_id": {
      "type": ["string", "null"],
      "description": "UUID",
      "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}$"
    },
    "tags": {
      "id": "tags",
      "description": "The list of tags associated with this budget",
      "type": "array",
      "items": {
        "type": "string",
        "description": "UUID",
        "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}$"
      }
    }
  },
  "additionalProperties": false,
  "required": [
    "name",
    "code"
  ]
}

Example:

{
  "id": "47Ac60b4-159D-4e1c-9aCB-8293Df67D16d",
  "name": "History 2017",
  "code": "HIST-2017",
  "budget_status": "Active",
  "limit_enc_percent": 95,
  "limit_exp_percent": 100,
  "allocation": 20000,
  "awaiting_payment": 3500,
  "available": 10000,
  "encumbered": 2000,
  "expenditures": 4500,
  "over_encumbrance": 0,
  "fund_id": "172364c7-AaAa-A0C2-C12C-e35CeCcbfaF2",
  "fiscal_year_id": "AC2164c7-Ba3d-AbC2-C12C-e35CeCcbfaF2",
  "tags": [
    "570c60b4-159F-4e1c-9ECB-8293Df67D16d",
    "b981e3e2-cd26-dCE2-c6Cd-159eAEfb351d"
  ]
}

Response 201

Returns a newly created item, with server-controlled fields like 'id' populated

Headers
  • Location: required (string)

    URI to the created budget item

Body

Media type: application/json

Type: any

Example:

{
  "id": "47Ac60b4-159D-4e1c-9aCB-8293Df67D16d",
  "name": "History 2017",
  "code": "HIST-2017",
  "budget_status": "Active",
  "limit_enc_percent": 95,
  "limit_exp_percent": 100,
  "allocation": 20000,
  "awaiting_payment": 3500,
  "available": 10000,
  "encumbered": 2000,
  "expenditures": 4500,
  "over_encumbrance": 0,
  "fund_id": "172364c7-AaAa-A0C2-C12C-e35CeCcbfaF2",
  "fiscal_year_id": "AC2164c7-Ba3d-AbC2-C12C-e35CeCcbfaF2",
  "tags": [
    "570c60b4-159F-4e1c-9ECB-8293Df67D16d",
    "b981e3e2-cd26-dCE2-c6Cd-159eAEfb351d"
  ]
}

Response 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 add budget -- malformed JSON at 13:3"

Response 401

Not authorized to perform requested action

Body

Media type: text/plain

Type: any

Example:

unable to create budget -- unauthorized

Response 500

Internal server error, e.g. due to misconfiguration

Body

Media type: text/plain

Type: any

Example:

Internal server error, contact administrator

GET /budget/{id}

Retrieve budget item with given {budgetId}

GET /budget/{id}
URI Parameters
  • id: required (string)
Query Parameters
  • lang: (string - default: en - pattern: [a-zA-Z]{2})

    Requested language. Optional. [lang=en]

Response 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 budget",
  "type": "object",
  "properties": {
    "id": {
      "type": ["string", "null"],
      "description": "UUID",
      "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}$"
    },
    "name": {
      "description": "The name of the budget",
      "type": "string"
    },
    "budget_status": {
      "description": "The status of the budget",
      "type": "string"
    },
    "code": {
      "description": "The code of the budget",
      "type": "string"
    },
    "limit_enc_percent": {
      "description": "The encumbrance percentage limit for this budget",
      "type": "number"
    },
    "limit_exp_percent": {
      "description": "The expenditure percentage limit for this budget",
      "type": "number"
    },
    "allocation": {
      "description": "The amount currently allocated to this budget",
      "type": "number"
    },
    "awaiting_payment": {
      "description": "The amount currently awaiting payment for this budget",
      "type": "number"
    },
    "available": {
      "description": "The amount currently available for this budge",
      "type": "number"
    },
    "encumbered": {
      "description": "The amount currently encumbered for this budget",
      "type": "number"
    },
    "expenditures": {
      "description": "The amount currently expended for this budget",
      "type": "number"
    },
    "over_encumbrance": {
      "description": "The amount currently over-encumbered for this budget",
      "type": "number"
    },
    "fund_id": {
      "type": ["string", "null"],
      "description": "UUID",
      "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}$"
    },
    "fiscal_year_id": {
      "type": ["string", "null"],
      "description": "UUID",
      "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}$"
    },
    "tags": {
      "id": "tags",
      "description": "The list of tags associated with this budget",
      "type": "array",
      "items": {
        "type": "string",
        "description": "UUID",
        "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}$"
      }
    }
  },
  "additionalProperties": false,
  "required": [
    "name",
    "code"
  ]
}

Example:

{
  "id": "47Ac60b4-159D-4e1c-9aCB-8293Df67D16d",
  "name": "History 2017",
  "code": "HIST-2017",
  "budget_status": "Active",
  "limit_enc_percent": 95,
  "limit_exp_percent": 100,
  "allocation": 20000,
  "awaiting_payment": 3500,
  "available": 10000,
  "encumbered": 2000,
  "expenditures": 4500,
  "over_encumbrance": 0,
  "fund_id": "172364c7-AaAa-A0C2-C12C-e35CeCcbfaF2",
  "fiscal_year_id": "AC2164c7-Ba3d-AbC2-C12C-e35CeCcbfaF2",
  "tags": [
    "570c60b4-159F-4e1c-9ECB-8293Df67D16d",
    "b981e3e2-cd26-dCE2-c6Cd-159eAEfb351d"
  ]
}

Response 404

Item with a given ID not found

Body

Media type: text/plain

Type: any

Example:

"budget not found"

Response 500

Internal server error, e.g. due to misconfiguration

Body

Media type: text/plain

Type: any

Example:

internal server error, contact administrator

DELETE /budget/{id}

Delete budget item with given {budgetId}

DELETE /budget/{id}
URI Parameters
  • id: required (string)
Query Parameters
  • lang: (string - default: en - pattern: [a-zA-Z]{2})

    Requested language. Optional. [lang=en]

Response 204

Item deleted successfully

Response 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 delete budget -- constraint violation"

Response 404

Item with a given ID not found

Body

Media type: text/plain

Type: any

Example:

"budget not found"

Response 500

Internal server error, e.g. due to misconfiguration

Body

Media type: text/plain

Type: any

Example:

Internal server error, contact administrator

PUT /budget/{id}

Update budget item with given {budgetId}

PUT /budget/{id}
URI Parameters
  • id: required (string)
Query Parameters
  • lang: (string - default: en - pattern: [a-zA-Z]{2})

    Requested language. Optional. [lang=en]

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "A budget",
  "type": "object",
  "properties": {
    "id": {
      "type": ["string", "null"],
      "description": "UUID",
      "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}$"
    },
    "name": {
      "description": "The name of the budget",
      "type": "string"
    },
    "budget_status": {
      "description": "The status of the budget",
      "type": "string"
    },
    "code": {
      "description": "The code of the budget",
      "type": "string"
    },
    "limit_enc_percent": {
      "description": "The encumbrance percentage limit for this budget",
      "type": "number"
    },
    "limit_exp_percent": {
      "description": "The expenditure percentage limit for this budget",
      "type": "number"
    },
    "allocation": {
      "description": "The amount currently allocated to this budget",
      "type": "number"
    },
    "awaiting_payment": {
      "description": "The amount currently awaiting payment for this budget",
      "type": "number"
    },
    "available": {
      "description": "The amount currently available for this budge",
      "type": "number"
    },
    "encumbered": {
      "description": "The amount currently encumbered for this budget",
      "type": "number"
    },
    "expenditures": {
      "description": "The amount currently expended for this budget",
      "type": "number"
    },
    "over_encumbrance": {
      "description": "The amount currently over-encumbered for this budget",
      "type": "number"
    },
    "fund_id": {
      "type": ["string", "null"],
      "description": "UUID",
      "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}$"
    },
    "fiscal_year_id": {
      "type": ["string", "null"],
      "description": "UUID",
      "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}$"
    },
    "tags": {
      "id": "tags",
      "description": "The list of tags associated with this budget",
      "type": "array",
      "items": {
        "type": "string",
        "description": "UUID",
        "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}$"
      }
    }
  },
  "additionalProperties": false,
  "required": [
    "name",
    "code"
  ]
}

Example:

{
  "id": "47Ac60b4-159D-4e1c-9aCB-8293Df67D16d",
  "name": "History 2017",
  "code": "HIST-2017",
  "budget_status": "Active",
  "limit_enc_percent": 95,
  "limit_exp_percent": 100,
  "allocation": 20000,
  "awaiting_payment": 3500,
  "available": 10000,
  "encumbered": 2000,
  "expenditures": 4500,
  "over_encumbrance": 0,
  "fund_id": "172364c7-AaAa-A0C2-C12C-e35CeCcbfaF2",
  "fiscal_year_id": "AC2164c7-Ba3d-AbC2-C12C-e35CeCcbfaF2",
  "tags": [
    "570c60b4-159F-4e1c-9ECB-8293Df67D16d",
    "b981e3e2-cd26-dCE2-c6Cd-159eAEfb351d"
  ]
}

Response 204

Item successfully updated

Response 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 update budget -- malformed JSON at 13:4"

Response 404

Item with a given ID not found

Body

Media type: text/plain

Type: any

Example:

"budget not found"

Response 500

Internal server error, e.g. due to misconfiguration

Body

Media type: text/plain

Type: any

Example:

internal server error, contact administrator