/getActivity
Updated
by
Jon Doehling
Get Activity API Call
The request will contain information about the activity of a specific event contributor, including contributor, sale and payment data.
Field | Detail |
event_contributor_id | Unique identifier for the contributor related to a specific event |
Contributor Object
Field | Type | Detail |
event_contributor_id | number | Unique identifier for the event contributor |
contributor_id | number | Unique identifier for the contributor |
first_name | text | Contributor first name |
last_name | text | Contributor last name |
text | Contributor email address | |
cell | number | Contributor cell phone number |
alt_number | number | Contributor alternate phone number |
address1 | text | Contributor first line address |
address2 | text | Contributor second line address |
country | text | Contributor country |
city | text | Contributor city |
state | text | Contributor state |
zip | text | Contributor zip/postal code |
contributor_types | string array | Contributor types for selected event contributor returned as array |
company_individual | string | Company or Individual designation |
company | text | Company name |
Sales Array
Field | Type | Multi-Unit Packages | General and Checkout Donations |
package_number | Number | Package number for the event | null |
package_id | number | Unique Package ID | null |
purchase_id | text | ‘MU’ + internal unique identifier for the sale | ‘DON’ + internal unique identifier for the sale |
package_name | text | Short description field of the package | null |
category_name | text | Name of the package category | null |
type_name | string | Name of the package type
| “Donation“ |
admissions | number | Total admissions (qty * admission per package) | 0 (zero) |
quantity | number | Quantity purchased | 1 (one) |
amount | number | Total sale including tax (qty * amt) | Donation Amount |
timestamp | timestamp | Date/time of the sale | Date/time of the sale |
value | number | Total value (qty * unit value) | 0 (zero) |
is_checkout_donation | boolean | always false | True for round-up and processing fee donations, otherwise, false. |
Payments Array
Field | Type | Credit Card | Check | Cash |
payment_id | number | Unique identifier | Unique identifier | Unique identifier |
bidder_number | number | Potentially shared identifier | Potentially shared identifier | Potentially shared identifier |
payment_type | string | “CREDIT CARD” | “CHECK” | “CASH” |
payment_amount | number | Amount field | Amount field | Amount field |
check_number | text | null | Check Number | null |
masked_card | text | Masked credit card number | null | null |
cardholder_name | text | Cardholder name | null | null |
expiration_date | text | Expiration date field | null | null |
payment_date_time | timestamp | Date/time of the payment | Date/time of the payment | Date/time of the payment |
credit_card_type | string | VISA, DSC, AMEX or MC | null | null |
Sample Call
{
"event_contributor_id": 63258,
"contributor_id": 33558,
"event_id": 2374,
"first_name": "Testguy",
"last_name": "Wonderful",
"email": "test@aes.com",
"cell": "(555) 555-5555",
"alt_number": "(444) 444-4444",
"address": "123 Fake Street",
"address2": "Apt 2",
"city": "Ladera Ranch",
"state": "California",
"country": "United States of America",
"zip": "92694",
"contributor_types": [
"Patron",
"Online"
],
"company_individual": "individual",
"company": null,
"sales": [
{
"package_number": 1006,
"package_id": 14026,
"purchase_id": "MU57972",
"package_name": "$500 Donation",
"category_name": "Multi-Unit",
"type_name": "Donation",
"admissions": null,
"quantity": 1,
"total_amount": 500,
"date": "/Date(1636663812860)/",
"value": null,
"is_checkout_donation": false
},
{
"package_number": null,
"package_id": null,
"purchase_id": "DON79041",
"package_name": "General Donation",
"category_name": null,
"type_name": "Donation",
"admissions": null,
"quantity": 1,
"total_amount": 17.5,
"date": "/Date(1636663813190)/",
"value": null,
"is_checkout_donation": true
}
],
"payments": [
{
"payment_id": 5715,
"bidder_number": 10036,
"payment_type": "CREDIT CARD",
"payment_amount": 517.5,
"check_number": "",
"masked_card": "************4825",
"cardholder_name": "Testguy Wonderful",
"expiration_date": "12/2026",
"payment_date_time": "/Date(1636689012720)/",
"credit_card_type": "VISA"
}
]
}
