Specs

add(map(), map()) :: Breezex.Client.client_response()

Add a contribution record.

Valid keys for params map:

• date -- Date or DateTime
• person_id -- donor's Breeze ID. If unknown, use person or uid instead
• person -- struct including at least name and email or street_adress to be matched against Breeze DB
• uid -- unique ID provided by giving platform (which must be provided as processor)
• processor -- name of payment processor. Needed if using uid
• method -- payment method (check, cash, credit/debit online, credit/debit offline, donated goods, stock, direct deposit)
• funds -- struct for how to split donation %{name: "", amount: 123, id: "123"}. ID is optional and will take precedence over name.
• amount -- total donated. Must match total of what's in funds
• group -- all contributions with matching group numbers will be a single batch, so should be unique per batch. Will auto-increment to the next batch in series.
• batch_number -- batch number to import into
• batch_name -- name of the batch. Can be paired with either batch_number or group
• note -- optional note about contribution

Specs

add!(map(), map()) :: {map(), list()} | no_return()

Specs

advanced_search(map(), map()) :: Breezex.Client.client_response()

Contribution advanced search.

Accepts a map of search filters. Available keys are:

• start -- contributions on or after date, Date or DateTime object
• end -- contributions on or before date, Date or DateTime object
• person_id -- ID of person's contributions to fetch
• include_family -- boolean. include family members of person_id. Ignored if no person_id provided.
• min -- amount is greater than or equal
• max -- amount is less than or equal
• method_ids -- list of method IDs
• fund_ids -- list of fund IDs
• envelope -- envelope number
• batches -- list of batch numbers
• forms -- list of form IDs
• pledge_ids -- list of pledge campaign IDs

Specs

advanced_search!(map(), map()) :: {map(), list()} | no_return()

Specs

by_person(map(), integer()) :: Breezex.Client.client_response()

List the contributions by a person denoted by ID

Specs

by_person!(map(), integer()) :: {map(), list()} | no_return()

Specs

delete(map(), integer()) :: Breezex.Client.client_response()

Delete a contribution record by ID

Specs

delete!(map(), integer()) :: {map(), list()} | no_return()

Specs

edit(map(), integer(), map()) :: Breezex.Client.client_response()

Edit a contribution record. Requires a payment ID. Params are as in add/2

Specs

edit!(map(), integer(), map()) :: {map(), list()} | no_return()

Specs

for_pledge_campaign(map(), [integer()]) :: Breezex.Client.client_response()

List the contributions for pledge campaigns

Specs

for_pledge_campaign!(map(), [integer()]) :: {map(), list()} | no_return()

Specs

list_funds(map()) :: Breezex.Client.client_response()

List funds

Specs

list_funds!(map()) :: {map(), list()} | no_return()

Specs

list_funds_with_totals(map()) :: Breezex.Client.client_response()

List funds with totals

Specs

list_funds_with_totals!(map()) :: {map(), list()} | no_return()

Specs

over_amount(map(), integer()) :: Breezex.Client.client_response()

List the contributions greater than or equal to a certain amount

Specs

over_amount!(map(), integer()) :: {map(), list()} | no_return()

Specs

under_amount(map(), integer()) :: Breezex.Client.client_response()

List the contributions less than or equal to a certain amount

Specs

under_amount!(map(), integer()) :: {map(), list()} | no_return()

Specs

view(map(), integer()) :: Breezex.Client.client_response()

View a contribution record by ID

Specs

view!(map(), integer()) :: {map(), list()} | no_return()