/financetransactions

Returns a single or multiple finance transaction records, ordered by Request ID and Transaction 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

transactionId

The ID of the finance transaction assigned by the system 

Including this parameter in your call will limit the response to a single transaction matching the supplied ID.

INT

accountId

The ID of the finance account assigned by the system 

Including this parameter in your call will limit the response to only include transactions associated with the account ID specified.

INT

transactionType

The type of the finance transaction 

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

Note: Accepted values include “Deposit”, “Payment”, “Allocation”. There is another type of transaction called “Transfers” listed in the user interface of the system however these are actually a combination of deposits, payments, or allocations.

STRING

stageName

The name of the current approval stage for the finance request that transactions are attached to 

Including this parameter in your call will limit the response to only include transactions attached to 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 transaction 

Including this parameter in your call will limit the response to only include transactions 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 transaction 

Including this parameter in your call will limit the response to only include transactions 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 transaction

Sample Call:

https://yoursite/api/financetransactions/456 or https://yoursite/api/financetransactions?id=456

Sample Response: 

Example: Calling for multiple finance transactions

Sample Call:

https://yoursite/api/financetransactions

Sample Response:

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

Contact Us