Get person contributions

get

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

Retrieve the donations and payments credited to the given person.

Required permission: Limited Read Contributions

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

person

int32

required

≥ 1

The id of the person.

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.

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.

schedule

int32

≥ 1

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

batch

int32

≥ 1

The id of a contribution batch.

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.

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.

softCredit

boolean

Whether the contribution has soft credits.

checkNumber

string

Return contributions whose check number 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