The Funds API

The Funds API contains a method for retrieving fund information.

With the Funds API, you can:

The Try it out! links below take you to the corresponding section in the interactive documentation, where you can view the model, model schema, and parameters for each available operation.

Get a List of Funds

To use this endpoint, your key must be assigned the Funds Read role. See Administering Sierra API Client Keys in the Sierra WebHelp for more information.

GET /v6/funds/

Returns the properties of all funds associated with the specified login. You can specify a list of fund types (in Sierra 4.2 and later) and fund codes to return.

If you do not specify filter parameters, queries return the following item record information by default:

  • fund code
  • the fund name
  • note associated with the fund
  • the external fund code
  • the external fund name
  • the fund type

By default, query response do not include the fund code number (codeNumber) or accounting unit code number (accountingUnitCodeNumber). You can specify this data using filter parameters. For example:

https://example-library.edu/iii/sierra-api/v6/funds?fields=default,codeNumber

Returns the default properties plus the fund code number for each fund.

Try it out!