Rollover error report business API version v1.0
http://github.com/folio-org/mod-finanace
Rollover errors business API
API is used to manage rollover errors.
/finance/ledger-rollovers-errors
Collection of ledger-rollovers-error items.
get
Get list of rollovers errors
post
Create a new ledger-rollovers-error item.
get /finance/ledger-rollovers-errors
Get list of rollovers errors
Headers
- Accept: required(string)
either text/csv or application/json
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. Using limit=0 will return totalRecords with the exact value. For details about totalRecords see https://github.com/folio-org/raml-module-builder#estimated-totalrecords
Example:
10
HTTP status code 200
Return rollover errors in specified format
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "A collection of ledger fiscal year rollover errors",
"type": "object",
"properties": {
"ledgerFiscalYearRolloverErrors": {
"description": "The list of fiscal year rollover errors",
"type": "array",
"items": {
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Ledger fiscal year rollover error",
"type": "object",
"properties": {
"id": {
"description": "Id of ledger fiscal year rollover progress",
"$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}$"
},
"ledgerRolloverId": {
"description": "Ledger fiscal year rollover UUID",
"$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}$"
},
"errorType": {
"description": "Type of rollover error",
"type": "string",
"enum": [
"Fund",
"Order",
"Order rollover",
"Financial rollover",
"Other"
]
},
"failedAction": {
"description": "An action that failed during rollover",
"type": "string"
},
"errorMessage": {
"description": "Rollover error message",
"type": "string"
},
"details": {
"description": "Additional details about the rollover error",
"existingJavaType": "java.util.Map<String, Object>",
"type": "object"
},
"metadata": {
"readonly": true,
"type": "object",
"$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": [
"errorType",
"errorMessage",
"failedAction",
"ledgerRolloverId"
]
}
},
"totalRecords": {
"description": "The number of records contained in this collection",
"type": "integer",
"minimum": 0
}
},
"additionalProperties": false,
"required": [
"ledgerFiscalYearRolloverErrors",
"totalRecords"
]
}Example:
{
"ledgerFiscalYearRolloverErrors": [
{
"id": "33d89850-4670-4d0a-b56f-d594c8ba0589",
"ledgerRolloverId": "e7ed4439-a5ea-4976-b7e6-264e495fbfe8",
"errorType": "Order",
"failedAction": "Create Encumbrance",
"errorMessage": "Not enough money available in the Fund to create encumbrance",
"details": {
"purchaseOrderId": "5f94d848-83d9-4a23-8dd7-fa94f2d769eb",
"poLineId": "9bf4cebd-04ad-4af7-bc18-eca28ac6ba5a",
"polNumber": "10000-1",
"amount": 1346.11,
"fundId": "ef1f3200-2bd3-4184-914f-a9b9f247b4fb",
"fundCode": "HIST"
},
"metadata": {
"createdDate": "2020-07-19T10:00:00.000+0000",
"createdByUserId": "28d1057c-d137-11e8-a8d5-f2801f1b9fd1"
}
}
],
"totalRecords": 1
}
HTTP status code 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 ledger-rollovers-errors -- malformed parameter 'query', syntax error at column 6HTTP status code 401
Not authorized to perform requested action
Body
Media type: text/plain
Type: any
Example:
unable to list ledger-rollovers-errors -- unauthorizedHTTP status code 415
Unsupported Media Type: text/csv
HTTP status code 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"
}
]
}
]
}
HTTP status code 500
Internal server error, e.g. due to misconfiguration
Body
Media type: text/plain
Type: any
Example:
internal server error, contact administratorpost /finance/ledger-rollovers-errors
Create a new ledger-rollovers-error item.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"description": "Ledger fiscal year rollover error",
"type": "object",
"properties": {
"id": {
"description": "Id of ledger fiscal year rollover progress",
"$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}$"
},
"ledgerRolloverId": {
"description": "Ledger fiscal year rollover UUID",
"$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}$"
},
"errorType": {
"description": "Type of rollover error",
"type": "string",
"enum": [
"Fund",
"Order",
"Order rollover",
"Financial rollover",
"Other"
]
},
"failedAction": {
"description": "An action that failed during rollover",
"type": "string"
},
"errorMessage": {
"description": "Rollover error message",
"type": "string"
},
"details": {
"description": "Additional details about the rollover error",
"existingJavaType": "java.util.Map<String, Object>",
"type": "object"
},
"metadata": {
"readonly": true,
"type": "object",
"$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": [
"errorType",
"errorMessage",
"failedAction",
"ledgerRolloverId"
]
}Example:
{
"id": "33d89850-4670-4d0a-b56f-d594c8ba0589",
"ledgerRolloverId": "e7ed4439-a5ea-4976-b7e6-264e495fbfe8",
"errorType": "Order",
"failedAction": "Create Encumbrance",
"errorMessage": "Not enough money available in the Fund to create encumbrance",
"details": {
"purchaseOrderId": "5f94d848-83d9-4a23-8dd7-fa94f2d769eb",
"poLineId": "9bf4cebd-04ad-4af7-bc18-eca28ac6ba5a",
"polNumber": "10000-1",
"amount": 1346.11,
"fundId": "ef1f3200-2bd3-4184-914f-a9b9f247b4fb",
"fundCode": "HIST"
},
"metadata": {
"createdDate": "2020-07-19T10:00:00.000+0000",
"createdByUserId": "28d1057c-d137-11e8-a8d5-f2801f1b9fd1"
}
}
HTTP status code 201
Returns a newly created item, with server-controlled fields like 'id' populated
Headers
- Location: required(string)
URI to the created ledger-rollovers-error item
Body
Media type: application/json
Type: any
Example:
{
"id": "33d89850-4670-4d0a-b56f-d594c8ba0589",
"ledgerRolloverId": "e7ed4439-a5ea-4976-b7e6-264e495fbfe8",
"errorType": "Order",
"failedAction": "Create Encumbrance",
"errorMessage": "Not enough money available in the Fund to create encumbrance",
"details": {
"purchaseOrderId": "5f94d848-83d9-4a23-8dd7-fa94f2d769eb",
"poLineId": "9bf4cebd-04ad-4af7-bc18-eca28ac6ba5a",
"polNumber": "10000-1",
"amount": 1346.11,
"fundId": "ef1f3200-2bd3-4184-914f-a9b9f247b4fb",
"fundCode": "HIST"
},
"metadata": {
"createdDate": "2020-07-19T10:00:00.000+0000",
"createdByUserId": "28d1057c-d137-11e8-a8d5-f2801f1b9fd1"
}
}
HTTP status code 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-rollovers-error -- malformed JSON at 13:3"
HTTP status code 401
Not authorized to perform requested action
Body
Media type: text/plain
Type: any
Example:
unable to create ledger-rollovers-errors -- unauthorizedHTTP status code 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"
}
]
}
]
}
HTTP status code 500
Internal server error, e.g. due to misconfiguration
Body
Media type: text/plain
Type: any
Example:
Internal server error, contact administratordelete
Delete a ledger rollover error
delete /finance/ledger-rollovers-errors/{id}
Delete a ledger rollover error
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 rollover errors record
HTTP status code 204
Item deleted successfully
HTTP status code 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 rollover error -- constraint violationHTTP status code 404
Item with a given ID not found
Body
Media type: text/plain
Type: any
Example:
ledger rollover error not foundHTTP status code 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"
}
]
}
]
}
HTTP status code 500
Internal server error, e.g. due to misconfiguration
Body
Media type: text/plain
Type: any
Example:
Internal server error, contact administrator