/getActivity
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…
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 |
Return Values
* indicates data will always be returned
Contributor Object
Field | Type | Detail |
event_contributor_id* | number | Unique identifier for the event contributor |
contributor_id* | number | Unique identifier for the contributor |
event_id* | number | Event ID |
first_name* | text (50 char max) | Contributor first name |
last_name* | text (50 char max) | Contributor last name |
text | Contributor email address | |
cell | number | Contributor cell phone number |
alt_number | number | Contributor alternate phone number |
address1 | text (50 char max) | Contributor first line address |
address2 | text (50 char max) | Contributor second line address |
country | string | Contributor country |
city | text (50 char max) | Contributor city |
state | string | Contributor state |
zip | When Country=USA: 5 digits or 5+4 digits with a dash (12345-1234) All others: 10 characters | 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 (255 char max) | Company name |
merged_from | number | Original Event Contributor ID's that were merged to create this Event Contributor |
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 (no max) | Short description field of the package | null |
category_name | text (50 char max) | 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) |
purchase_amount* | decimal | Purchase price for a single quantity | Donation amount |
tax_amount* | decimal | Tax amount for the total purchase, if applicable | Tax amount for the total purchase, if applicable |
total_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 (50 char max) | null | Check Number | null |
masked_card | text (50 char max) | Masked credit card number | null | null |
cardholder_name | text (50 char max) | Cardholder name | null | null |
expiration_date | date | 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 |
sales | text | MU, DON, or BID + internal unique identifier for the sales associated with the payment | MU, DON, or BID + internal unique identifier for the sales associated with the payment | MU, DON, or BID + internal unique identifier for the sales associated with the payment |
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,
"merged_from": [
10101,
10102,
10103,
10104
],
"sales": [
{
"package_number": 1006,
"package_id": 14026,
"purchase_id": "MU57972",
"package_name": "Raffle Ticket",
"category_name": "Multi-Unit",
"type_name": "Multi-Unit",
"admissions": null,
"quantity": 2,
"purchase_amount": 250,
"tax_amount": 15.50,
"total_amount": 515.50,
"date": "/Date(1636663812860)/",
"value": 500,
"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,
"purchase_amount": 17.5,
"tax_amount": 0,
"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": 533,
"check_number": "",
"masked_card": "************4825",
"cardholder_name": "Testguy Wonderful",
"expiration_date": "12/2026",
"payment_date_time": "/Date(1636689012720)/",
"credit_card_type": "VISA"
"sales": [
"MU57972",
"DON79041"
[
}
]
}
How did we do?
