everyaction.services.Contributions¶

class everyaction.services.Contributions(ea: EAClient)¶

Represents the Contributions service.

Methods

`adjust`(contribution_id, /, **kwargs)	See POST /contributions/{contributionId}/adjustments.
`attribution_types`()	See GET /contributions/attributionTypes.
`create`(**kwargs)	See POST /contributions.
`create_or_update_attribution`(...)	See PUT /contributions/{contributionId}/attributions/{vanId}.
`delete_attribution`(contribution_id, van_id, /)	See DELETE /contributions/{contributionId}/attributions/{vanId}.
`get`(contribution_id, /)	See GET /contributions/{contributionId}.
`get_`(alternate_id_type, alternate_id, /)	See GET /contributions/{alternateIdType}:{alternateId}.

adjust(contribution_id: int, /, **kwargs: EAValue) → AdjustmentResponse¶

See POST /contributions/{contributionId}/adjustments.

Parameters

contribution_id – The contributionId path parameter.
kwargs – The applicable query arguments and JSON data for the request. A Adjustment is appropriate to unpack here.

Returns

The resulting AdjustmentResponse object.

Keyword Arguments

adjustmentType (adjustment_type, type)
amount
datePosted (date_posted, posted)

attribution_types() → List[str]¶

See GET /contributions/attributionTypes.

Returns: List of the attribution types.

create(**kwargs: EAValue) → Contribution¶

See POST /contributions.

Parameters

kwargs – The applicable query arguments and JSON data for the request. A Contribution is appropriate to unpack here.

Returns

The created Contribution object.

Keyword Arguments

acceptedOneTimeAmount (accepted_one_time_amount, accepted_one_time)
acceptedRecurringAmount (accepted_recurring_amount, accepted_recurring, recurring)
amount
bankAccount (bank_account, account)
checkDate (check_date)
checkNumber (check_number)
codes (code (singular))
contact
contactAttributions (contact_attributions, attributions)
contributionBankAccount (contribution_bank_account, contribution_account, account_obj)
contributionId (contribution_id, contribution)
coverCostsAmount (cover_costs_amount, cover_costs)
dateReceived (date_received, received)
dateThanked (date_thanked, thanked)
depositDate (deposit_date)
depositNumber (deposit_number)
designation
directMarketingCode (direct_marketing_code, marketing_code)
disclosureFieldValues (disclosure_field_values, field_values, disclosures, values, disclosure (singular))
extendedSourceCode (extended_source_code, extended_source)
identifiers (identifier (singular))
isUpsellAccepted (is_upsell_accepted, upsell_accepted)
isUpsellShown (is_upsell_shown, upsell_shown)
linkedJointFundraisingContributionId (linked_joint_fundraising_contribution_id, joint_fundraising_contribution, fundraising_contribution, fundraising)
linkedPartnershipContributionId (linked_partnership_contribution_id, partnership_contribution, partnership)
notes
onlineReferenceNumber (online_reference_number, reference_number, ref_number)
paymentType (payment_type)
pledge
processedAmount (processed_amount)
processedCurrency (processed_currency)
selectedOneTimeAmount (selected_one_time_amount, selected_one_time)
status
upsellType (upsell_type, upsell)

create_or_update_attribution(contribution_id: int, van_id: int, /, **kwargs: EAValue) → None¶

See PUT /contributions/{contributionId}/attributions/{vanId}.

Parameters

contribution_id – The contributionId path parameter.
van_id – The vanId path parameter.
kwargs – The applicable query arguments and JSON data for the request. A Attribution is appropriate to unpack here.

Keyword Arguments