/financeaccounts

Returns a single or multiple finance accounts, ordered by Account ID.

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

accountId

The ID of the finance account assigned by the system

 

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

 

INT

name

The human-friendly name of the finance account assigned by the institution

 

Including this parameter in your call will limit the response to a single account matching the name specified.

 

INT

parentAccountId

The ID of the finance account that is assigned as the parent to the finance account(s)

 

Including this parameter in your call will limit the response to only include those accounts whose parent account matches the account ID specified.

 

INT

organizationId

The ID of the organization that is assigned as the owner of the finance account(s)

 

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

 

INT


Example: Calling for a single finance account

Sample Call:

https://yoursite/api/financeaccounts/33 or https://yoursite/api/financeaccounts?id=33

Sample Response:

Example: Calling for all finance accounts

Sample Call:

https://yoursite/api/financeaccounts

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