mod-finance (v1)

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

mod-finance (Ledger Rollover Progress)
/finance/ledger-rollovers-progress

mod-finance (Ledger Rollover Progress)

APIs used to manage ledger rollover progress.

/finance/ledger-rollovers-progress

Collection of ledger-rollovers-progress items.

GET /finance/ledger-rollovers-progress

Get list of rollovers progresses

GET /finance/ledger-rollovers-progress

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
```

Response 200

Returns a list of ledger-rollovers-progress items

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "A collection of ledger fiscal year rollovers progress",
  "type": "object",
  "properties": {
    "ledgerFiscalYearRolloverProgresses": {
      "description": "The list of ledger fiscal year rollovers progress",
      "type": "array",
      "items": {
        "$schema": "http://json-schema.org/draft-04/schema#",
        "description": "Ledger fiscal year rollover progress",
        "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}$"
          },
          "overallRolloverStatus": {
            "description": "Progress of the rollover process : Not Started, In Progress, Error, Success",
            "type": "object",
            "$schema": "http://json-schema.org/draft-04/schema#",
            "javaType": "org.folio.rest.jaxrs.model.RolloverStatus",
            "enum": [
              "Not Started",
              "In Progress",
              "Error",
              "Success"
            ],
            "default": "Not Started"
          },
          "budgetsClosingRolloverStatus": {
            "description": "Progress of budgets closing rollover process : Not Started, In Progress, Error, Success",
            "type": "object",
            "$schema": "http://json-schema.org/draft-04/schema#",
            "javaType": "org.folio.rest.jaxrs.model.RolloverStatus",
            "enum": [
              "Not Started",
              "In Progress",
              "Error",
              "Success"
            ],
            "default": "Not Started"
          },
          "financialRolloverStatus": {
            "description": "Progress of new budgets and encumbrance creation rollover process : Not Started, In Progress, Error, Success",
            "type": "object",
            "$schema": "http://json-schema.org/draft-04/schema#",
            "javaType": "org.folio.rest.jaxrs.model.RolloverStatus",
            "enum": [
              "Not Started",
              "In Progress",
              "Error",
              "Success"
            ],
            "default": "Not Started"
          },
          "ordersRolloverStatus": {
            "description": "Progress of orders rollover process : Not Started, In Progress, Error, Success",
            "type": "object",
            "$schema": "http://json-schema.org/draft-04/schema#",
            "javaType": "org.folio.rest.jaxrs.model.RolloverStatus",
            "enum": [
              "Not Started",
              "In Progress",
              "Error",
              "Success"
            ],
            "default": "Not Started"
          },
          "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": [
          "ledgerRolloverId"
        ]
      }
    },
    "totalRecords": {
      "description": "The number of records contained in this collection",
      "type": "integer",
      "minimum": 0
    }
  },
  "additionalProperties": false,
  "required": [
    "ledgerFiscalYearRolloverProgresses",
    "totalRecords"
  ]
}

Example:

{
  "ledgerFiscalYearRolloverProgresses": [
    {
      "id": "e7ed4439-a5ea-4976-b7e6-264e495fbfe8",
      "ledgerRolloverId": "e7ed4439-a5ea-4976-b7e6-264e495fbfe8",
      "overallRolloverStatus": "In Progress",
      "budgetsClosingRolloverStatus": "Success",
      "financialRolloverStatus": "In Progress",
      "ordersRolloverStatus": "Not Started",
      "metadata": {
        "createdDate": "2020-12-03T20:53:43.984+0000",
        "createdByUserId": "28d0fb04-d137-11e8-a8d5-f2801f1b9fd1",
        "updatedDate": "2020-12-03T20:53:43.984+0000",
        "updatedByUserId": "28d0fb04-d137-11e8-a8d5-f2801f1b9fd1"
      }
    }
  ],
  "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 ledger-rollovers-progress -- 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 ledger-rollovers-progress -- 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/ledger-rollovers-progress

Create a new ledger-rollovers-progress item.

POST /finance/ledger-rollovers-progress

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "Ledger fiscal year rollover progress",
  "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}$"
    },
    "overallRolloverStatus": {
      "description": "Progress of the rollover process : Not Started, In Progress, Error, Success",
      "type": "object",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "javaType": "org.folio.rest.jaxrs.model.RolloverStatus",
      "enum": [
        "Not Started",
        "In Progress",
        "Error",
        "Success"
      ],
      "default": "Not Started"
    },
    "budgetsClosingRolloverStatus": {
      "description": "Progress of budgets closing rollover process : Not Started, In Progress, Error, Success",
      "type": "object",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "javaType": "org.folio.rest.jaxrs.model.RolloverStatus",
      "enum": [
        "Not Started",
        "In Progress",
        "Error",
        "Success"
      ],
      "default": "Not Started"
    },
    "financialRolloverStatus": {
      "description": "Progress of new budgets and encumbrance creation rollover process : Not Started, In Progress, Error, Success",
      "type": "object",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "javaType": "org.folio.rest.jaxrs.model.RolloverStatus",
      "enum": [
        "Not Started",
        "In Progress",
        "Error",
        "Success"
      ],
      "default": "Not Started"
    },
    "ordersRolloverStatus": {
      "description": "Progress of orders rollover process : Not Started, In Progress, Error, Success",
      "type": "object",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "javaType": "org.folio.rest.jaxrs.model.RolloverStatus",
      "enum": [
        "Not Started",
        "In Progress",
        "Error",
        "Success"
      ],
      "default": "Not Started"
    },
    "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": [
    "ledgerRolloverId"
  ]
}

Example:

{
  "id": "e7ed4439-a5ea-4976-b7e6-264e495fbfe8",
  "ledgerRolloverId": "e7ed4439-a5ea-4976-b7e6-264e495fbfe8",
  "overallRolloverStatus": "In Progress",
  "budgetsClosingRolloverStatus": "Success",
  "financialRolloverStatus": "In Progress",
  "ordersRolloverStatus": "Not Started",
  "metadata": {
    "createdDate": "2020-12-03T20:53:43.984+0000",
    "createdByUserId": "28d0fb04-d137-11e8-a8d5-f2801f1b9fd1",
    "updatedDate": "2020-12-03T20:53:43.984+0000",
    "updatedByUserId": "28d0fb04-d137-11e8-a8d5-f2801f1b9fd1"
  }
}

Response 201

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

Headers

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

Body

Media type: application/json

Type: any

Example:

{
  "id": "e7ed4439-a5ea-4976-b7e6-264e495fbfe8",
  "ledgerRolloverId": "e7ed4439-a5ea-4976-b7e6-264e495fbfe8",
  "overallRolloverStatus": "In Progress",
  "budgetsClosingRolloverStatus": "Success",
  "financialRolloverStatus": "In Progress",
  "ordersRolloverStatus": "Not Started",
  "metadata": {
    "createdDate": "2020-12-03T20:53:43.984+0000",
    "createdByUserId": "28d0fb04-d137-11e8-a8d5-f2801f1b9fd1",
    "updatedDate": "2020-12-03T20:53:43.984+0000",
    "updatedByUserId": "28d0fb04-d137-11e8-a8d5-f2801f1b9fd1"
  }
}

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

Response 401

Not authorized to perform requested action

Body

Media type: text/plain

Type: any

Example:

unable to create ledger-rollovers-progress -- 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

PUT /finance/ledger-rollovers-progress/{id}

PUT /finance/ledger-rollovers-progress/{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 rollover progress record

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "Ledger fiscal year rollover progress",
  "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}$"
    },
    "overallRolloverStatus": {
      "description": "Progress of the rollover process : Not Started, In Progress, Error, Success",
      "type": "object",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "javaType": "org.folio.rest.jaxrs.model.RolloverStatus",
      "enum": [
        "Not Started",
        "In Progress",
        "Error",
        "Success"
      ],
      "default": "Not Started"
    },
    "budgetsClosingRolloverStatus": {
      "description": "Progress of budgets closing rollover process : Not Started, In Progress, Error, Success",
      "type": "object",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "javaType": "org.folio.rest.jaxrs.model.RolloverStatus",
      "enum": [
        "Not Started",
        "In Progress",
        "Error",
        "Success"
      ],
      "default": "Not Started"
    },
    "financialRolloverStatus": {
      "description": "Progress of new budgets and encumbrance creation rollover process : Not Started, In Progress, Error, Success",
      "type": "object",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "javaType": "org.folio.rest.jaxrs.model.RolloverStatus",
      "enum": [
        "Not Started",
        "In Progress",
        "Error",
        "Success"
      ],
      "default": "Not Started"
    },
    "ordersRolloverStatus": {
      "description": "Progress of orders rollover process : Not Started, In Progress, Error, Success",
      "type": "object",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "javaType": "org.folio.rest.jaxrs.model.RolloverStatus",
      "enum": [
        "Not Started",
        "In Progress",
        "Error",
        "Success"
      ],
      "default": "Not Started"
    },
    "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": [
    "ledgerRolloverId"
  ]
}

Example:

{
  "id": "e7ed4439-a5ea-4976-b7e6-264e495fbfe8",
  "ledgerRolloverId": "e7ed4439-a5ea-4976-b7e6-264e495fbfe8",
  "overallRolloverStatus": "In Progress",
  "budgetsClosingRolloverStatus": "Success",
  "financialRolloverStatus": "In Progress",
  "ordersRolloverStatus": "Not Started",
  "metadata": {
    "createdDate": "2020-12-03T20:53:43.984+0000",
    "createdByUserId": "28d0fb04-d137-11e8-a8d5-f2801f1b9fd1",
    "updatedDate": "2020-12-03T20:53:43.984+0000",
    "updatedByUserId": "28d0fb04-d137-11e8-a8d5-f2801f1b9fd1"
  }
}

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: application/json

Type: any

Example:

{
  "errors": [
    {
      "message": "may not be null",
      "type": "1",
      "code": "-1",
      "parameters": [
        {
          "key": "moduleTo",
          "value": "null"
        }
      ]
    }
  ]
}

Response 404

Item with a given ID not found

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "message": "may not be null",
      "type": "1",
      "code": "-1",
      "parameters": [
        {
          "key": "moduleTo",
          "value": "null"
        }
      ]
    }
  ]
}

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: application/json

Type: any

Example:

{
  "errors": [
    {
      "message": "may not be null",
      "type": "1",
      "code": "-1",
      "parameters": [
        {
          "key": "moduleTo",
          "value": "null"
        }
      ]
    }
  ]
}

GET /finance/ledger-rollovers-progress/{id}

Retrieve ledger-rollovers-progress item with given {ledger-rollovers-progressId}

GET /finance/ledger-rollovers-progress/{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 rollover progress record

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": "Ledger fiscal year rollover progress",
  "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}$"
    },
    "overallRolloverStatus": {
      "description": "Progress of the rollover process : Not Started, In Progress, Error, Success",
      "type": "object",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "javaType": "org.folio.rest.jaxrs.model.RolloverStatus",
      "enum": [
        "Not Started",
        "In Progress",
        "Error",
        "Success"
      ],
      "default": "Not Started"
    },
    "budgetsClosingRolloverStatus": {
      "description": "Progress of budgets closing rollover process : Not Started, In Progress, Error, Success",
      "type": "object",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "javaType": "org.folio.rest.jaxrs.model.RolloverStatus",
      "enum": [
        "Not Started",
        "In Progress",
        "Error",
        "Success"
      ],
      "default": "Not Started"
    },
    "financialRolloverStatus": {
      "description": "Progress of new budgets and encumbrance creation rollover process : Not Started, In Progress, Error, Success",
      "type": "object",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "javaType": "org.folio.rest.jaxrs.model.RolloverStatus",
      "enum": [
        "Not Started",
        "In Progress",
        "Error",
        "Success"
      ],
      "default": "Not Started"
    },
    "ordersRolloverStatus": {
      "description": "Progress of orders rollover process : Not Started, In Progress, Error, Success",
      "type": "object",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "javaType": "org.folio.rest.jaxrs.model.RolloverStatus",
      "enum": [
        "Not Started",
        "In Progress",
        "Error",
        "Success"
      ],
      "default": "Not Started"
    },
    "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": [
    "ledgerRolloverId"
  ]
}

Example:

{
  "id": "e7ed4439-a5ea-4976-b7e6-264e495fbfe8",
  "ledgerRolloverId": "e7ed4439-a5ea-4976-b7e6-264e495fbfe8",
  "overallRolloverStatus": "In Progress",
  "budgetsClosingRolloverStatus": "Success",
  "financialRolloverStatus": "In Progress",
  "ordersRolloverStatus": "Not Started",
  "metadata": {
    "createdDate": "2020-12-03T20:53:43.984+0000",
    "createdByUserId": "28d0fb04-d137-11e8-a8d5-f2801f1b9fd1",
    "updatedDate": "2020-12-03T20:53:43.984+0000",
    "updatedByUserId": "28d0fb04-d137-11e8-a8d5-f2801f1b9fd1"
  }
}

Response 401

Not authorized to perform requested action

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "message": "may not be null",
      "type": "1",
      "code": "-1",
      "parameters": [
        {
          "key": "moduleTo",
          "value": "null"
        }
      ]
    }
  ]
}

Media type: text/plain

Type: any

Example:

unable to get retrieve ledger-rollovers-progress -- unauthorized

Response 404

Item with a given ID not found

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "message": "may not be null",
      "type": "1",
      "code": "-1",
      "parameters": [
        {
          "key": "moduleTo",
          "value": "null"
        }
      ]
    }
  ]
}

Media type: text/plain

Type: any

Example:

"ledger-rollovers-progress 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: application/json

Type: any

Example:

{
  "errors": [
    {
      "message": "may not be null",
      "type": "1",
      "code": "-1",
      "parameters": [
        {
          "key": "moduleTo",
          "value": "null"
        }
      ]
    }
  ]
}

Media type: text/plain

Type: any

Example:

internal server error, contact administrator

mod-finance (v1)

Table of contents

mod-finance (Ledger Rollover Progress)

/finance/ledger-rollovers-progress

GET /finance/ledger-rollovers-progress

Query Parameters

Response 200

Response 400

Response 401

Response 422

Response 500

POST /finance/ledger-rollovers-progress

Response 201

Headers

Response 400

Response 401

Response 422

Response 500

PUT /finance/ledger-rollovers-progress/{id}

URI Parameters

Response 204

Response 400

Response 404

Response 422

Response 500

GET /finance/ledger-rollovers-progress/{id}

URI Parameters

Response 200

Response 401

Response 404

Response 422

Response 500