mod-finance-storage (v3)

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

mod-finance-storage (Fiscal Year)
/finance-storage/fiscal-years

mod-finance-storage (Fiscal Year)

CRUD APIs used to manage fiscal years.

/finance-storage/fiscal-years

Collection of fiscal-year items.

GET /finance-storage/fiscal-years

Get list of fiscal years

GET /finance-storage/fiscal-years

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", "="]
```
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 fiscal-year items

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "A collection of fiscal years",
  "type": "object",
  "properties": {
    "fiscalYears": {
      "description": "The list of fiscal year objects in this collection",
      "type": "array",
      "id": "fiscal_years",
      "items": {
        "type": "object",
        "$schema": "http://json-schema.org/draft-04/schema#",
        "description": "A fiscal year record",
        "properties": {
          "id": {
            "description": "UUID of the fiscal year record",
            "$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": "UUIDs of the acquisition units associated with this fiscal year",
            "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}$"
            }
          },
          "name": {
            "description": "The name of the fiscal year",
            "type": "string"
          },
          "code": {
            "description": "The code of the fiscal year",
            "type": "string",
            "pattern": "^[a-zA-Z]+[0-9]{4}$"
          },
          "currency": {
            "description": "Currency code which is recorded when the FY ends, otherwise the system currency can be assumed",
            "type": "string"
          },
          "description": {
            "description": "The description of the fiscal year",
            "type": "string"
          },
          "periodStart": {
            "description": "The start date of the fiscal year",
            "type": "string",
            "format": "date-time"
          },
          "periodEnd": {
            "description": "The end date of the fiscal year",
            "type": "string",
            "format": "date-time"
          },
          "series": {
            "description": "The fiscal year series",
            "type": "string"
          },
          "financialSummary": {
            "description": "Includes Funding information and Financial activity",
            "$schema": "http://json-schema.org/draft-04/schema#",
            "type": "object",
            "properties": {
              "allocated": {
                "description": "Summary of all related to this fiscal year budgets allocated",
                "type": "number",
                "readonly": true
              },
              "available": {
                "description": "Summary of all related to this fiscal year budgets available",
                "type": "number",
                "readonly": true
              },
              "unavailable": {
                "description": "Summary of all related to this fiscal year budgets unavailable",
                "type": "number",
                "readonly": true
              },
              "initialAllocation": {
                "description": "Summary of all related to this fiscal year budgets initialAllocation",
                "type": "number",
                "readonly": true
              },
              "allocationTo": {
                "description": "Summary of all related to this fiscal year budgets allocationTo",
                "type": "number",
                "readonly": true
              },
              "allocationFrom": {
                "description": "Summary of all related to this fiscal year budgets allocationFrom",
                "type": "number",
                "readonly": true
              },
              "totalFunding": {
                "description": "Summary of all related to this fiscal year budgets totalFunding",
                "type": "number",
                "readonly": true
              },
              "cashBalance": {
                "description": "Summary of all related to this fiscal year budgets cashBalance",
                "type": "number",
                "readonly": true
              },
              "awaitingPayment": {
                "description": "Summary of all related to this fiscal year budgets awaitingPayment",
                "type": "number",
                "readonly": true
              },
              "encumbered": {
                "description": "Summary of all related to this fiscal year budgets encumbered",
                "type": "number",
                "readonly": true
              },
              "expenditures": {
                "description": "Summary of all related to this ledger budgets expenditures",
                "type": "number",
                "readonly": true
              },
              "overEncumbrance": {
                "description": "Summary of all related to this ledger budgets overEncumbrance",
                "type": "number",
                "readonly": true
              },
              "overExpended": {
                "description": "Summary of all related to this ledger budgets overExpended",
                "type": "number",
                "readonly": true
              }
            },
            "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"
            ]
          }
        },
        "additionalProperties": false,
        "required": [
          "code",
          "name",
          "periodStart",
          "periodEnd"
        ]
      }
    },
    "totalRecords": {
      "description": "The number of objects in this collection",
      "type": "integer"
    }
  },
  "additionalProperties": false,
  "required": [
    "fiscalYears",
    "totalRecords"
  ]
}

Example:

{
  "fiscalYears": [
    {
      "id": "ac2164c7-ba3d-1bc2-a12c-e35ceccbfaf2",
      "name": "Fiscal Year 2017",
      "code": "FY2017",
      "currency": "USD",
      "description": "January 1 - December 30",
      "periodStart": "2017-01-01T00:00:00Z",
      "periodEnd": "2017-12-30T23:59:59Z",
      "series": "FY",
      "metadata": {
        "createdDate": "2016-12-17T14:12:42.497+0000",
        "createdByUserId": "bfb64f23-818d-488a-a868-62c40d9510a1",
        "updatedDate": "2017-12-28T08:37:19.263+0000",
        "updatedByUserId": "498492aa-f909-42f6-b154-5bf66e6486ba"
      }
    },
    {
      "id": "517efc6a-f218-4d25-a832-10de4dc32f25",
      "name": "Fiscal decade 2020-2029",
      "code": "FY2029",
      "description": "January 1 - December 30",
      "periodStart": "2020-01-01T00:00:00Z",
      "periodEnd": "2029-12-30T23:59:59Z",
      "series": "FY",
      "metadata": {
        "createdDate": "2019-06-17T14:12:42.497+0000",
        "createdByUserId": "498492aa-f909-42f6-b154-5bf66e6486ba",
        "updatedDate": "2019-08-28T08:37:19.263+0000",
        "updatedByUserId": "7ec56c96-e9f2-4079-9509-86b00f8dacd5"
      }
    }
  ],
  "totalRecords": 2
}

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 fiscal-years -- 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 fiscal-years -- unauthorized

Response 422

Validation errors

Body

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"
        }
      ]
    }
  ]
}

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/fiscal-years

Create a new fiscal-year item.

POST /finance-storage/fiscal-years

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 fiscal year record",
  "type": "object",
  "properties": {
    "id": {
      "description": "UUID of the fiscal year record",
      "$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": "UUIDs of the acquisition units associated with this fiscal year",
      "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}$"
      }
    },
    "name": {
      "description": "The name of the fiscal year",
      "type": "string"
    },
    "code": {
      "description": "The code of the fiscal year",
      "type": "string",
      "pattern": "^[a-zA-Z]+[0-9]{4}$"
    },
    "currency": {
      "description": "Currency code which is recorded when the FY ends, otherwise the system currency can be assumed",
      "type": "string"
    },
    "description": {
      "description": "The description of the fiscal year",
      "type": "string"
    },
    "periodStart": {
      "description": "The start date of the fiscal year",
      "type": "string",
      "format": "date-time"
    },
    "periodEnd": {
      "description": "The end date of the fiscal year",
      "type": "string",
      "format": "date-time"
    },
    "series": {
      "description": "The fiscal year series",
      "type": "string"
    },
    "financialSummary": {
      "description": "Includes Funding information and Financial activity",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "type": "object",
      "properties": {
        "allocated": {
          "description": "Summary of all related to this fiscal year budgets allocated",
          "type": "number",
          "readonly": true
        },
        "available": {
          "description": "Summary of all related to this fiscal year budgets available",
          "type": "number",
          "readonly": true
        },
        "unavailable": {
          "description": "Summary of all related to this fiscal year budgets unavailable",
          "type": "number",
          "readonly": true
        },
        "initialAllocation": {
          "description": "Summary of all related to this fiscal year budgets initialAllocation",
          "type": "number",
          "readonly": true
        },
        "allocationTo": {
          "description": "Summary of all related to this fiscal year budgets allocationTo",
          "type": "number",
          "readonly": true
        },
        "allocationFrom": {
          "description": "Summary of all related to this fiscal year budgets allocationFrom",
          "type": "number",
          "readonly": true
        },
        "totalFunding": {
          "description": "Summary of all related to this fiscal year budgets totalFunding",
          "type": "number",
          "readonly": true
        },
        "cashBalance": {
          "description": "Summary of all related to this fiscal year budgets cashBalance",
          "type": "number",
          "readonly": true
        },
        "awaitingPayment": {
          "description": "Summary of all related to this fiscal year budgets awaitingPayment",
          "type": "number",
          "readonly": true
        },
        "encumbered": {
          "description": "Summary of all related to this fiscal year budgets encumbered",
          "type": "number",
          "readonly": true
        },
        "expenditures": {
          "description": "Summary of all related to this ledger budgets expenditures",
          "type": "number",
          "readonly": true
        },
        "overEncumbrance": {
          "description": "Summary of all related to this ledger budgets overEncumbrance",
          "type": "number",
          "readonly": true
        },
        "overExpended": {
          "description": "Summary of all related to this ledger budgets overExpended",
          "type": "number",
          "readonly": true
        }
      },
      "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"
      ]
    }
  },
  "additionalProperties": false,
  "required": [
    "code",
    "name",
    "periodStart",
    "periodEnd"
  ]
}

Example:

{
  "id": "ac2164c7-ba3d-1bc2-a12c-e35ceccbfaf2",
  "name": "Fiscal Year 2020",
  "acqUnitIds": [
    "1895e539-8dac-441e-b1f5-aab62b3fde60",
    "47f504bd-0c1b-498e-a2ae-e2f0a0cea273"
  ],
  "code": "FY2020",
  "description": "January 1 - December 30",
  "periodStart": "2020-01-01T00:00:00Z",
  "periodEnd": "2020-12-30T23:59:59Z",
  "series": "FY",
  "financialSummary": {
    "initialAllocation": 1090230.80,
    "allocationTo": 1090230.80,
    "allocationFrom": 0,
    "allocated": 2180461.6,
    "available": 2180377.6,
    "totalFunding": 2180377.6,
    "cashBalance": 2180377.6,
    "encumbered": 0,
    "awaitingPayment": 0,
    "expenditures": 84,
    "unavailable": 84,
    "overEncumbrance": 0,
    "overExpended": 0
  },
  "metadata": {
    "createdDate": "2019-06-17T14:12:42.497+0000",
    "createdByUserId": "498492aa-f909-42f6-b154-5bf66e6486ba",
    "updatedDate": "2019-08-28T08:37:19.263+0000",
    "updatedByUserId": "7ec56c96-e9f2-4079-9509-86b00f8dacd5"
  }
}

Response 201

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

Headers

Location: required (string)
URI to the created fiscal-year item

Body

Media type: application/json

Type: any

Example:

{
  "id": "ac2164c7-ba3d-1bc2-a12c-e35ceccbfaf2",
  "name": "Fiscal Year 2020",
  "acqUnitIds": [
    "1895e539-8dac-441e-b1f5-aab62b3fde60",
    "47f504bd-0c1b-498e-a2ae-e2f0a0cea273"
  ],
  "code": "FY2020",
  "description": "January 1 - December 30",
  "periodStart": "2020-01-01T00:00:00Z",
  "periodEnd": "2020-12-30T23:59:59Z",
  "series": "FY",
  "financialSummary": {
    "initialAllocation": 1090230.80,
    "allocationTo": 1090230.80,
    "allocationFrom": 0,
    "allocated": 2180461.6,
    "available": 2180377.6,
    "totalFunding": 2180377.6,
    "cashBalance": 2180377.6,
    "encumbered": 0,
    "awaitingPayment": 0,
    "expenditures": 84,
    "unavailable": 84,
    "overEncumbrance": 0,
    "overExpended": 0
  },
  "metadata": {
    "createdDate": "2019-06-17T14:12:42.497+0000",
    "createdByUserId": "498492aa-f909-42f6-b154-5bf66e6486ba",
    "updatedDate": "2019-08-28T08:37:19.263+0000",
    "updatedByUserId": "7ec56c96-e9f2-4079-9509-86b00f8dacd5"
  }
}

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

Response 401

Not authorized to perform requested action

Body

Media type: text/plain

Type: any

Example:

unable to create fiscal-years -- unauthorized

Response 422

Validation errors

Body

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"
        }
      ]
    }
  ]
}

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/fiscal-years/{id}

Retrieve fiscal-year item with given {fiscal-yearId}

GET /finance-storage/fiscal-years/{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 fiscal year

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 fiscal year record",
  "type": "object",
  "properties": {
    "id": {
      "description": "UUID of the fiscal year record",
      "$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": "UUIDs of the acquisition units associated with this fiscal year",
      "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}$"
      }
    },
    "name": {
      "description": "The name of the fiscal year",
      "type": "string"
    },
    "code": {
      "description": "The code of the fiscal year",
      "type": "string",
      "pattern": "^[a-zA-Z]+[0-9]{4}$"
    },
    "currency": {
      "description": "Currency code which is recorded when the FY ends, otherwise the system currency can be assumed",
      "type": "string"
    },
    "description": {
      "description": "The description of the fiscal year",
      "type": "string"
    },
    "periodStart": {
      "description": "The start date of the fiscal year",
      "type": "string",
      "format": "date-time"
    },
    "periodEnd": {
      "description": "The end date of the fiscal year",
      "type": "string",
      "format": "date-time"
    },
    "series": {
      "description": "The fiscal year series",
      "type": "string"
    },
    "financialSummary": {
      "description": "Includes Funding information and Financial activity",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "type": "object",
      "properties": {
        "allocated": {
          "description": "Summary of all related to this fiscal year budgets allocated",
          "type": "number",
          "readonly": true
        },
        "available": {
          "description": "Summary of all related to this fiscal year budgets available",
          "type": "number",
          "readonly": true
        },
        "unavailable": {
          "description": "Summary of all related to this fiscal year budgets unavailable",
          "type": "number",
          "readonly": true
        },
        "initialAllocation": {
          "description": "Summary of all related to this fiscal year budgets initialAllocation",
          "type": "number",
          "readonly": true
        },
        "allocationTo": {
          "description": "Summary of all related to this fiscal year budgets allocationTo",
          "type": "number",
          "readonly": true
        },
        "allocationFrom": {
          "description": "Summary of all related to this fiscal year budgets allocationFrom",
          "type": "number",
          "readonly": true
        },
        "totalFunding": {
          "description": "Summary of all related to this fiscal year budgets totalFunding",
          "type": "number",
          "readonly": true
        },
        "cashBalance": {
          "description": "Summary of all related to this fiscal year budgets cashBalance",
          "type": "number",
          "readonly": true
        },
        "awaitingPayment": {
          "description": "Summary of all related to this fiscal year budgets awaitingPayment",
          "type": "number",
          "readonly": true
        },
        "encumbered": {
          "description": "Summary of all related to this fiscal year budgets encumbered",
          "type": "number",
          "readonly": true
        },
        "expenditures": {
          "description": "Summary of all related to this ledger budgets expenditures",
          "type": "number",
          "readonly": true
        },
        "overEncumbrance": {
          "description": "Summary of all related to this ledger budgets overEncumbrance",
          "type": "number",
          "readonly": true
        },
        "overExpended": {
          "description": "Summary of all related to this ledger budgets overExpended",
          "type": "number",
          "readonly": true
        }
      },
      "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"
      ]
    }
  },
  "additionalProperties": false,
  "required": [
    "code",
    "name",
    "periodStart",
    "periodEnd"
  ]
}

Example:

{
  "id": "ac2164c7-ba3d-1bc2-a12c-e35ceccbfaf2",
  "name": "Fiscal Year 2020",
  "acqUnitIds": [
    "1895e539-8dac-441e-b1f5-aab62b3fde60",
    "47f504bd-0c1b-498e-a2ae-e2f0a0cea273"
  ],
  "code": "FY2020",
  "description": "January 1 - December 30",
  "periodStart": "2020-01-01T00:00:00Z",
  "periodEnd": "2020-12-30T23:59:59Z",
  "series": "FY",
  "financialSummary": {
    "initialAllocation": 1090230.80,
    "allocationTo": 1090230.80,
    "allocationFrom": 0,
    "allocated": 2180461.6,
    "available": 2180377.6,
    "totalFunding": 2180377.6,
    "cashBalance": 2180377.6,
    "encumbered": 0,
    "awaitingPayment": 0,
    "expenditures": 84,
    "unavailable": 84,
    "overEncumbrance": 0,
    "overExpended": 0
  },
  "metadata": {
    "createdDate": "2019-06-17T14:12:42.497+0000",
    "createdByUserId": "498492aa-f909-42f6-b154-5bf66e6486ba",
    "updatedDate": "2019-08-28T08:37:19.263+0000",
    "updatedByUserId": "7ec56c96-e9f2-4079-9509-86b00f8dacd5"
  }
}

Response 404

Item with a given ID not found

Body

Media type: text/plain

Type: any

Example:

"fiscal-year not found"

Response 422

Validation errors

Body

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"
        }
      ]
    }
  ]
}

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/fiscal-years/{id}

Delete fiscal-year item with given {fiscal-yearId}

DELETE /finance-storage/fiscal-years/{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 fiscal year

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 fiscal-year -- constraint violation"

Response 404

Item with a given ID not found

Body

Media type: text/plain

Type: any

Example:

"fiscal-year not found"

Response 422

Validation errors

Body

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"
        }
      ]
    }
  ]
}

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/fiscal-years/{id}

Update fiscal-year item with given {fiscal-yearId}

PUT /finance-storage/fiscal-years/{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 fiscal year

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 fiscal year record",
  "type": "object",
  "properties": {
    "id": {
      "description": "UUID of the fiscal year record",
      "$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": "UUIDs of the acquisition units associated with this fiscal year",
      "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}$"
      }
    },
    "name": {
      "description": "The name of the fiscal year",
      "type": "string"
    },
    "code": {
      "description": "The code of the fiscal year",
      "type": "string",
      "pattern": "^[a-zA-Z]+[0-9]{4}$"
    },
    "currency": {
      "description": "Currency code which is recorded when the FY ends, otherwise the system currency can be assumed",
      "type": "string"
    },
    "description": {
      "description": "The description of the fiscal year",
      "type": "string"
    },
    "periodStart": {
      "description": "The start date of the fiscal year",
      "type": "string",
      "format": "date-time"
    },
    "periodEnd": {
      "description": "The end date of the fiscal year",
      "type": "string",
      "format": "date-time"
    },
    "series": {
      "description": "The fiscal year series",
      "type": "string"
    },
    "financialSummary": {
      "description": "Includes Funding information and Financial activity",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "type": "object",
      "properties": {
        "allocated": {
          "description": "Summary of all related to this fiscal year budgets allocated",
          "type": "number",
          "readonly": true
        },
        "available": {
          "description": "Summary of all related to this fiscal year budgets available",
          "type": "number",
          "readonly": true
        },
        "unavailable": {
          "description": "Summary of all related to this fiscal year budgets unavailable",
          "type": "number",
          "readonly": true
        },
        "initialAllocation": {
          "description": "Summary of all related to this fiscal year budgets initialAllocation",
          "type": "number",
          "readonly": true
        },
        "allocationTo": {
          "description": "Summary of all related to this fiscal year budgets allocationTo",
          "type": "number",
          "readonly": true
        },
        "allocationFrom": {
          "description": "Summary of all related to this fiscal year budgets allocationFrom",
          "type": "number",
          "readonly": true
        },
        "totalFunding": {
          "description": "Summary of all related to this fiscal year budgets totalFunding",
          "type": "number",
          "readonly": true
        },
        "cashBalance": {
          "description": "Summary of all related to this fiscal year budgets cashBalance",
          "type": "number",
          "readonly": true
        },
        "awaitingPayment": {
          "description": "Summary of all related to this fiscal year budgets awaitingPayment",
          "type": "number",
          "readonly": true
        },
        "encumbered": {
          "description": "Summary of all related to this fiscal year budgets encumbered",
          "type": "number",
          "readonly": true
        },
        "expenditures": {
          "description": "Summary of all related to this ledger budgets expenditures",
          "type": "number",
          "readonly": true
        },
        "overEncumbrance": {
          "description": "Summary of all related to this ledger budgets overEncumbrance",
          "type": "number",
          "readonly": true
        },
        "overExpended": {
          "description": "Summary of all related to this ledger budgets overExpended",
          "type": "number",
          "readonly": true
        }
      },
      "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"
      ]
    }
  },
  "additionalProperties": false,
  "required": [
    "code",
    "name",
    "periodStart",
    "periodEnd"
  ]
}

Example:

{
  "id": "ac2164c7-ba3d-1bc2-a12c-e35ceccbfaf2",
  "name": "Fiscal Year 2020",
  "acqUnitIds": [
    "1895e539-8dac-441e-b1f5-aab62b3fde60",
    "47f504bd-0c1b-498e-a2ae-e2f0a0cea273"
  ],
  "code": "FY2020",
  "description": "January 1 - December 30",
  "periodStart": "2020-01-01T00:00:00Z",
  "periodEnd": "2020-12-30T23:59:59Z",
  "series": "FY",
  "financialSummary": {
    "initialAllocation": 1090230.80,
    "allocationTo": 1090230.80,
    "allocationFrom": 0,
    "allocated": 2180461.6,
    "available": 2180377.6,
    "totalFunding": 2180377.6,
    "cashBalance": 2180377.6,
    "encumbered": 0,
    "awaitingPayment": 0,
    "expenditures": 84,
    "unavailable": 84,
    "overEncumbrance": 0,
    "overExpended": 0
  },
  "metadata": {
    "createdDate": "2019-06-17T14:12:42.497+0000",
    "createdByUserId": "498492aa-f909-42f6-b154-5bf66e6486ba",
    "updatedDate": "2019-08-28T08:37:19.263+0000",
    "updatedByUserId": "7ec56c96-e9f2-4079-9509-86b00f8dacd5"
  }
}

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

Response 404

Item with a given ID not found

Body

Media type: text/plain

Type: any

Example:

"fiscal-year not found"

Response 409

Optimistic locking version conflict

Body

Media type: text/plain

Type: any

Example:

version conflict

Response 422

Validation errors

Body

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"
        }
      ]
    }
  ]
}

Response 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 (v3)

Table of contents

mod-finance-storage (Fiscal Year)

/finance-storage/fiscal-years

GET /finance-storage/fiscal-years

Query Parameters

Response 200

Response 400

Response 401

Response 422

Response 500

POST /finance-storage/fiscal-years

Query Parameters

Response 201

Headers

Response 400

Response 401

Response 422

Response 500

GET /finance-storage/fiscal-years/{id}

URI Parameters

Query Parameters

Response 200

Response 404

Response 422

Response 500

DELETE /finance-storage/fiscal-years/{id}

URI Parameters

Query Parameters

Response 204

Response 400

Response 404

Response 422

Response 500

PUT /finance-storage/fiscal-years/{id}

URI Parameters

Query Parameters

Response 204

Response 400

Response 404

Response 409

Response 422

Response 500