mod-funds (v1)

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

Table of contents

mod-funds (Ledgers)

CRUD APIs used to manage ledgers.

/ledger

Collection of ledger items.

GET /ledger

Get list of ledgers

GET /ledger
Query Parameters
  • query: (string)

    A query expressed as a CQL string (see dev.folio.org/reference/glossary#cql) using valid searchable fields. The first example below shows the general form of a full CQL query, but those fields might not be relevant in this context.

    with valid searchable fields: for example code

    Example:

    (username=="ab*" or personal.firstName=="ab*" or personal.lastName=="ab*") and active=="true" sortby personal.lastName personal.firstName barcode
    
    ["code", "MEDGRANT", "="]
    
  • offset: (integer - default: 0 - minimum: 0 - maximum: 2147483647)

    Skip over a number of elements by specifying an offset value for the query

    Example:

    0
  • limit: (integer - default: 10 - minimum: 0 - maximum: 2147483647)

    Limit the number of elements returned in the response

    Example:

    10
  • lang: (string - default: en - pattern: [a-zA-Z]{2})

    Requested language. Optional. [lang=en]

Response 200

Returns a list of 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": "The list of objects contained in this collection",
      "type": "array",
      "id": "ledgers",
      "items": {
        "type": "object",
        "$ref": "ledger.json"
      }
    },
    "total_records": {
      "description": "The number of objects contained in this collection",
      "type": "integer"
    },
    "first": {
      "description": "The index of the first object in the collection",
      "type": "integer"
    },
    "last": {
      "description": "The index of the last object in the collection",
      "type": "integer"
    }
  },
  "additionalProperties": false,
  "required": [
    "ledgers",
    "total_records"
  ]
}

Example:

{
  "ledgers": [
    {
      "id": "7cef8378-7CBd-BFaE-BCdd-8b9d7c0af9De",
      "name": "Main Library",
      "code": "MAIN-LIB",
      "description": "This is the ledger for the Main Library",
      "period_start": "2017-07-01T00:00:00Z",
      "period_end": "2017-06-30T23:59:59Z",
      "fiscal_years": [
        "AC2164c7-Ba3d-AbC2-C12C-e35CeCcbfaF2"
      ]
    }

  ],
  "total_records": 1,
  "first": 1,
  "last": 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 -- 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 -- unauthorized

Response 500

Internal server error, e.g. due to misconfiguration

Body

Media type: text/plain

Type: any

Example:

internal server error, contact administrator

POST /ledger

Create a new ledger item.

POST /ledger
Query Parameters
  • lang: (string - default: en - pattern: [a-zA-Z]{2})

    Requested language. Optional. [lang=en]

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "A financial ledger",
  "type": "object",
  "properties": {
    "id": {
      "type": ["string", "null"],
      "description": "UUID",
      "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}$"
    },
    "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"
    },
    "ledger_status": {
      "description": "The status of the ledger",
      "type": "string"
    },
    "period_start": {
      "description": "The start date for the ledger",
      "type": "string",
      "format": "date-time"
    },
    "period_end": {
      "description": "The end date for the ledger",
      "type": "string",
      "format": "date-time"
    },
    "fiscal_years": {
      "id": "fiscal_years",
      "description": "The list of fiscal year objects associated with this ledger",
      "type": "array",
      "items": {
        "type": "string",
        "description": "UUID",
        "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}$"
      }
    }
  },
  "additionalProperties": false,
  "required": [
    "name",
    "code"
  ]
}

Example:

{
  "id": "7cef8378-7CBd-BFaE-BCdd-8b9d7c0af9De",
  "name": "Main Library",
  "code": "MAIN-LIB",
  "description": "This is the ledger for the Main Library",
  "period_start": "2017-07-01T00:00:00Z",
  "period_end": "2017-06-30T23:59:59Z",
  "fiscal_years": [
    "AC2164c7-Ba3d-AbC2-C12C-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-BFaE-BCdd-8b9d7c0af9De",
  "name": "Main Library",
  "code": "MAIN-LIB",
  "description": "This is the ledger for the Main Library",
  "period_start": "2017-07-01T00:00:00Z",
  "period_end": "2017-06-30T23:59:59Z",
  "fiscal_years": [
    "AC2164c7-Ba3d-AbC2-C12C-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 ledger -- unauthorized

Response 500

Internal server error, e.g. due to misconfiguration

Body

Media type: text/plain

Type: any

Example:

Internal server error, contact administrator

GET /ledger/{id}

Retrieve ledger item with given {ledgerId}

GET /ledger/{id}
URI Parameters
  • id: required (string)
Query Parameters
  • lang: (string - default: en - pattern: [a-zA-Z]{2})

    Requested language. Optional. [lang=en]

Response 200

Returns item with a given ID

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "A financial ledger",
  "type": "object",
  "properties": {
    "id": {
      "type": ["string", "null"],
      "description": "UUID",
      "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}$"
    },
    "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"
    },
    "ledger_status": {
      "description": "The status of the ledger",
      "type": "string"
    },
    "period_start": {
      "description": "The start date for the ledger",
      "type": "string",
      "format": "date-time"
    },
    "period_end": {
      "description": "The end date for the ledger",
      "type": "string",
      "format": "date-time"
    },
    "fiscal_years": {
      "id": "fiscal_years",
      "description": "The list of fiscal year objects associated with this ledger",
      "type": "array",
      "items": {
        "type": "string",
        "description": "UUID",
        "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}$"
      }
    }
  },
  "additionalProperties": false,
  "required": [
    "name",
    "code"
  ]
}

Example:

{
  "id": "7cef8378-7CBd-BFaE-BCdd-8b9d7c0af9De",
  "name": "Main Library",
  "code": "MAIN-LIB",
  "description": "This is the ledger for the Main Library",
  "period_start": "2017-07-01T00:00:00Z",
  "period_end": "2017-06-30T23:59:59Z",
  "fiscal_years": [
    "AC2164c7-Ba3d-AbC2-C12C-e35CeCcbfaF2"
  ]
}

Response 404

Item with a given ID not found

Body

Media type: text/plain

Type: any

Example:

"ledger not found"

Response 500

Internal server error, e.g. due to misconfiguration

Body

Media type: text/plain

Type: any

Example:

internal server error, contact administrator

DELETE /ledger/{id}

Delete ledger item with given {ledgerId}

DELETE /ledger/{id}
URI Parameters
  • id: required (string)
Query Parameters
  • lang: (string - default: en - pattern: [a-zA-Z]{2})

    Requested language. Optional. [lang=en]

Response 204

Item deleted successfully

Response 400

Bad request, e.g. malformed request body or query parameter. Details of the error (e.g. name of the parameter or line/character number with malformed data) provided in the response.

Body

Media type: text/plain

Type: any

Example:

"unable to delete ledger -- constraint violation"

Response 404

Item with a given ID not found

Body

Media type: text/plain

Type: any

Example:

"ledger not found"

Response 500

Internal server error, e.g. due to misconfiguration

Body

Media type: text/plain

Type: any

Example:

Internal server error, contact administrator

PUT /ledger/{id}

Update ledger item with given {ledgerId}

PUT /ledger/{id}
URI Parameters
  • id: required (string)
Query Parameters
  • lang: (string - default: en - pattern: [a-zA-Z]{2})

    Requested language. Optional. [lang=en]

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "A financial ledger",
  "type": "object",
  "properties": {
    "id": {
      "type": ["string", "null"],
      "description": "UUID",
      "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}$"
    },
    "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"
    },
    "ledger_status": {
      "description": "The status of the ledger",
      "type": "string"
    },
    "period_start": {
      "description": "The start date for the ledger",
      "type": "string",
      "format": "date-time"
    },
    "period_end": {
      "description": "The end date for the ledger",
      "type": "string",
      "format": "date-time"
    },
    "fiscal_years": {
      "id": "fiscal_years",
      "description": "The list of fiscal year objects associated with this ledger",
      "type": "array",
      "items": {
        "type": "string",
        "description": "UUID",
        "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}$"
      }
    }
  },
  "additionalProperties": false,
  "required": [
    "name",
    "code"
  ]
}

Example:

{
  "id": "7cef8378-7CBd-BFaE-BCdd-8b9d7c0af9De",
  "name": "Main Library",
  "code": "MAIN-LIB",
  "description": "This is the ledger for the Main Library",
  "period_start": "2017-07-01T00:00:00Z",
  "period_end": "2017-06-30T23:59:59Z",
  "fiscal_years": [
    "AC2164c7-Ba3d-AbC2-C12C-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 500

Internal server error, e.g. due to misconfiguration

Body

Media type: text/plain

Type: any

Example:

internal server error, contact administrator