Search funds

get

https://{tenant}.onechurchsoftware.com/api/funds

Retrieve a list of accounting funds matching the given filters.

Required permission: Full Read Accounting or Accounting Settings

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

name

string

Return funds whose name contains the given text.

category

string

Comma-delimited list of account category ids. Returns funds whose linked equity account is in one of those categories.

active

boolean

If true, returns only active funds; if false, only deactivated funds.

transactions.start

double

Return funds with at least this many posted line items.

transactions.end

double

Return funds with at most this many posted line items.

accounts.start

double

Return funds used in at least this many accounts.

accounts.end

double

Return funds used in at most this many accounts.

assets.start

double

Return funds with assets of at least this amount.

assets.end

double

Return funds with assets of at most this amount.

liabilities.start

double

Return funds with liabilities of at least this amount.

liabilities.end

double

Return funds with liabilities of at most this amount.

balance.start

double

Return funds with a balance of at least this amount.

balance.end

double

Return funds with a balance of at most this amount.

starting.start

double

Return funds with a starting balance of at least this amount.

starting.end

double

Return funds with a starting balance of at most this amount.

earliest.start

date-time

Return funds whose earliest activity is on or after this date.

earliest.end

date-time

Return funds whose earliest activity is on or before this date.

latest.start

date-time

Return funds whose latest activity is on or after this date.

latest.end

date-time

Return funds whose latest activity is on or before this date.

createdBy

string

Return funds created by users whose name contains the given text.

skip

int32

≥ 0

The number of records to skip before returning results, used for paging.

limit

int32

≥ 0

The maximum number of records to return per page. Defaults to 50.

sort.property

string

The field to sort the results by. The default field depends on the endpoint.

sort.dir

string

enum

The sort direction: "asc" or "desc".

Allowed:

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

401

Authentication is required, or the Ocs-Api-Key header is missing or invalid.

Language

Credentials

Header

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

text/plain

application/json

text/json

200OK