Delete contributions

delete

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

Delete multiple contributions at once. Provide ids, or explicitly set include to false to delete every contribution matching the filters (and every contribution outright when no filters are given); an empty body is rejected. Only manually-entered contributions in open batches can be deleted.

Required permission: Limited Write Contributions

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

method

string

Comma-delimited list of payment method ids. Values come from /api/property_values/transaction_methods/values.

status

string

Comma-delimited list of status ids. Values come from /api/property_values/transaction_statuses/values.

designation

string

Comma-delimited list of designation ids. Values come from /api/designations.

date.start

date-time

Return contributions given on or after this date and time.

date.end

date-time

Return contributions given on or before this date and time.

designationCampus

string

Comma-delimited list of campus (location) ids the designation belongs to. Use -1 to include designations with no campus.

personCampus

string

Comma-delimited list of campus (location) ids the giver belongs to. Use -1 to include people with no campus.

source

string

Comma-delimited list of payment source ids: 1 = Manual Charge, 2 = Form Entry, 3 = Group Signup, 4 = Event Signup, 5 = Giving Portal, 6 = App, 7 = Text Giving, 8 = Position Signup, 9 = Data Entry, 10 = Invoice, 11 = Recurring Schedule, 12 = Import, 13 = Remote Deposit. Use -1 to include contributions with no source.

merchant

string

Comma-delimited list of merchant account ids. Use -1 to include contributions with no merchant account.

brand

string

Comma-delimited list of card brand ids: 0 = Unknown, 1 = ACH, 2 = Visa, 3 = MasterCard, 4 = Discover, 5 = American Express. Use -1 to include contributions with no brand.

amount.start

double

Return contributions of at least this amount.

amount.end

double

Return contributions of at most this amount.

confirmation

string

Return contributions whose confirmation number contains the given text.

notes

string

Return contributions whose notes contain the given text.

forBusiness

boolean

Whether the contribution is credited to a business (true) or not (false).

schedule

int32

≥ 1

The id of a recurring giving schedule. Returns only contributions created by that schedule.

business

int32

The id of a business the contributions are credited to.

campaign

string

Comma-delimited list of giving campaign ids. Returns contributions applied to pledges in those campaigns.

pledge

int32

≥ 1

The id of a pledge. Returns only contributions applied to that pledge.

pledgesOnly

boolean

Whether to return only contributions applied to a pledge (true) or only those that are not (false).

year

int32

Return contributions given in this calendar year.

gateway

boolean

Whether the contribution was processed through a payment gateway.

sms

boolean

Whether the contribution was given via text message.

scheduled

boolean

Whether the contribution was created by a recurring giving schedule.

deductible

boolean

Whether the contribution includes tax-deductible line items.

anonymous

boolean

Whether the contribution was given anonymously, with no giver name or linked profile (true), or not (false).

softCredit

boolean

Whether the contribution has soft credits.

checkNumber

string

Return contributions whose check number contains the given text.

name

string

Text matched against the giver's name and aliases. When multiple words are given, every word must match.

string

Return contributions whose giver's email address contains the given text.

phone

string

Return contributions whose giver's phone number contains the given digits.

envelope

int32

The envelope number assigned to the giver. Use -1 for givers with no envelope number.

person

int32

The id of the person the contributions are credited to.

unmatched

boolean

Return only contributions with a giver name that has not been linked to a person or business profile. Combine with ignored to filter by review status.

ignored

boolean

When unmatched is true, whether to return only contributions whose mismatch has been flagged to be ignored (true) or only those that have not (false).

unmatchedAll

boolean

Return all contributions not linked to a profile, regardless of whether their mismatch has been flagged to be ignored.

givingPortal

string

Comma-delimited list of giving portal ids. Use -1 to include contributions with no portal.

modified.start

date-time

Return contributions modified on or after this date.

modified.end

date-time

Return contributions modified on or before this date.

hasForm

boolean

Whether the contribution came from a form submission.

hasEvent

boolean

Whether the contribution's form submission is linked to an event.

Body Params

The ids to delete (or to exclude when include is false)

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!