/financerequests

Returns a single or multiple finance request submissions, ordered by the Submission Date.

Optional Parameters

Parameter

Description

Type

page

The specific page number in a paginated list of results

Including this parameter in your call will limit the response to a single page matching the page sequence order represented by the page number.

INT

pageSize

The number of items to include in the page of results 

Including this parameter in your call will adjust the response to only include no more than the number of items that you specify on each page.

Note: The value “100” will be used by default if the parameter is not explicitly set and the maximum value is “500”.

INT

organizationId

The ID of the organization that submitted the finance request 

Including this parameter in your call will limit the response to only include those requests submitted by the organization that matches the ID specified. 

INT

requestType

The type of the finance request 

Including this parameter in your call will limit the response to only include requests of the type value specified.

Note: Accepted values include “purchase” or “funding” 

STRING

status

The status of the finance request 

Including this parameter in your call will limit the response to only include requests of the status value specified.

Note: Accepted values include “approved”, “canceled”, “completed”, “denied”, or “unapproved” 

STRING

stage

The name of the current approval stage for the finance request 

Including this parameter in your call will limit the response to only include requests that are in the approval stage specified.

Note: The name of approval stages is a custom value set by each institution. Log in to your system and check the Finance Administration area to see your Stage name values.

STRING

startDate

A date filter based on the creation date of a request 

Including this parameter in your call will limit the response to only include requests created on or after the specified date.

Note: dates must be represented in milliseconds/UTC time (e.g., November 12, 2013 is 1384232400000 milliseconds since 1/1/1970 00:00:00 which is the start of Unix Epoch Time) 

LONG

endDate

A date filter based on the creation date of a request 

Including this parameter in your call will limit the response to only include requests created on or before the specified date.

Note: dates must be represented in milliseconds/UTC time (e.g., November 12, 2013 is 1384232400000 milliseconds since 1/1/1970 00:00:00 which is the start of Unix Epoch Time)

LONG


Example: Calling for a single finance request

Sample Call:

https://yoursite/api/financerequests/24 or https://yoursite/api/financerequests?id=24

Sample Response:

 

Example: Calling for multiple finance requests

Sample Call:

https://yoursite/api/financerequests (shown below; returns all requests in the system) or https://yoursite/api/financerequests?organizationId=39 (response structure same as calls for multiple or all finance requests; returns all requests for a single organization)

Sample Response:

Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request

Need More Help?

Additional Support

Powered by Zendesk