mod-finance-storage (v3)

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

mod-finance-storage (Ledgers)
/finance-storage/ledgers

mod-finance-storage (Ledgers)

CRUD APIs used to manage ledgers.

/finance-storage/ledgers

Collection of ledger items.

GET /finance-storage/ledgers

Get list of ledgers

GET /finance-storage/ledgers

Query Parameters

query: (string)
A query expressed as a CQL string (see dev.folio.org/reference/glossary#cql) using valid searchable fields. The first example below shows the general form of a full CQL query, but those fields might not be relevant in this context.
with valid searchable fields: for example code
Example:
```
(username=="ab*" or personal.firstName=="ab*" or personal.lastName=="ab*") and active=="true" sortby personal.lastName personal.firstName barcode

["code", "MEDGRANT", "="]
```
totalRecords: (string - default: auto - pattern: exact|estimated|none|auto)
How to calculate the totalRecords property. "exact" for the correct number, "estimated" for an estimation, "auto" to automatically select "exact" or "estimated", "none" for suppressing the totalRecords property. For details see https://github.com/folio-org/raml-module-builder#estimated-totalrecords
Example:
```
none
```
offset: (integer - default: 0 - minimum: 0 - maximum: 2147483647)
Skip over a number of elements by specifying an offset value for the query
Example:
```
0
```
limit: (integer - default: 10 - minimum: 0 - maximum: 2147483647)
Limit the number of elements returned in the response
Example:
```
10
```

Response 200

Returns a list of ledger items

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "A collection of ledgers",
  "type": "object",
  "properties": {
    "ledgers": {
      "description": "Collection of ledger records",
      "type": "array",
      "id": "ledgers",
      "items": {
        "type": "object",
        "$schema": "http://json-schema.org/draft-04/schema#",
        "description": "A financial ledger",
        "properties": {
          "id": {
            "description": "UUID of this ledger",
            "$schema": "http://json-schema.org/draft-04/schema#",
            "type": "string",
            "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
          },
          "_version": {
            "type": "integer",
            "description": "Record version for optimistic locking"
          },
          "name": {
            "description": "The name of the ledger",
            "type": "string"
          },
          "code": {
            "description": "The code for the ledger",
            "type": "string"
          },
          "description": {
            "description": "The description of the ledger",
            "type": "string"
          },
          "fiscalYearOneId": {
            "description": "UUID of the first fiscal year associated with this ledger",
            "$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}$"
          },
          "ledgerStatus": {
            "description": "The status of the ledger",
            "type": "string",
            "enum": [
              "Active",
              "Inactive",
              "Frozen"
            ]
          },
          "allocated": {
            "description": "The amount currently allocated to this ledger",
            "type": "number",
            "readonly": true
          },
          "available": {
            "description": "The amount currently available in this ledger",
            "type": "number",
            "readonly": true
          },
          "netTransfers": {
            "description": "Summing all the transfers from/to this ledger. Amount can be negative",
            "type": "number",
            "readonly": true
          },
          "unavailable": {
            "description": "The amount already utilized from the allocated amount",
            "type": "number",
            "readonly": true
          },
          "currency": {
            "description": "The ISO code for currency",
            "type": "string"
          },
          "acqUnitIds": {
            "description": "acquisition unit ids associated with this ledger",
            "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}$"
            }
          },
          "restrictEncumbrance": {
            "description": "If true, imposes restrictions on encumbrances",
            "type": "boolean",
            "default": true
          },
          "restrictExpenditures": {
            "description": "If true, imposes restrictions on payments",
            "type": "boolean",
            "default": true
          },
          "metadata": {
            "type": "object",
            "readonly": true,
            "$schema": "http://json-schema.org/draft-04/schema#",
            "id": "metadata.schema",
            "title": "Metadata Schema",
            "description": "Metadata about creation and changes to records, provided by the server (client should not provide)",
            "properties": {
              "createdDate": {
                "description": "Date and time when the record was created",
                "type": "string",
                "format": "date-time"
              },
              "createdByUserId": {
                "description": "ID of the user who created the record (when available)",
                "type": "string",
                "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
              },
              "createdByUsername": {
                "description": "Username of the user who created the record (when available)",
                "type": "string"
              },
              "updatedDate": {
                "description": "Date and time when the record was last updated",
                "type": "string",
                "format": "date-time"
              },
              "updatedByUserId": {
                "description": "ID of the user who last updated the record (when available)",
                "type": "string",
                "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
              },
              "updatedByUsername": {
                "description": "Username of the user who last updated the record (when available)",
                "type": "string"
              }
            },
            "additionalProperties": false,
            "required": [
              "createdDate"
            ]
          },
          "initialAllocation": {
            "description": "Summary of all related to this ledger budgets initialAllocation",
            "type": "number",
            "readonly": true
          },
          "allocationTo": {
            "description": "Summary of all related to this ledger budgets allocationTo",
            "type": "number",
            "readonly": true
          },
          "allocationFrom": {
            "description": "Summary of all related to this ledger budgets allocationFrom",
            "type": "number",
            "readonly": true
          },
          "totalFunding": {
            "description": "Summary of all related to this ledger budgets totalFunding",
            "type": "number",
            "readonly": true
          },
          "cashBalance": {
            "description": "Summary of all related to this ledger budgets cashBalance",
            "type": "number",
            "readonly": true
          },
          "awaitingPayment": {
            "description": "Summary of all related to this ledger budgets awaitingPayment",
            "type": "number",
            "readonly": true
          },
          "credits": {
            "description": "Summary of all related to this ledger budgets credits",
            "type": "number",
            "readonly": true
          },
          "encumbered": {
            "description": "Summary of all related to this ledger 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,
        "required": [
          "name",
          "code",
          "fiscalYearOneId",
          "ledgerStatus",
          "restrictEncumbrance",
          "restrictExpenditures"
        ]
      }
    },
    "totalRecords": {
      "description": "The number of objects contained in this collection",
      "type": "integer"
    }
  },
  "additionalProperties": false,
  "required": [
    "ledgers",
    "totalRecords"
  ]
}

Example:

{
  "ledgers": [
    {
      "id": "7cef8378-7cbd-1fae-bcdd-8b9d7c0af9de",
      "name": "Main Library",
      "code": "MAIN-LIB",
      "description": "This is the ledger for the Main Library",
      "fiscalYearOneId": "d875618b-7cf5-442f-a823-9814e7bce92a",
      "ledgerStatus": "Active",
      "currency": "USD",
      "restrictEncumbrance": false,
      "restrictExpenditures": false,
      "acqUnitIds": [
         "ac2164c7-ba3d-1bc2-b12c-e35ceccbfaf2"
      ]
     }
  ],
  "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 ledgers -- 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 ledgers -- 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/ledgers

Create a new ledger item.

POST /finance-storage/ledgers

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "A financial ledger",
  "type": "object",
  "properties": {
    "id": {
      "description": "UUID of this ledger",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "type": "string",
      "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
    },
    "_version": {
      "type": "integer",
      "description": "Record version for optimistic locking"
    },
    "name": {
      "description": "The name of the ledger",
      "type": "string"
    },
    "code": {
      "description": "The code for the ledger",
      "type": "string"
    },
    "description": {
      "description": "The description of the ledger",
      "type": "string"
    },
    "fiscalYearOneId": {
      "description": "UUID of the first fiscal year associated with this ledger",
      "$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}$"
    },
    "ledgerStatus": {
      "description": "The status of the ledger",
      "type": "string",
      "enum": [
        "Active",
        "Inactive",
        "Frozen"
      ]
    },
    "allocated": {
      "description": "The amount currently allocated to this ledger",
      "type": "number",
      "readonly": true
    },
    "available": {
      "description": "The amount currently available in this ledger",
      "type": "number",
      "readonly": true
    },
    "netTransfers": {
      "description": "Summing all the transfers from/to this ledger. Amount can be negative",
      "type": "number",
      "readonly": true
    },
    "unavailable": {
      "description": "The amount already utilized from the allocated amount",
      "type": "number",
      "readonly": true
    },
    "currency": {
      "description": "The ISO code for currency",
      "type": "string"
    },
    "acqUnitIds": {
      "description": "acquisition unit ids associated with this ledger",
      "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}$"
      }
    },
    "restrictEncumbrance": {
      "description": "If true, imposes restrictions on encumbrances",
      "type": "boolean",
      "default": true
    },
    "restrictExpenditures": {
      "description": "If true, imposes restrictions on payments",
      "type": "boolean",
      "default": true
    },
    "metadata": {
      "type": "object",
      "readonly": true,
      "$schema": "http://json-schema.org/draft-04/schema#",
      "id": "metadata.schema",
      "title": "Metadata Schema",
      "description": "Metadata about creation and changes to records, provided by the server (client should not provide)",
      "properties": {
        "createdDate": {
          "description": "Date and time when the record was created",
          "type": "string",
          "format": "date-time"
        },
        "createdByUserId": {
          "description": "ID of the user who created the record (when available)",
          "type": "string",
          "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
        },
        "createdByUsername": {
          "description": "Username of the user who created the record (when available)",
          "type": "string"
        },
        "updatedDate": {
          "description": "Date and time when the record was last updated",
          "type": "string",
          "format": "date-time"
        },
        "updatedByUserId": {
          "description": "ID of the user who last updated the record (when available)",
          "type": "string",
          "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
        },
        "updatedByUsername": {
          "description": "Username of the user who last updated the record (when available)",
          "type": "string"
        }
      },
      "additionalProperties": false,
      "required": [
        "createdDate"
      ]
    },
    "initialAllocation": {
      "description": "Summary of all related to this ledger budgets initialAllocation",
      "type": "number",
      "readonly": true
    },
    "allocationTo": {
      "description": "Summary of all related to this ledger budgets allocationTo",
      "type": "number",
      "readonly": true
    },
    "allocationFrom": {
      "description": "Summary of all related to this ledger budgets allocationFrom",
      "type": "number",
      "readonly": true
    },
    "totalFunding": {
      "description": "Summary of all related to this ledger budgets totalFunding",
      "type": "number",
      "readonly": true
    },
    "cashBalance": {
      "description": "Summary of all related to this ledger budgets cashBalance",
      "type": "number",
      "readonly": true
    },
    "awaitingPayment": {
      "description": "Summary of all related to this ledger budgets awaitingPayment",
      "type": "number",
      "readonly": true
    },
    "credits": {
      "description": "Summary of all related to this ledger budgets credits",
      "type": "number",
      "readonly": true
    },
    "encumbered": {
      "description": "Summary of all related to this ledger 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,
  "required": [
    "name",
    "code",
    "fiscalYearOneId",
    "ledgerStatus",
    "restrictEncumbrance",
    "restrictExpenditures"
  ]
}

Example:

{
  "id": "7cef8378-7cbd-1fae-bcdd-8b9d7c0af9de",
  "name": "Main Library",
  "code": "MAIN-LIB",
  "description": "This is the ledger for the Main Library",
  "fiscalYearOneId": "d875618b-7cf5-442f-a823-9814e7bce92a",
  "ledgerStatus": "Active",
  "allocated": 24500,
  "initialAllocation": 11000,
  "allocationTo": 13500,
  "allocationFrom": 0,
  "available": 21990,
  "netTransfers": 2500,
  "unavailable": 10,
  "credits": 1500,
  "expenditures": 10,
  "encumbered": 0,
  "awaitingPayment": 0,
  "overEncumbrance": 0,
  "overExpended": 0,
  "totalFunding": 22000,
  "cashBalance": 21990,
  "currency": "USD",
  "restrictEncumbrance": false,
  "restrictExpenditures": false,
  "acqUnitIds": [
    "ac2164c7-ba3d-1bc2-912c-e35ceccbfaf2"
  ]
}

Response 201

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

Headers

Location: required (string)
URI to the created ledger item

Body

Media type: application/json

Type: any

Example:

{
  "id": "7cef8378-7cbd-1fae-bcdd-8b9d7c0af9de",
  "name": "Main Library",
  "code": "MAIN-LIB",
  "description": "This is the ledger for the Main Library",
  "fiscalYearOneId": "d875618b-7cf5-442f-a823-9814e7bce92a",
  "ledgerStatus": "Active",
  "allocated": 24500,
  "initialAllocation": 11000,
  "allocationTo": 13500,
  "allocationFrom": 0,
  "available": 21990,
  "netTransfers": 2500,
  "unavailable": 10,
  "credits": 1500,
  "expenditures": 10,
  "encumbered": 0,
  "awaitingPayment": 0,
  "overEncumbrance": 0,
  "overExpended": 0,
  "totalFunding": 22000,
  "cashBalance": 21990,
  "currency": "USD",
  "restrictEncumbrance": false,
  "restrictExpenditures": false,
  "acqUnitIds": [
    "ac2164c7-ba3d-1bc2-912c-e35ceccbfaf2"
  ]
}

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

Response 401

Not authorized to perform requested action

Body

Media type: text/plain

Type: any

Example:

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

Retrieve ledger item with given {ledgerId}

GET /finance-storage/ledgers/{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 ledger

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 financial ledger",
  "type": "object",
  "properties": {
    "id": {
      "description": "UUID of this ledger",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "type": "string",
      "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
    },
    "_version": {
      "type": "integer",
      "description": "Record version for optimistic locking"
    },
    "name": {
      "description": "The name of the ledger",
      "type": "string"
    },
    "code": {
      "description": "The code for the ledger",
      "type": "string"
    },
    "description": {
      "description": "The description of the ledger",
      "type": "string"
    },
    "fiscalYearOneId": {
      "description": "UUID of the first fiscal year associated with this ledger",
      "$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}$"
    },
    "ledgerStatus": {
      "description": "The status of the ledger",
      "type": "string",
      "enum": [
        "Active",
        "Inactive",
        "Frozen"
      ]
    },
    "allocated": {
      "description": "The amount currently allocated to this ledger",
      "type": "number",
      "readonly": true
    },
    "available": {
      "description": "The amount currently available in this ledger",
      "type": "number",
      "readonly": true
    },
    "netTransfers": {
      "description": "Summing all the transfers from/to this ledger. Amount can be negative",
      "type": "number",
      "readonly": true
    },
    "unavailable": {
      "description": "The amount already utilized from the allocated amount",
      "type": "number",
      "readonly": true
    },
    "currency": {
      "description": "The ISO code for currency",
      "type": "string"
    },
    "acqUnitIds": {
      "description": "acquisition unit ids associated with this ledger",
      "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}$"
      }
    },
    "restrictEncumbrance": {
      "description": "If true, imposes restrictions on encumbrances",
      "type": "boolean",
      "default": true
    },
    "restrictExpenditures": {
      "description": "If true, imposes restrictions on payments",
      "type": "boolean",
      "default": true
    },
    "metadata": {
      "type": "object",
      "readonly": true,
      "$schema": "http://json-schema.org/draft-04/schema#",
      "id": "metadata.schema",
      "title": "Metadata Schema",
      "description": "Metadata about creation and changes to records, provided by the server (client should not provide)",
      "properties": {
        "createdDate": {
          "description": "Date and time when the record was created",
          "type": "string",
          "format": "date-time"
        },
        "createdByUserId": {
          "description": "ID of the user who created the record (when available)",
          "type": "string",
          "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
        },
        "createdByUsername": {
          "description": "Username of the user who created the record (when available)",
          "type": "string"
        },
        "updatedDate": {
          "description": "Date and time when the record was last updated",
          "type": "string",
          "format": "date-time"
        },
        "updatedByUserId": {
          "description": "ID of the user who last updated the record (when available)",
          "type": "string",
          "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
        },
        "updatedByUsername": {
          "description": "Username of the user who last updated the record (when available)",
          "type": "string"
        }
      },
      "additionalProperties": false,
      "required": [
        "createdDate"
      ]
    },
    "initialAllocation": {
      "description": "Summary of all related to this ledger budgets initialAllocation",
      "type": "number",
      "readonly": true
    },
    "allocationTo": {
      "description": "Summary of all related to this ledger budgets allocationTo",
      "type": "number",
      "readonly": true
    },
    "allocationFrom": {
      "description": "Summary of all related to this ledger budgets allocationFrom",
      "type": "number",
      "readonly": true
    },
    "totalFunding": {
      "description": "Summary of all related to this ledger budgets totalFunding",
      "type": "number",
      "readonly": true
    },
    "cashBalance": {
      "description": "Summary of all related to this ledger budgets cashBalance",
      "type": "number",
      "readonly": true
    },
    "awaitingPayment": {
      "description": "Summary of all related to this ledger budgets awaitingPayment",
      "type": "number",
      "readonly": true
    },
    "credits": {
      "description": "Summary of all related to this ledger budgets credits",
      "type": "number",
      "readonly": true
    },
    "encumbered": {
      "description": "Summary of all related to this ledger 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,
  "required": [
    "name",
    "code",
    "fiscalYearOneId",
    "ledgerStatus",
    "restrictEncumbrance",
    "restrictExpenditures"
  ]
}

Example:

{
  "id": "7cef8378-7cbd-1fae-bcdd-8b9d7c0af9de",
  "name": "Main Library",
  "code": "MAIN-LIB",
  "description": "This is the ledger for the Main Library",
  "fiscalYearOneId": "d875618b-7cf5-442f-a823-9814e7bce92a",
  "ledgerStatus": "Active",
  "allocated": 24500,
  "initialAllocation": 11000,
  "allocationTo": 13500,
  "allocationFrom": 0,
  "available": 21990,
  "netTransfers": 2500,
  "unavailable": 10,
  "credits": 1500,
  "expenditures": 10,
  "encumbered": 0,
  "awaitingPayment": 0,
  "overEncumbrance": 0,
  "overExpended": 0,
  "totalFunding": 22000,
  "cashBalance": 21990,
  "currency": "USD",
  "restrictEncumbrance": false,
  "restrictExpenditures": false,
  "acqUnitIds": [
    "ac2164c7-ba3d-1bc2-912c-e35ceccbfaf2"
  ]
}

Response 404

Item with a given ID not found

Body

Media type: text/plain

Type: any

Example:

"ledger 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/ledgers/{id}

Delete ledger item with given {ledgerId}

DELETE /finance-storage/ledgers/{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 ledger

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

Response 404

Item with a given ID not found

Body

Media type: text/plain

Type: any

Example:

"ledger 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/ledgers/{id}

Update ledger item with given {ledgerId}

PUT /finance-storage/ledgers/{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 ledger

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "A financial ledger",
  "type": "object",
  "properties": {
    "id": {
      "description": "UUID of this ledger",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "type": "string",
      "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
    },
    "_version": {
      "type": "integer",
      "description": "Record version for optimistic locking"
    },
    "name": {
      "description": "The name of the ledger",
      "type": "string"
    },
    "code": {
      "description": "The code for the ledger",
      "type": "string"
    },
    "description": {
      "description": "The description of the ledger",
      "type": "string"
    },
    "fiscalYearOneId": {
      "description": "UUID of the first fiscal year associated with this ledger",
      "$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}$"
    },
    "ledgerStatus": {
      "description": "The status of the ledger",
      "type": "string",
      "enum": [
        "Active",
        "Inactive",
        "Frozen"
      ]
    },
    "allocated": {
      "description": "The amount currently allocated to this ledger",
      "type": "number",
      "readonly": true
    },
    "available": {
      "description": "The amount currently available in this ledger",
      "type": "number",
      "readonly": true
    },
    "netTransfers": {
      "description": "Summing all the transfers from/to this ledger. Amount can be negative",
      "type": "number",
      "readonly": true
    },
    "unavailable": {
      "description": "The amount already utilized from the allocated amount",
      "type": "number",
      "readonly": true
    },
    "currency": {
      "description": "The ISO code for currency",
      "type": "string"
    },
    "acqUnitIds": {
      "description": "acquisition unit ids associated with this ledger",
      "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}$"
      }
    },
    "restrictEncumbrance": {
      "description": "If true, imposes restrictions on encumbrances",
      "type": "boolean",
      "default": true
    },
    "restrictExpenditures": {
      "description": "If true, imposes restrictions on payments",
      "type": "boolean",
      "default": true
    },
    "metadata": {
      "type": "object",
      "readonly": true,
      "$schema": "http://json-schema.org/draft-04/schema#",
      "id": "metadata.schema",
      "title": "Metadata Schema",
      "description": "Metadata about creation and changes to records, provided by the server (client should not provide)",
      "properties": {
        "createdDate": {
          "description": "Date and time when the record was created",
          "type": "string",
          "format": "date-time"
        },
        "createdByUserId": {
          "description": "ID of the user who created the record (when available)",
          "type": "string",
          "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
        },
        "createdByUsername": {
          "description": "Username of the user who created the record (when available)",
          "type": "string"
        },
        "updatedDate": {
          "description": "Date and time when the record was last updated",
          "type": "string",
          "format": "date-time"
        },
        "updatedByUserId": {
          "description": "ID of the user who last updated the record (when available)",
          "type": "string",
          "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
        },
        "updatedByUsername": {
          "description": "Username of the user who last updated the record (when available)",
          "type": "string"
        }
      },
      "additionalProperties": false,
      "required": [
        "createdDate"
      ]
    },
    "initialAllocation": {
      "description": "Summary of all related to this ledger budgets initialAllocation",
      "type": "number",
      "readonly": true
    },
    "allocationTo": {
      "description": "Summary of all related to this ledger budgets allocationTo",
      "type": "number",
      "readonly": true
    },
    "allocationFrom": {
      "description": "Summary of all related to this ledger budgets allocationFrom",
      "type": "number",
      "readonly": true
    },
    "totalFunding": {
      "description": "Summary of all related to this ledger budgets totalFunding",
      "type": "number",
      "readonly": true
    },
    "cashBalance": {
      "description": "Summary of all related to this ledger budgets cashBalance",
      "type": "number",
      "readonly": true
    },
    "awaitingPayment": {
      "description": "Summary of all related to this ledger budgets awaitingPayment",
      "type": "number",
      "readonly": true
    },
    "credits": {
      "description": "Summary of all related to this ledger budgets credits",
      "type": "number",
      "readonly": true
    },
    "encumbered": {
      "description": "Summary of all related to this ledger 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,
  "required": [
    "name",
    "code",
    "fiscalYearOneId",
    "ledgerStatus",
    "restrictEncumbrance",
    "restrictExpenditures"
  ]
}

Example:

{
  "id": "7cef8378-7cbd-1fae-bcdd-8b9d7c0af9de",
  "name": "Main Library",
  "code": "MAIN-LIB",
  "description": "This is the ledger for the Main Library",
  "fiscalYearOneId": "d875618b-7cf5-442f-a823-9814e7bce92a",
  "ledgerStatus": "Active",
  "allocated": 24500,
  "initialAllocation": 11000,
  "allocationTo": 13500,
  "allocationFrom": 0,
  "available": 21990,
  "netTransfers": 2500,
  "unavailable": 10,
  "credits": 1500,
  "expenditures": 10,
  "encumbered": 0,
  "awaitingPayment": 0,
  "overEncumbrance": 0,
  "overExpended": 0,
  "totalFunding": 22000,
  "cashBalance": 21990,
  "currency": "USD",
  "restrictEncumbrance": false,
  "restrictExpenditures": false,
  "acqUnitIds": [
    "ac2164c7-ba3d-1bc2-912c-e35ceccbfaf2"
  ]
}

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

Response 404

Item with a given ID not found

Body

Media type: text/plain

Type: any

Example:

"ledger 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 (Ledgers)

/finance-storage/ledgers

GET /finance-storage/ledgers

Query Parameters

Response 200

Response 400

Response 401

Response 422

Response 500

POST /finance-storage/ledgers

Response 201

Headers

Response 400

Response 401

Response 422

Response 500

GET /finance-storage/ledgers/{id}

URI Parameters

Response 200

Response 404

Response 422

Response 500

DELETE /finance-storage/ledgers/{id}

URI Parameters

Response 204

Response 400

Response 404

Response 422

Response 500

PUT /finance-storage/ledgers/{id}

URI Parameters

Response 204

Response 400

Response 404

Response 409

Response 422

Response 500