mod-finance-storage (v2)

https://github.com/folio-org/mod-finance-storage

Table of contents

mod-finance-storage (Budgets)

CRUD APIs used to manage budgets.

/finance-storage/budgets

Collection of budget items.

GET /finance-storage/budgets

Get list of budgets

GET /finance-storage/budgets
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"
      }
    },
    "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",
      "code": "HIST-2017",
      "budgetStatus": "Active",
      "limitEncPercent": 95,
      "limitExpPercent": 100,
      "allocation": 20000,
      "awaitingPayment": 3500,
      "available": 10000,
      "encumbered": 2000,
      "expenditures": 4500,
      "overEncumbrance": 0,
      "fundId": "172364c7-AaAa-10C2-a12C-e35CeCcbfaF2",
      "fiscalYearId": "AC2164c7-Ba3d-1bC2-a12C-e35CeCcbfaF2",
      "tags": [
        "570c60b4-159F-4e1c-9ECB-8293Df67D16d",
        "b981e3e2-cd26-1CE2-a6Cd-159eAEfb351d"
      ]
    }
  ],
  "totalRecords": 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 budgets -- 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 budgets -- unauthorized

Response 422

Validation errors

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "A set of errors",
  "type": "object",
  "properties": {
    "errors": {
      "description": "List of errors",
      "id": "errors",
      "type": "array",
      "items": {
        "type": "object",
        "$ref": "error.schema"
      }
    },
    "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"
        }
      ]
    }
  ]
}

Response 500

Internal server error, e.g. due to misconfiguration

Body

Media type: text/plain

Type: any

Example:

internal server error, contact administrator

POST /finance-storage/budgets

Create a new budget item.

POST /finance-storage/budgets
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}-[1-5][a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$"
    },
    "name": {
      "description": "The name of the budget",
      "type": "string"
    },
    "budgetStatus": {
      "description": "The status of the budget",
      "type": "string"
    },
    "code": {
      "description": "The code of the budget",
      "type": "string"
    },
    "limitEncPercent": {
      "description": "The encumbrance percentage limit for this budget",
      "type": "number"
    },
    "limitExpPercent": {
      "description": "The expenditure percentage limit for this budget",
      "type": "number"
    },
    "allocation": {
      "description": "The amount currently allocated to this budget",
      "type": "number"
    },
    "awaitingPayment": {
      "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"
    },
    "overEncumbrance": {
      "description": "The amount currently over-encumbered for this budget",
      "type": "number"
    },
    "fundId": {
      "type": ["string", "null"],
      "description": "UUID",
      "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$"
    },
    "fiscalYearId": {
      "type": ["string", "null"],
      "description": "UUID",
      "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[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}-[1-5][a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$"
      }
    }
  },
  "additionalProperties": false,
  "required": [
    "name",
    "code"
  ]
}

Example:

{
  "id": "47Ac60b4-159D-4e1c-9aCB-8293Df67D16d",
  "name": "History 2017",
  "code": "HIST-2017",
  "budgetStatus": "Active",
  "limitEncPercent": 95,
  "limitExpPercent": 100,
  "allocation": 20000,
  "awaitingPayment": 3500,
  "available": 10000,
  "encumbered": 2000,
  "expenditures": 4500,
  "overEncumbrance": 0,
  "fundId": "172364c7-AaAa-10C2-b12C-e35CeCcbfaF2",
  "fiscalYearId": "AC2164c7-Ba3d-2bC2-a12C-e35CeCcbfaF2",
  "tags": [
    "570c60b4-159F-4e1c-9ECB-8293Df67D16d",
    "b981e3e2-cd26-5CE2-a6Cd-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",
  "budgetStatus": "Active",
  "limitEncPercent": 95,
  "limitExpPercent": 100,
  "allocation": 20000,
  "awaitingPayment": 3500,
  "available": 10000,
  "encumbered": 2000,
  "expenditures": 4500,
  "overEncumbrance": 0,
  "fundId": "172364c7-AaAa-10C2-b12C-e35CeCcbfaF2",
  "fiscalYearId": "AC2164c7-Ba3d-2bC2-a12C-e35CeCcbfaF2",
  "tags": [
    "570c60b4-159F-4e1c-9ECB-8293Df67D16d",
    "b981e3e2-cd26-5CE2-a6Cd-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 budgets -- unauthorized

Response 422

Validation errors

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "A set of errors",
  "type": "object",
  "properties": {
    "errors": {
      "description": "List of errors",
      "id": "errors",
      "type": "array",
      "items": {
        "type": "object",
        "$ref": "error.schema"
      }
    },
    "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"
        }
      ]
    }
  ]
}

Response 500

Internal server error, e.g. due to misconfiguration

Body

Media type: text/plain

Type: any

Example:

Internal server error, contact administrator

GET /finance-storage/budgets/{id}

Retrieve budget item with given {budgetId}

GET /finance-storage/budgets/{id}
URI Parameters
  • id: required (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}$)

    The UUID of a budget

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}-[1-5][a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$"
    },
    "name": {
      "description": "The name of the budget",
      "type": "string"
    },
    "budgetStatus": {
      "description": "The status of the budget",
      "type": "string"
    },
    "code": {
      "description": "The code of the budget",
      "type": "string"
    },
    "limitEncPercent": {
      "description": "The encumbrance percentage limit for this budget",
      "type": "number"
    },
    "limitExpPercent": {
      "description": "The expenditure percentage limit for this budget",
      "type": "number"
    },
    "allocation": {
      "description": "The amount currently allocated to this budget",
      "type": "number"
    },
    "awaitingPayment": {
      "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"
    },
    "overEncumbrance": {
      "description": "The amount currently over-encumbered for this budget",
      "type": "number"
    },
    "fundId": {
      "type": ["string", "null"],
      "description": "UUID",
      "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$"
    },
    "fiscalYearId": {
      "type": ["string", "null"],
      "description": "UUID",
      "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[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}-[1-5][a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$"
      }
    }
  },
  "additionalProperties": false,
  "required": [
    "name",
    "code"
  ]
}

Example:

{
  "id": "47Ac60b4-159D-4e1c-9aCB-8293Df67D16d",
  "name": "History 2017",
  "code": "HIST-2017",
  "budgetStatus": "Active",
  "limitEncPercent": 95,
  "limitExpPercent": 100,
  "allocation": 20000,
  "awaitingPayment": 3500,
  "available": 10000,
  "encumbered": 2000,
  "expenditures": 4500,
  "overEncumbrance": 0,
  "fundId": "172364c7-AaAa-10C2-b12C-e35CeCcbfaF2",
  "fiscalYearId": "AC2164c7-Ba3d-2bC2-a12C-e35CeCcbfaF2",
  "tags": [
    "570c60b4-159F-4e1c-9ECB-8293Df67D16d",
    "b981e3e2-cd26-5CE2-a6Cd-159eAEfb351d"
  ]
}

Response 404

Item with a given ID not found

Body

Media type: text/plain

Type: any

Example:

"budget not found"

Response 422

Validation errors

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "A set of errors",
  "type": "object",
  "properties": {
    "errors": {
      "description": "List of errors",
      "id": "errors",
      "type": "array",
      "items": {
        "type": "object",
        "$ref": "error.schema"
      }
    },
    "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"
        }
      ]
    }
  ]
}

Response 500

Internal server error, e.g. due to misconfiguration

Body

Media type: text/plain

Type: any

Example:

internal server error, contact administrator

DELETE /finance-storage/budgets/{id}

Delete budget item with given {budgetId}

DELETE /finance-storage/budgets/{id}
URI Parameters
  • id: required (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}$)

    The UUID of a budget

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 422

Validation errors

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "A set of errors",
  "type": "object",
  "properties": {
    "errors": {
      "description": "List of errors",
      "id": "errors",
      "type": "array",
      "items": {
        "type": "object",
        "$ref": "error.schema"
      }
    },
    "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"
        }
      ]
    }
  ]
}

Response 500

Internal server error, e.g. due to misconfiguration

Body

Media type: text/plain

Type: any

Example:

Internal server error, contact administrator

PUT /finance-storage/budgets/{id}

Update budget item with given {budgetId}

PUT /finance-storage/budgets/{id}
URI Parameters
  • id: required (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}$)

    The UUID of a 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}-[1-5][a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$"
    },
    "name": {
      "description": "The name of the budget",
      "type": "string"
    },
    "budgetStatus": {
      "description": "The status of the budget",
      "type": "string"
    },
    "code": {
      "description": "The code of the budget",
      "type": "string"
    },
    "limitEncPercent": {
      "description": "The encumbrance percentage limit for this budget",
      "type": "number"
    },
    "limitExpPercent": {
      "description": "The expenditure percentage limit for this budget",
      "type": "number"
    },
    "allocation": {
      "description": "The amount currently allocated to this budget",
      "type": "number"
    },
    "awaitingPayment": {
      "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"
    },
    "overEncumbrance": {
      "description": "The amount currently over-encumbered for this budget",
      "type": "number"
    },
    "fundId": {
      "type": ["string", "null"],
      "description": "UUID",
      "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$"
    },
    "fiscalYearId": {
      "type": ["string", "null"],
      "description": "UUID",
      "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[1-5][a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[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}-[1-5][a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$"
      }
    }
  },
  "additionalProperties": false,
  "required": [
    "name",
    "code"
  ]
}

Example:

{
  "id": "47Ac60b4-159D-4e1c-9aCB-8293Df67D16d",
  "name": "History 2017",
  "code": "HIST-2017",
  "budgetStatus": "Active",
  "limitEncPercent": 95,
  "limitExpPercent": 100,
  "allocation": 20000,
  "awaitingPayment": 3500,
  "available": 10000,
  "encumbered": 2000,
  "expenditures": 4500,
  "overEncumbrance": 0,
  "fundId": "172364c7-AaAa-10C2-b12C-e35CeCcbfaF2",
  "fiscalYearId": "AC2164c7-Ba3d-2bC2-a12C-e35CeCcbfaF2",
  "tags": [
    "570c60b4-159F-4e1c-9ECB-8293Df67D16d",
    "b981e3e2-cd26-5CE2-a6Cd-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 422

Validation errors

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "A set of errors",
  "type": "object",
  "properties": {
    "errors": {
      "description": "List of errors",
      "id": "errors",
      "type": "array",
      "items": {
        "type": "object",
        "$ref": "error.schema"
      }
    },
    "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"
        }
      ]
    }
  ]
}

Response 500

Internal server error, e.g. due to misconfiguration

Body

Media type: text/plain

Type: any

Example:

internal server error, contact administrator