API Docs

Ex Libris Developer Network Alma Documentation REST APIs API Docs

Retrieve funds

Resource URL
API Description
URL Parameters
Query string Parameters
Body Parameters
Output
Possible Error Codes

This API returns a list of Funds.
The list includes the relevant allocated funds that are active in the current date (based on the related fiscal period). This is the same list as retrieved in the UI when adding fund for a PO-Line.

TRY IT NOW

Resource URL

GET /almaws/v1/acq/funds

API Description

WADL documentation: Download
Swagger (OpenAPI) documentation: Download

URL Parameters

None

Querystring Parameters

Parameter	Type	Required	Description
`limit`	xs:int	Optional. Default: 10	Limits the number of results. Optional. Valid values are 0-100. Default value: 10.
`offset`	xs:int	Optional. Default: 0	Offset of the results returned. Optional. Default value: 0, which means that the first results will be returned.
`q`	xs:string	Optional.	Search query. Optional. If the mode parameter is POL, then searching is limited to fund_code. Otherwise, available search options: all, fund_code, description, external_id, name. For example: q=fund_code~FU1 (see Brief Search)
`library`	xs:string	Optional.	Filter by library or institution code that the fund is available for. All by default.
`view`	xs:string	Optional. Default: full	The view format, possible values: full / brief (used for vendors). Default is full
`mode`	xs:string	Optional. Default: POL	POL - ready to be used for a PO-Line, allocated and active in the current fiscal period. ALL - all funds and ledgers.
`status`	xs:string	Optional. Default: ALL	Filter by status: ACTIVE/INACTIVE. All by default.
`entity_type`	xs:string	Optional. Default: ALL	Filter by fund entity type: LEDGER/SUMMARY/ALLOCATED. All by default.
`fiscal_period`	xs:string	Optional. Default: ALL	Filter by fiscal period. Note: this should be the ID and not the description. All by default.
`parent_id`	xs:string	Optional. Default: ALL	Filter for funds by the ID of their parent (which can be a ledger or a summary fund). All by default.
`owner`	xs:string	Optional. Default: ALL	Filter by the fund owner: library or the institution code. All by default.

Body Parameters