Delete funds

delete

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

Bulk delete funds along with their linked equity accounts. Funds with posted activity cannot be deleted and are skipped; deactivate them instead. The query filters are the same as for searching funds and select the candidate set; the body picks the funds within it. Provide ids, or explicitly set include to false to delete every fund matching the filters (and every fund outright when no filters are given); an empty body is rejected.

Required permission: 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.

Body Params

The funds to delete

ids

array of doubles | null

The ids the operation applies to: an include list by default, or an exclude list when include is false. For deletes, required unless include is false.

ids

include

boolean | null

Whether ids is an include list (true, default) or an exclude list (false). Setting include to false with no ids applies the operation to every record matching the query filters.

Responses

200

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!