mod-funds (v1)

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

Table of contents

mod-funds (Transactions)

CRUD APIs used to manage transactions.

/transaction

Collection of transaction items.

GET /transaction

Get list of transactions

GET /transaction
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 transaction items

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "A collection of transactions",
  "type": "object",
  "properties": {
    "transactions": {
      "description": "The list of objects contained in this collection",
      "type": "array",
      "id": "transactions",
      "items": {
        "type": "object",
        "$ref": "transaction.json"
      }
    },
    "total_records": {
      "description": "The number of objects in this collection",
      "type": "integer"
    },
    "first": {
      "description": "The index of the first object in this collection",
      "type": "integer"
    },
    "last": {
      "description": "The index of the last object in this collection",
      "type": "integer"
    }
  },
  "additionalProperties": false,
  "required": [
    "transactions",
    "total_records"
  ]
}

Example:

{
  "transactions": [
    {
      "id": "12Ac70A4-5C9D-A12F-9aCB-852aDf67D7e1",
      "allocated": 0,
      "amount": 25,
      "awaiting_payment": 0,
      "encumbered": 25,
      "expenditures": 0,
      "note": "PO_Line: History of Incas",
      "timestamp": "2017-07-01T19:03:02.778Z",
      "source_id": "906eb7a4-8BbC-1CCf-6cAF-de909eABeedd",
      "transaction_type": "PO-Line-Encumbrance",
      "budget_id": "47Ac60b4-159D-4e1c-9aCB-8293Df67D16d"
    }

  ],
  "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 transaction -- 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 transaction -- 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 /transaction

Create a new transaction item.

POST /transaction
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 transaction",
  "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}$"
    },
    "allocated": {
      "description": "The amount allocated by this transaction",
      "type": "number"
    },
    "amount": {
      "description": "The amount of this transaction",
      "type": "number"
    },
    "available": {
      "description": "The amount available of this transaction",
      "type": "number"
    },
    "awaiting_payment": {
      "description": "The amount awaiting payment of this transaction",
      "type": "number"
    },
    "encumbered": {
      "description": "The amount encumbred by this transaction",
      "type": "number"
    },
    "expenditures": {
      "description": "The amount expended by this transaction",
      "type": "number"
    },
    "note": {
      "description": "The note for this transaction",
      "type": "string"
    },
    "overcharge": {
      "description": "The amount overcharged by this transaction",
      "type": "number"
    },
    "timestamp": {
      "description": "The timestamp of the transaction",
      "type": "string",
      "format": "date-time"
    },
    "source_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}$"
    },
    "transaction_type": {
      "description": "The type of this transaction",
      "type": "string"
    },
    "budget_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}$"
    }
  },
  "additionalProperties": false,
  "required": [
    "amount"
  ]
}

Example:

{
  "id": "12Ac70A4-5C9D-A12F-9aCB-852aDf67D7e1",
  "allocated": 0,
  "amount": 25,
  "awaiting_payment": 0,
  "encumbered": 25,
  "expenditures": 0,
  "note": "PO_Line: History of Incas",
  "timestamp": "2017-07-01T19:03:02.778Z",
  "source_id": "906eb7a4-8BbC-1CCf-6cAF-de909eABeedd",
  "transaction_type": "PO-Line-Encumbrance",
  "budget_id": "47Ac60b4-159D-4e1c-9aCB-8293Df67D16d"
}

Response 201

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

Headers
  • Location: required (string)

    URI to the created transaction item

Body

Media type: application/json

Type: any

Example:

{
  "id": "12Ac70A4-5C9D-A12F-9aCB-852aDf67D7e1",
  "allocated": 0,
  "amount": 25,
  "awaiting_payment": 0,
  "encumbered": 25,
  "expenditures": 0,
  "note": "PO_Line: History of Incas",
  "timestamp": "2017-07-01T19:03:02.778Z",
  "source_id": "906eb7a4-8BbC-1CCf-6cAF-de909eABeedd",
  "transaction_type": "PO-Line-Encumbrance",
  "budget_id": "47Ac60b4-159D-4e1c-9aCB-8293Df67D16d"
}

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

Response 401

Not authorized to perform requested action

Body

Media type: text/plain

Type: any

Example:

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

Retrieve transaction item with given {transactionId}

GET /transaction/{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 transaction",
  "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}$"
    },
    "allocated": {
      "description": "The amount allocated by this transaction",
      "type": "number"
    },
    "amount": {
      "description": "The amount of this transaction",
      "type": "number"
    },
    "available": {
      "description": "The amount available of this transaction",
      "type": "number"
    },
    "awaiting_payment": {
      "description": "The amount awaiting payment of this transaction",
      "type": "number"
    },
    "encumbered": {
      "description": "The amount encumbred by this transaction",
      "type": "number"
    },
    "expenditures": {
      "description": "The amount expended by this transaction",
      "type": "number"
    },
    "note": {
      "description": "The note for this transaction",
      "type": "string"
    },
    "overcharge": {
      "description": "The amount overcharged by this transaction",
      "type": "number"
    },
    "timestamp": {
      "description": "The timestamp of the transaction",
      "type": "string",
      "format": "date-time"
    },
    "source_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}$"
    },
    "transaction_type": {
      "description": "The type of this transaction",
      "type": "string"
    },
    "budget_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}$"
    }
  },
  "additionalProperties": false,
  "required": [
    "amount"
  ]
}

Example:

{
  "id": "12Ac70A4-5C9D-A12F-9aCB-852aDf67D7e1",
  "allocated": 0,
  "amount": 25,
  "awaiting_payment": 0,
  "encumbered": 25,
  "expenditures": 0,
  "note": "PO_Line: History of Incas",
  "timestamp": "2017-07-01T19:03:02.778Z",
  "source_id": "906eb7a4-8BbC-1CCf-6cAF-de909eABeedd",
  "transaction_type": "PO-Line-Encumbrance",
  "budget_id": "47Ac60b4-159D-4e1c-9aCB-8293Df67D16d"
}

Response 404

Item with a given ID not found

Body

Media type: text/plain

Type: any

Example:

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

Delete transaction item with given {transactionId}

DELETE /transaction/{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 transaction -- constraint violation"

Response 404

Item with a given ID not found

Body

Media type: text/plain

Type: any

Example:

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

Update transaction item with given {transactionId}

PUT /transaction/{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 transaction",
  "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}$"
    },
    "allocated": {
      "description": "The amount allocated by this transaction",
      "type": "number"
    },
    "amount": {
      "description": "The amount of this transaction",
      "type": "number"
    },
    "available": {
      "description": "The amount available of this transaction",
      "type": "number"
    },
    "awaiting_payment": {
      "description": "The amount awaiting payment of this transaction",
      "type": "number"
    },
    "encumbered": {
      "description": "The amount encumbred by this transaction",
      "type": "number"
    },
    "expenditures": {
      "description": "The amount expended by this transaction",
      "type": "number"
    },
    "note": {
      "description": "The note for this transaction",
      "type": "string"
    },
    "overcharge": {
      "description": "The amount overcharged by this transaction",
      "type": "number"
    },
    "timestamp": {
      "description": "The timestamp of the transaction",
      "type": "string",
      "format": "date-time"
    },
    "source_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}$"
    },
    "transaction_type": {
      "description": "The type of this transaction",
      "type": "string"
    },
    "budget_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}$"
    }
  },
  "additionalProperties": false,
  "required": [
    "amount"
  ]
}

Example:

{
  "id": "12Ac70A4-5C9D-A12F-9aCB-852aDf67D7e1",
  "allocated": 0,
  "amount": 25,
  "awaiting_payment": 0,
  "encumbered": 25,
  "expenditures": 0,
  "note": "PO_Line: History of Incas",
  "timestamp": "2017-07-01T19:03:02.778Z",
  "source_id": "906eb7a4-8BbC-1CCf-6cAF-de909eABeedd",
  "transaction_type": "PO-Line-Encumbrance",
  "budget_id": "47Ac60b4-159D-4e1c-9aCB-8293Df67D16d"
}

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

Response 404

Item with a given ID not found

Body

Media type: text/plain

Type: any

Example:

"transaction 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