mod-finance-storage (v2)

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

Table of contents

mod-finance-storage (Encumbrance)

CRUD APIs used to manage encumbrances.

/finance-storage/encumbrances

Collection of encumbrance items.

GET /finance-storage/encumbrances

Get list of encumbrances

GET /finance-storage/encumbrances
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
    
    ["status", "Unreleased", "="]
    
  • 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 encumbrance items

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "A collection of encumbrances",
  "type": "object",
  "properties": {
    "encumbrances": {
      "description": "The list of encumbrance objects in this collection",
      "type": "array",
      "id": "encumbrances",
      "items": {
        "description": "The encumbrance items",
        "type": "object",
        "$ref": "encumbrance.json"
      }
    },
    "totalRecords": {
      "description": "The number of objects in this collection",
      "type": "integer"
    }
  },
  "additionalProperties": false,
  "required": [
    "encumbrances",
    "totalRecords"
  ]
}

Example:

{
  "encumbrances": [
    {
      "id": "47ac60b4-159d-4e1c-9acb-8293df67d16d",
      "amountEncumbered": 12.50,
      "amountAwaitingPayment": 12.50,
      "amountExpended": 1567.92,
      "budgetId": "e4030833-52c7-48c8-96f7-be2ca4e945ad",
      "fundId": "25318f14-5689-4317-a221-a84832980d2e",
      "poLineId": "e35daa9c-546f-46d2-aa92-f3223a05fb25",
      "status": "Unreleased"
    }
  ],
  "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 encumbrances -- 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 encumbrances -- 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/encumbrances

Create a new encumbrance item.

POST /finance-storage/encumbrances
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": "An encumbrance of fund resources",
  "type": "object",
  "properties": {
    "id": {
      "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}$"
    },
    "amountAwaitingPayment": {
      "description": "The amount of awaiting for payment",
      "type": "number"
    },
    "amountEncumbered": {
      "description": "The amount of this encumbrance",
      "type": "number"
    },
    "amountExpended": {
      "description": "The amount currently expended by this encumbrance",
      "type": "number"
    },
    "budgetId": {
      "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}$"
    },
    "fundId": {
      "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}$"
    },
    "note": {
      "description": "Note associated with this encumbrance",
      "type": "string"
    },
    "poLineId": {
      "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}$"
    },
    "status": {
      "description": "The status of this encumbrance",
      "type": "string",
      "enum": [
        "Released",
        "Unreleased"
      ],
      "default": "Unreleased"
    }
  },
  "additionalProperties": false,
  "required": [
    "amountEncumbered",
    "fundId",
    "poLineId"
  ]
}

Example:

{
  "id": "177abecb-54c8-4938-9950-ec0a58e1999c",
  "amountEncumbered": 12.50,
  "amountAwaitingPayment": 12.50,
  "amountExpended": 1567.92,
  "budgetId": "e4030833-52c7-48c8-96f7-be2ca4e945ad",
  "fundId": "25318f14-5689-4317-a221-a84832980d2e",
  "poLineId": "e35daa9c-546f-46d2-aa92-f3223a05fb25",
  "status": "Unreleased"
}

Response 201

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

Headers
  • Location: required (string)

    URI to the created encumbrance item

Body

Media type: application/json

Type: any

Example:

{
  "id": "177abecb-54c8-4938-9950-ec0a58e1999c",
  "amountEncumbered": 12.50,
  "amountAwaitingPayment": 12.50,
  "amountExpended": 1567.92,
  "budgetId": "e4030833-52c7-48c8-96f7-be2ca4e945ad",
  "fundId": "25318f14-5689-4317-a221-a84832980d2e",
  "poLineId": "e35daa9c-546f-46d2-aa92-f3223a05fb25",
  "status": "Unreleased"
}

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 encumbrance -- malformed JSON at 13:3"

Response 401

Not authorized to perform requested action

Body

Media type: text/plain

Type: any

Example:

unable to create encumbrances -- 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/encumbrances/{id}

Retrieve encumbrance item with given {encumbranceId}

GET /finance-storage/encumbrances/{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 an encumbrance

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": "An encumbrance of fund resources",
  "type": "object",
  "properties": {
    "id": {
      "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}$"
    },
    "amountAwaitingPayment": {
      "description": "The amount of awaiting for payment",
      "type": "number"
    },
    "amountEncumbered": {
      "description": "The amount of this encumbrance",
      "type": "number"
    },
    "amountExpended": {
      "description": "The amount currently expended by this encumbrance",
      "type": "number"
    },
    "budgetId": {
      "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}$"
    },
    "fundId": {
      "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}$"
    },
    "note": {
      "description": "Note associated with this encumbrance",
      "type": "string"
    },
    "poLineId": {
      "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}$"
    },
    "status": {
      "description": "The status of this encumbrance",
      "type": "string",
      "enum": [
        "Released",
        "Unreleased"
      ],
      "default": "Unreleased"
    }
  },
  "additionalProperties": false,
  "required": [
    "amountEncumbered",
    "fundId",
    "poLineId"
  ]
}

Example:

{
  "id": "177abecb-54c8-4938-9950-ec0a58e1999c",
  "amountEncumbered": 12.50,
  "amountAwaitingPayment": 12.50,
  "amountExpended": 1567.92,
  "budgetId": "e4030833-52c7-48c8-96f7-be2ca4e945ad",
  "fundId": "25318f14-5689-4317-a221-a84832980d2e",
  "poLineId": "e35daa9c-546f-46d2-aa92-f3223a05fb25",
  "status": "Unreleased"
}

Response 404

Item with a given ID not found

Body

Media type: text/plain

Type: any

Example:

"encumbrance 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/encumbrances/{id}

Delete encumbrance item with given {encumbranceId}

DELETE /finance-storage/encumbrances/{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 an encumbrance

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 encumbrance -- constraint violation"

Response 404

Item with a given ID not found

Body

Media type: text/plain

Type: any

Example:

"encumbrance 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/encumbrances/{id}

Update encumbrance item with given {encumbranceId}

PUT /finance-storage/encumbrances/{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 an encumbrance

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": "An encumbrance of fund resources",
  "type": "object",
  "properties": {
    "id": {
      "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}$"
    },
    "amountAwaitingPayment": {
      "description": "The amount of awaiting for payment",
      "type": "number"
    },
    "amountEncumbered": {
      "description": "The amount of this encumbrance",
      "type": "number"
    },
    "amountExpended": {
      "description": "The amount currently expended by this encumbrance",
      "type": "number"
    },
    "budgetId": {
      "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}$"
    },
    "fundId": {
      "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}$"
    },
    "note": {
      "description": "Note associated with this encumbrance",
      "type": "string"
    },
    "poLineId": {
      "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}$"
    },
    "status": {
      "description": "The status of this encumbrance",
      "type": "string",
      "enum": [
        "Released",
        "Unreleased"
      ],
      "default": "Unreleased"
    }
  },
  "additionalProperties": false,
  "required": [
    "amountEncumbered",
    "fundId",
    "poLineId"
  ]
}

Example:

{
  "id": "177abecb-54c8-4938-9950-ec0a58e1999c",
  "amountEncumbered": 12.50,
  "amountAwaitingPayment": 12.50,
  "amountExpended": 1567.92,
  "budgetId": "e4030833-52c7-48c8-96f7-be2ca4e945ad",
  "fundId": "25318f14-5689-4317-a221-a84832980d2e",
  "poLineId": "e35daa9c-546f-46d2-aa92-f3223a05fb25",
  "status": "Unreleased"
}

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 encumbrance -- malformed JSON at 13:4"

Response 404

Item with a given ID not found

Body

Media type: text/plain

Type: any

Example:

"encumbrance 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