API Reference
  1. One Church Software API
  2. Contributions

Move contributions

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

Move contributions from one batch into another. The contributions to move are taken from the source batch (the required batch filter) and narrowed by any other filters. Provide ids, or explicitly set include to false to move every matching contribution out of the source batch; an empty body is rejected. Only manually-entered contributions can be moved, and the destination batch cannot be a gateway batch.

Required permission: Limited Write Contributions

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string

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

string

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

string

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

date-time

Return contributions given on or after this date and time.

date-time

Return contributions given on or before this date and time.

string

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

string

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

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.

string

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

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.

double

Return contributions of at least this amount.

double

Return contributions of at most this amount.

string

Return contributions whose confirmation number contains the given text.

string

Return contributions whose notes contain the given text.

boolean

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

int32
≥ 1

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

int32
required
≥ 1

The id of the batch to move contributions out of (the source batch). Required.

int32

The id of a business the contributions are credited to.

string

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

int32
≥ 1

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

boolean

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

int32

Return contributions given in this calendar year.

boolean

Whether the contribution was processed through a payment gateway.

boolean

Whether the contribution was given via text message.

boolean

Whether the contribution was created by a recurring giving schedule.

boolean

Whether the contribution includes tax-deductible line items.

boolean

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

boolean

Whether the contribution has soft credits.

string

Return contributions whose check number contains the given text.

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.

string

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

int32

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

int32

The id of the person the contributions are credited to.

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.

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).

boolean

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

string

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

date-time

Return contributions modified on or after this date.

date-time

Return contributions modified on or before this date.

boolean

Whether the contribution came from a form submission.

boolean

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

Body Params

The ids to move (or to exclude when include is false) and the destination batch

int32 | null
required

The id of the batch to move the selected contributions into (the destination batch).

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
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.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses
200

OK

401

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

Updated about 2 months ago

Did this page help you?
Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
text/plain
application/json
text/json

Updated about 2 months ago

Did this page help you?