Skip to content
Permalink
master
Switch branches/tags
Go to file
 
 
Cannot retrieve contributors at this time
#%RAML 1.0
title: Finance fund
version: v1
protocols: [ HTTP, HTTPS ]
baseUri: https://github.com/folio-org/mod-finance
documentation:
- title: Fund API
content: This documents the API calls that can be made to manage funds
types:
compositeFund: !include acq-models/mod-finance/schemas/composite_fund.json
fundsCollection: !include acq-models/mod-finance/schemas/fund_collection.json
expenseClassCollection: !include acq-models/mod-finance/schemas/expense_class_collection.json
budget: !include acq-models/mod-finance/schemas/budget.json
errors: !include raml-util/schemas/errors.schema
UUID:
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}$
traits:
validate: !include raml-util/traits/validation.raml
language: !include raml-util/traits/language.raml
pageable: !include raml-util/traits/pageable.raml
searchable: !include raml-util/traits/searchable.raml
resourceTypes:
collection: !include raml-util/rtypes/collection-with-json-response.raml
collection-item: !include raml-util/rtypes/item-collection-with-json-response.raml
collection-get: !include raml-util/rtypes/collection-get-with-json-response.raml
item-collection-get: !include raml-util/rtypes/item-collection-get-with-json-response.raml
/finance/funds:
displayName: Finance fund
description: Finance fund APIs
type:
collection:
schemaCollection: fundsCollection
schemaItem: compositeFund
exampleCollection: !include acq-models/mod-finance/examples/fund_collection.sample
exampleItem: !include acq-models/mod-finance/examples/composite_fund.sample
post:
is: [validate]
get:
is: [
pageable,
searchable: {description: "with valid searchable fields: for example code", example: "[\"code\", \"MEDGRANT\", \"=\"]"}
]
/{id}:
uriParameters:
id:
description: The UUID of a fund
type: UUID
displayName: Fund
description: Get, Delete or Update a specific fund
type:
collection-item:
schema: compositeFund
exampleItem: !include acq-models/mod-finance/examples/composite_fund.sample
put:
is: [validate]
/expense-classes:
type:
collection-get:
exampleCollection: !include acq-models/mod-finance/examples/expense_class_collection.sample
schemaCollection: expenseClassCollection
get:
queryParameters:
status:
displayName: Status of the expense classes
type: string
description: Status of the expense classes
example: Active
required: false
/budget:
type:
item-collection-get:
schema: budget
exampleItem: !include acq-models/mod-finance/examples/budget.sample
get:
queryParameters:
status:
displayName: Status of the budget
type: string
description: Status of the budget
example: Active
required: false