Finance fund (v1)

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

Fund API
Finance fund

Fund API

This documents the API calls that can be made to manage funds

Finance fund

Finance fund APIs

POST /finance/funds

Create a new fund item.

POST /finance/funds

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "A composite fund to track financial transactions",
  "type": "object",
  "properties": {
    "fund": {
      "description": "Fund to track financial transactions",
      "type": "object",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "properties": {
        "id": {
          "description": "UUID of this fund",
          "$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"
        },
        "allocatedFromIds": {
          "description": "All the funds that this fund is allowed to receive money from. This would be 1 fund or none. If this field is blank their is no restriction on allocating to this fund",
          "type": "array",
          "items": {
            "description": "UUID of the fund this fund is allowed to receive money from",
            "$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}$"
          }
        },
        "allocatedToIds": {
          "description": "All the funds that this fund is allowed to send money to. This could be one or many.",
          "type": "array",
          "items": {
            "description": "UUID of the fund this fund is allowed to send money to",
            "$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}$"
          }
        },
        "code": {
          "description": "A unique code associated with the fund",
          "$schema": "http://json-schema.org/draft-04/schema#",
          "type": "string",
          "pattern": "^[^:]+$"
        },
        "description": {
          "description": "The description of this fund",
          "type": "string"
        },
        "externalAccountNo": {
          "description": "Corresponding account in the financial system. Will be recorded in payment generated as well.",
          "type": "string"
        },
        "fundStatus": {
          "description": "The current status of this fund",
          "type": "string",
          "enum": [
            "Active",
            "Frozen",
            "Inactive"
          ]
        },
        "fundTypeId": {
          "description": "UUID of the fund type associated with this fund",
          "$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}$"
        },
        "ledgerId": {
          "description": "UUID of the financial ledger associated with this fund",
          "$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}$"
        },
        "name": {
          "description": "The name of this fund",
          "type": "string"
        },
        "acqUnitIds": {
          "description": "acquisition unit ids associated with this fund",
          "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}$"
          }
        },
        "donorOrganizationIds": {
          "description": "donor organization ids associated with this fund",
          "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}$"
          }
        },
        "restrictByLocations": {
          "description": "restrict usage of this fund by locations",
          "type": "boolean",
          "default": false
        },
        "locations": {
          "description": "Locations associated with this fund",
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "locationId": {
                "$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}$"
              },
              "tenantId": {
                "description": "Tenant id of the associated location",
                "type": "string"
              }
            },
            "additionalProperties": false,
            "required": [
              "locationId"
            ]
          }
        },
        "tags": {
          "type": "object",
          "description": "arbitrary tags associated with this fund",
          "$schema": "http://json-schema.org/draft-04/schema#",
          "id": "tags.schema",
          "title": "tags",
          "properties": {
            "tagList": {
              "description": "List of tags",
              "type": "array",
              "items": {
                "type": "string"
              }
            }
          },
          "additionalProperties": false
        },
        "metadata": {
          "description": "Metadata about creation and changes to record, provided by the server (client should not provide)",
          "type": "object",
          "readonly": true,
          "$schema": "http://json-schema.org/draft-04/schema#",
          "id": "metadata.schema",
          "title": "Metadata Schema",
          "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": [
        "code",
        "fundStatus",
        "ledgerId",
        "name"
      ]
    },
    "groupIds": {
      "description": "Group ids associated with this fund",
      "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}$"
      }
    }
  },
  "additionalProperties": false,
  "required": [
    "fund"
  ]
}

Example:

{
  "fund": {
    "id": "6e2fbba3-d557-4480-bca3-b6f5c645de04",
    "allocatedFromIds": [
      "1a490199-833d-4876-b2ff-2bd61f8324f1",
      "d69a001c-ac69-4348-bee1-f9f3ef8a3f32"
    ],
    "allocatedToIds": [
      "c08a5b0c-6717-4788-9df5-b0e8338c1172"
    ],
    "code": "HIST",
    "description": "Tracking fund for the History department",
    "externalAccountNo": "1121112569489",
    "fundStatus": "Active",
    "fundTypeId": "c93373df-e7ec-4d31-b200-719736610d89",
    "ledgerId": "7ebd02c8-2bd4-40ae-b44d-0e76dc197633",
    "name": "History",
    "acqUnitIds": [
      "1895e539-8dac-441e-b1f5-aab62b3fde60",
      "47f504bd-0c1b-498e-a2ae-e2f0a0cea273"
    ],
    "tags": {
      "tagList": [
        "tag"
      ]
    },
    "metadata": {
      "createdDate": "2020-07-19T10:00:00.000+0000",
      "createdByUserId": "28d1057c-d137-11e8-a8d5-f2801f1b9fd1"
    }
  },
  "groupIds": [
    "f33ed99b-852a-4f90-9891-5efe0feab165"
  ]
}

Response 201

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

Headers

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

Body

Media type: application/json

Type: any

Example:

{
  "fund": {
    "id": "6e2fbba3-d557-4480-bca3-b6f5c645de04",
    "allocatedFromIds": [
      "1a490199-833d-4876-b2ff-2bd61f8324f1",
      "d69a001c-ac69-4348-bee1-f9f3ef8a3f32"
    ],
    "allocatedToIds": [
      "c08a5b0c-6717-4788-9df5-b0e8338c1172"
    ],
    "code": "HIST",
    "description": "Tracking fund for the History department",
    "externalAccountNo": "1121112569489",
    "fundStatus": "Active",
    "fundTypeId": "c93373df-e7ec-4d31-b200-719736610d89",
    "ledgerId": "7ebd02c8-2bd4-40ae-b44d-0e76dc197633",
    "name": "History",
    "acqUnitIds": [
      "1895e539-8dac-441e-b1f5-aab62b3fde60",
      "47f504bd-0c1b-498e-a2ae-e2f0a0cea273"
    ],
    "tags": {
      "tagList": [
        "tag"
      ]
    },
    "metadata": {
      "createdDate": "2020-07-19T10:00:00.000+0000",
      "createdByUserId": "28d1057c-d137-11e8-a8d5-f2801f1b9fd1"
    }
  },
  "groupIds": [
    "f33ed99b-852a-4f90-9891-5efe0feab165"
  ]
}

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"
        }
      ]
    }
  ]
}

Media type: text/plain

Type: any

Example:

"unable to add fund -- malformed JSON at 13:3"

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 create funds -- 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: 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

GET /finance/funds

Retrieve a list of fund items.

GET /finance/funds

Query Parameters

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
```
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", "="]
```

Response 200

Returns a list of fund items

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "A collection of funds",
  "type": "object",
  "properties": {
    "funds": {
      "description": "The list of funds contained in this collection",
      "type": "array",
      "id": "funds",
      "items": {
        "type": "object",
        "$schema": "http://json-schema.org/draft-04/schema#",
        "description": "A fund to track financial transactions",
        "properties": {
          "id": {
            "description": "UUID of this fund",
            "$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"
          },
          "allocatedFromIds": {
            "description": "All the funds that this fund is allowed to receive money from. This would be 1 fund or none. If this field is blank their is no restriction on allocating to this fund",
            "type": "array",
            "items": {
              "description": "UUID of the fund this fund is allowed to receive money from",
              "$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}$"
            }
          },
          "allocatedToIds": {
            "description": "All the funds that this fund is allowed to send money to. This could be one or many.",
            "type": "array",
            "items": {
              "description": "UUID of the fund this fund is allowed to send money to",
              "$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}$"
            }
          },
          "code": {
            "description": "A unique code associated with the fund",
            "$schema": "http://json-schema.org/draft-04/schema#",
            "type": "string",
            "pattern": "^[^:]+$"
          },
          "description": {
            "description": "The description of this fund",
            "type": "string"
          },
          "externalAccountNo": {
            "description": "Corresponding account in the financial system. Will be recorded in payment generated as well.",
            "type": "string"
          },
          "fundStatus": {
            "description": "The current status of this fund",
            "type": "string",
            "enum": [
              "Active",
              "Frozen",
              "Inactive"
            ]
          },
          "fundTypeId": {
            "description": "UUID of the fund type associated with this fund",
            "$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}$"
          },
          "ledgerId": {
            "description": "UUID of the financial ledger associated with this fund",
            "$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}$"
          },
          "name": {
            "description": "The name of this fund",
            "type": "string"
          },
          "acqUnitIds": {
            "description": "acquisition unit ids associated with this fund",
            "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}$"
            }
          },
          "donorOrganizationIds": {
            "description": "donor organization ids associated with this fund",
            "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}$"
            }
          },
          "restrictByLocations": {
            "description": "restrict usage of this fund by locations",
            "type": "boolean",
            "default": false
          },
          "locations": {
            "description": "Locations associated with this fund",
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "locationId": {
                  "$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}$"
                },
                "tenantId": {
                  "description": "Tenant id of the associated location",
                  "type": "string"
                }
              },
              "additionalProperties": false,
              "required": [
                "locationId"
              ]
            }
          },
          "tags": {
            "type": "object",
            "description": "arbitrary tags associated with this fund",
            "$schema": "http://json-schema.org/draft-04/schema#",
            "id": "tags.schema",
            "title": "tags",
            "properties": {
              "tagList": {
                "description": "List of tags",
                "type": "array",
                "items": {
                  "type": "string"
                }
              }
            },
            "additionalProperties": false
          },
          "metadata": {
            "description": "Metadata about creation and changes to record, provided by the server (client should not provide)",
            "type": "object",
            "readonly": true,
            "$schema": "http://json-schema.org/draft-04/schema#",
            "id": "metadata.schema",
            "title": "Metadata Schema",
            "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": [
          "code",
          "fundStatus",
          "ledgerId",
          "name"
        ]
      }
    },
    "totalRecords": {
      "description": "The number of objects contained in this collection",
      "type": "integer",
      "minimum": 0
    }
  },
  "additionalProperties": false,
  "required": [
    "funds",
    "totalRecords"
  ]
}

Example:

{
  "funds": [
    {
      "id": "20ad2b8d-84b0-4320-ad83-347c525dc8e1",
      "allocatedFromIds": [
        "b1f857ba-0e39-4c5b-851a-1b837a56b201",
        "1097980d-97c9-4130-b6f0-a11b7804887d"
      ],
      "allocatedToIds": [
        "24fa4a94-8aa2-4f69-abeb-f12b67f711e3"
      ],
      "code": "HIST",
      "description": "Tracking fund for the History department",
      "externalAccountNo": "52186156468152",
      "fundStatus": "Active",
      "fundTypeId": "c93373df-e7ec-4d31-b200-719736610d89",
      "ledgerId": "a3ec5552-c4a4-4a15-a57c-0046db536369",
      "name": "History",
      "acqUnitIds": [
        "1895e539-8dac-441e-b1f5-aab62b3fde60",
        "47f504bd-0c1b-498e-a2ae-e2f0a0cea273"
      ],
      "donorOrganizationIds": [
        "d926d900-e27d-46d6-bba8-31e9d5c2cf44",
        "077274ad-6b4f-4c28-9779-6d381e7a1ca1"
      ],
      "restrictByLocations": true,
      "locations": [
        {
          "locationId": "eb2d063a-5b4c-4cab-8db1-5fc5c5941df6"
        },
        {
          "locationId": "fcd64ce1-6995-48f0-840e-89ffa2288371"
        }
      ],
      "tags": {
        "tagList": [
          "tag"
        ]
      },
      "metadata": {
        "createdDate": "2020-07-19T10:00:00.000+0000",
        "createdByUserId": "28d1057c-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: 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 list funds -- malformed parameter 'query', syntax error at column 6

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 list funds -- unauthorized

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

PUT /finance/funds/{id}

Update fund item with given {fundId}

PUT /finance/funds/{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 fund

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "A composite fund to track financial transactions",
  "type": "object",
  "properties": {
    "fund": {
      "description": "Fund to track financial transactions",
      "type": "object",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "properties": {
        "id": {
          "description": "UUID of this fund",
          "$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"
        },
        "allocatedFromIds": {
          "description": "All the funds that this fund is allowed to receive money from. This would be 1 fund or none. If this field is blank their is no restriction on allocating to this fund",
          "type": "array",
          "items": {
            "description": "UUID of the fund this fund is allowed to receive money from",
            "$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}$"
          }
        },
        "allocatedToIds": {
          "description": "All the funds that this fund is allowed to send money to. This could be one or many.",
          "type": "array",
          "items": {
            "description": "UUID of the fund this fund is allowed to send money to",
            "$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}$"
          }
        },
        "code": {
          "description": "A unique code associated with the fund",
          "$schema": "http://json-schema.org/draft-04/schema#",
          "type": "string",
          "pattern": "^[^:]+$"
        },
        "description": {
          "description": "The description of this fund",
          "type": "string"
        },
        "externalAccountNo": {
          "description": "Corresponding account in the financial system. Will be recorded in payment generated as well.",
          "type": "string"
        },
        "fundStatus": {
          "description": "The current status of this fund",
          "type": "string",
          "enum": [
            "Active",
            "Frozen",
            "Inactive"
          ]
        },
        "fundTypeId": {
          "description": "UUID of the fund type associated with this fund",
          "$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}$"
        },
        "ledgerId": {
          "description": "UUID of the financial ledger associated with this fund",
          "$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}$"
        },
        "name": {
          "description": "The name of this fund",
          "type": "string"
        },
        "acqUnitIds": {
          "description": "acquisition unit ids associated with this fund",
          "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}$"
          }
        },
        "donorOrganizationIds": {
          "description": "donor organization ids associated with this fund",
          "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}$"
          }
        },
        "restrictByLocations": {
          "description": "restrict usage of this fund by locations",
          "type": "boolean",
          "default": false
        },
        "locations": {
          "description": "Locations associated with this fund",
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "locationId": {
                "$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}$"
              },
              "tenantId": {
                "description": "Tenant id of the associated location",
                "type": "string"
              }
            },
            "additionalProperties": false,
            "required": [
              "locationId"
            ]
          }
        },
        "tags": {
          "type": "object",
          "description": "arbitrary tags associated with this fund",
          "$schema": "http://json-schema.org/draft-04/schema#",
          "id": "tags.schema",
          "title": "tags",
          "properties": {
            "tagList": {
              "description": "List of tags",
              "type": "array",
              "items": {
                "type": "string"
              }
            }
          },
          "additionalProperties": false
        },
        "metadata": {
          "description": "Metadata about creation and changes to record, provided by the server (client should not provide)",
          "type": "object",
          "readonly": true,
          "$schema": "http://json-schema.org/draft-04/schema#",
          "id": "metadata.schema",
          "title": "Metadata Schema",
          "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": [
        "code",
        "fundStatus",
        "ledgerId",
        "name"
      ]
    },
    "groupIds": {
      "description": "Group ids associated with this fund",
      "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}$"
      }
    }
  },
  "additionalProperties": false,
  "required": [
    "fund"
  ]
}

Example:

{
  "fund": {
    "id": "6e2fbba3-d557-4480-bca3-b6f5c645de04",
    "allocatedFromIds": [
      "1a490199-833d-4876-b2ff-2bd61f8324f1",
      "d69a001c-ac69-4348-bee1-f9f3ef8a3f32"
    ],
    "allocatedToIds": [
      "c08a5b0c-6717-4788-9df5-b0e8338c1172"
    ],
    "code": "HIST",
    "description": "Tracking fund for the History department",
    "externalAccountNo": "1121112569489",
    "fundStatus": "Active",
    "fundTypeId": "c93373df-e7ec-4d31-b200-719736610d89",
    "ledgerId": "7ebd02c8-2bd4-40ae-b44d-0e76dc197633",
    "name": "History",
    "acqUnitIds": [
      "1895e539-8dac-441e-b1f5-aab62b3fde60",
      "47f504bd-0c1b-498e-a2ae-e2f0a0cea273"
    ],
    "tags": {
      "tagList": [
        "tag"
      ]
    },
    "metadata": {
      "createdDate": "2020-07-19T10:00:00.000+0000",
      "createdByUserId": "28d1057c-d137-11e8-a8d5-f2801f1b9fd1"
    }
  },
  "groupIds": [
    "f33ed99b-852a-4f90-9891-5efe0feab165"
  ]
}

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"
        }
      ]
    }
  ]
}

Media type: text/plain

Type: any

Example:

"unable to update fund -- malformed JSON at 13:4"

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:

"fund 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: 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

GET /finance/funds/{id}

Retrieve fund item with given {fundId}

GET /finance/funds/{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 fund

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 composite fund to track financial transactions",
  "type": "object",
  "properties": {
    "fund": {
      "description": "Fund to track financial transactions",
      "type": "object",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "properties": {
        "id": {
          "description": "UUID of this fund",
          "$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"
        },
        "allocatedFromIds": {
          "description": "All the funds that this fund is allowed to receive money from. This would be 1 fund or none. If this field is blank their is no restriction on allocating to this fund",
          "type": "array",
          "items": {
            "description": "UUID of the fund this fund is allowed to receive money from",
            "$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}$"
          }
        },
        "allocatedToIds": {
          "description": "All the funds that this fund is allowed to send money to. This could be one or many.",
          "type": "array",
          "items": {
            "description": "UUID of the fund this fund is allowed to send money to",
            "$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}$"
          }
        },
        "code": {
          "description": "A unique code associated with the fund",
          "$schema": "http://json-schema.org/draft-04/schema#",
          "type": "string",
          "pattern": "^[^:]+$"
        },
        "description": {
          "description": "The description of this fund",
          "type": "string"
        },
        "externalAccountNo": {
          "description": "Corresponding account in the financial system. Will be recorded in payment generated as well.",
          "type": "string"
        },
        "fundStatus": {
          "description": "The current status of this fund",
          "type": "string",
          "enum": [
            "Active",
            "Frozen",
            "Inactive"
          ]
        },
        "fundTypeId": {
          "description": "UUID of the fund type associated with this fund",
          "$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}$"
        },
        "ledgerId": {
          "description": "UUID of the financial ledger associated with this fund",
          "$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}$"
        },
        "name": {
          "description": "The name of this fund",
          "type": "string"
        },
        "acqUnitIds": {
          "description": "acquisition unit ids associated with this fund",
          "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}$"
          }
        },
        "donorOrganizationIds": {
          "description": "donor organization ids associated with this fund",
          "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}$"
          }
        },
        "restrictByLocations": {
          "description": "restrict usage of this fund by locations",
          "type": "boolean",
          "default": false
        },
        "locations": {
          "description": "Locations associated with this fund",
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "locationId": {
                "$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}$"
              },
              "tenantId": {
                "description": "Tenant id of the associated location",
                "type": "string"
              }
            },
            "additionalProperties": false,
            "required": [
              "locationId"
            ]
          }
        },
        "tags": {
          "type": "object",
          "description": "arbitrary tags associated with this fund",
          "$schema": "http://json-schema.org/draft-04/schema#",
          "id": "tags.schema",
          "title": "tags",
          "properties": {
            "tagList": {
              "description": "List of tags",
              "type": "array",
              "items": {
                "type": "string"
              }
            }
          },
          "additionalProperties": false
        },
        "metadata": {
          "description": "Metadata about creation and changes to record, provided by the server (client should not provide)",
          "type": "object",
          "readonly": true,
          "$schema": "http://json-schema.org/draft-04/schema#",
          "id": "metadata.schema",
          "title": "Metadata Schema",
          "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": [
        "code",
        "fundStatus",
        "ledgerId",
        "name"
      ]
    },
    "groupIds": {
      "description": "Group ids associated with this fund",
      "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}$"
      }
    }
  },
  "additionalProperties": false,
  "required": [
    "fund"
  ]
}

Example:

{
  "fund": {
    "id": "6e2fbba3-d557-4480-bca3-b6f5c645de04",
    "allocatedFromIds": [
      "1a490199-833d-4876-b2ff-2bd61f8324f1",
      "d69a001c-ac69-4348-bee1-f9f3ef8a3f32"
    ],
    "allocatedToIds": [
      "c08a5b0c-6717-4788-9df5-b0e8338c1172"
    ],
    "code": "HIST",
    "description": "Tracking fund for the History department",
    "externalAccountNo": "1121112569489",
    "fundStatus": "Active",
    "fundTypeId": "c93373df-e7ec-4d31-b200-719736610d89",
    "ledgerId": "7ebd02c8-2bd4-40ae-b44d-0e76dc197633",
    "name": "History",
    "acqUnitIds": [
      "1895e539-8dac-441e-b1f5-aab62b3fde60",
      "47f504bd-0c1b-498e-a2ae-e2f0a0cea273"
    ],
    "tags": {
      "tagList": [
        "tag"
      ]
    },
    "metadata": {
      "createdDate": "2020-07-19T10:00:00.000+0000",
      "createdByUserId": "28d1057c-d137-11e8-a8d5-f2801f1b9fd1"
    }
  },
  "groupIds": [
    "f33ed99b-852a-4f90-9891-5efe0feab165"
  ]
}

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:

"fund not found"

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

DELETE /finance/funds/{id}

Delete fund item with given {fundId}

DELETE /finance/funds/{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 fund

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: 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 delete fund -- constraint violation"

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:

"fund not found"

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

GET /finance/funds/{id}/expense-classes

Retrieve expense-class item with given {expense-classId}

GET /finance/funds/{id}/expense-classes

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 fund

Query Parameters

status: (string)
Status of the expense classes
Example:
```
Active
```
fiscalYearId: (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 fiscal year. If not passed, current fiscal year will be used.
Example:
```
44e6aa2b-a21f-4e40-bf24-f4bc31a15a3a
```

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 collection of expense classes",
  "type": "object",
  "properties": {
    "expenseClasses": {
      "description": "The list of  expense classes objects in this collection",
      "type": "array",
      "id": "expense_classes",
      "items": {
        "type": "object",
        "$schema": "http://json-schema.org/draft-04/schema#",
        "description": "An expense class",
        "properties": {
          "id": {
            "description": "UUID of the expense class record",
            "type": "string",
            "$schema": "http://json-schema.org/draft-04/schema#",
            "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"
          },
          "code": {
            "description": "The code of the expense class",
            "type": "string",
            "pattern": "^[^:]+$"
          },
          "externalAccountNumberExt": {
            "description": "An external account number extension",
            "type": "string"
          },
          "name": {
            "description": "The name of the expense class",
            "type": "string"
          },
          "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"
            ]
          }
        },
        "additionalProperties": false,
        "required": [
          "name",
          "code"
        ]
      }
    },
    "totalRecords": {
      "description": "The number of objects in this collection",
      "type": "integer"
    }
  },
  "additionalProperties": false,
  "required": [
    "expenseClasses",
    "totalRecords"
  ]
}

Example:

{
  "expenseClasses": [
    {
      "id": "1bcc3247-99bf-4dca-9b0f-7bc51a2998c2",
      "code": "Elec",
      "name": "Electronic",
      "externalAccountNumberExt": "54321098",
      "metadata": {
        "createdDate": "2019-06-17T14:12:42.497+0000",
        "createdByUserId": "498492aa-f909-42f6-b154-5bf66e6486ba",
        "updatedDate": "2019-08-28T08:37:19.263+0000",
        "updatedByUserId": "7ec56c96-e9f2-4079-9509-86b00f8dacd5"
      }
    }
  ],
  "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: 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 list expense-classes -- malformed parameter 'query', syntax error at column 6"

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 list expense-classes -- 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:

"expense-class not found"

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

GET /finance/funds/{id}/budget

Retrieve budget item with given {budgetId}

GET /finance/funds/{id}/budget

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 fund

Query Parameters

status: (string)
Status of the budget
Example:
```
Active
```

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 budget",
  "type": "object",
  "javaName": "budget",
  "properties": {
    "id": {
      "description": "UUID of this budget",
      "$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 budget",
      "type": "string"
    },
    "budgetStatus": {
      "description": "The status of the budget",
      "type": "string",
      "enum": [
        "Active",
        "Frozen",
        "Inactive",
        "Planned",
        "Closed"
      ]
    },
    "allowableEncumbrance": {
      "description": "The encumbrance percentage limit for this budget",
      "type": "number",
      "minimum": 0
    },
    "allowableExpenditure": {
      "description": "The expenditure percentage limit for this budget",
      "type": "number",
      "minimum": 0
    },
    "allocated": {
      "description": "The amount currently allocated to this budget",
      "type": "number",
      "readonly": true
    },
    "awaitingPayment": {
      "default": 0,
      "description": "The amount currently awaiting payment for this budget",
      "type": "number"
    },
    "available": {
      "description": "The amount currently available for this budge",
      "type": "number",
      "readonly": true
    },
    "credits": {
      "default": 0,
      "description": "The amount currently credited for this budget",
      "type": "number"
    },
    "encumbered": {
      "default": 0,
      "description": "The amount currently encumbered for this budget",
      "type": "number"
    },
    "expenditures": {
      "default": 0,
      "description": "The amount currently expended for this budget",
      "type": "number"
    },
    "netTransfers": {
      "default": 0,
      "description": "Summing all the transfers on this budget",
      "type": "number"
    },
    "unavailable": {
      "description": "Unavailable amount for this budget",
      "type": "number",
      "readonly": true
    },
    "overEncumbrance": {
      "description": "The amount currently over-encumbered for this budget",
      "type": "number",
      "readonly": true
    },
    "overExpended": {
      "description": "Amount the budget is over expended.",
      "type": "number",
      "readonly": true
    },
    "fundId": {
      "description": "UUID of fund",
      "$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}$"
    },
    "fiscalYearId": {
      "description": "UUID of fiscal year",
      "$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}$"
    },
    "acqUnitIds": {
      "description": "acquisition unit ids associated with this budget",
      "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}$"
      }
    },
    "tags": {
      "type": "object",
      "description": "arbitrary tags associated with this budget",
      "$schema": "http://json-schema.org/draft-04/schema#",
      "id": "tags.schema",
      "title": "tags",
      "properties": {
        "tagList": {
          "description": "List of tags",
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      },
      "additionalProperties": false
    },
    "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": {
      "default": 0,
      "description": "The amount of the first allocation made to this budget",
      "type": "number"
    },
    "allocationTo": {
      "default": 0,
      "description": "The sum of all allocation transaction amounts made TO this budget not including the Initial allocation",
      "type": "number"
    },
    "allocationFrom": {
      "default": 0,
      "description": "The sum of all allocation transaction amounts made FROM this budget not including the Initial allocation",
      "type": "number"
    },
    "totalFunding": {
      "description": "budget.allocated + budget.netTransfers",
      "type": "number",
      "readonly": true
    },
    "cashBalance": {
      "description": "Total Funding minus Expended",
      "type": "number",
      "readonly": true
    }
  },
  "additionalProperties": false,
  "required": [
    "budgetStatus",
    "name",
    "fundId",
    "fiscalYearId"
  ]
}

Example:

{
  "id": "47ac60b4-159d-4e1c-9acb-8293df67d16d",
  "name": "History 2017",
  "budgetStatus": "Active",
  "allowableEncumbrance": 95,
  "allowableExpenditure": 100,
  "allocated": 20000,
  "netTransfers": 0,
  "awaitingPayment": 3500,
  "available": 10000,
  "credits": 3000,
  "encumbered": 2000,
  "expenditures": 4500,
  "unavailable": 10000,
  "overEncumbrance": 0,
  "overExpended": 0,
  "fundId": "172364c7-aaaa-10c2-b12c-e35ceccbfaf2",
  "fiscalYearId": "ac2164c7-ba3d-2bc2-a12c-e35ceccbfaf2",
  "acqUnitIds": [
    "7ec2ed06-0504-40dc-bc53-7515955ff0cb"
  ],
  "tags": {
    "tagList": [
      "important"
    ]
  },
  "metadata": {
    "createdDate": "2018-07-19T00:00:00.000+0000",
    "createdByUserId": "28d1057c-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 budget -- 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:

"budget not found"

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

Finance fund (v1)

Table of contents

Fund API

Finance fund

POST /finance/funds

Response 201

Headers

Response 400

Response 401

Response 422

Response 500

GET /finance/funds

Query Parameters

Response 200

Response 400

Response 401

Response 500

PUT /finance/funds/{id}

URI Parameters

Response 204

Response 400

Response 404

Response 409

Response 422

Response 500

GET /finance/funds/{id}

URI Parameters

Response 200

Response 404

Response 500

DELETE /finance/funds/{id}

URI Parameters

Response 204

Response 400

Response 404

Response 500

GET /finance/funds/{id}/expense-classes

URI Parameters

Query Parameters

Response 200

Response 400

Response 401

Response 404

Response 500

GET /finance/funds/{id}/budget

URI Parameters

Query Parameters

Response 200

Response 401

Response 404

Response 500