In This Article:

    "donation" object

    In This Article:

      About the donation object

      The donation object is used to store information about a single donation received via Salsa.  Donation records are written by Salsa when

      • A donor uses a donation page to make a donation.
      • A campaign manager enters a donation manually.
      • An event attendee pays event fees.
      • A purchaser buys merchandise from a Salsa Storefront.
      • An application uses the API to save a donation record.

      Warnings

      1. Salsa does not process a credit card transaction via the API. That means that creating forms on other websites to save donations records to Salsa will *just* save records.
      2. Salsa does not allow full credit card numbers to be saved in a donation record. Salsa itself only saves first four and last four purely for identification reasons.
      3. Salsa does not allow CVV2 numbers to be saved in a donation record.
      4. See the table for other field-related notes.

      Format notes

      • Salsa timestamps are encoded as "YYYY-MM-DD HH:MM:SS", where all elements are numeric and "HH" is on a 24 hour clock.
      • Salsa timestamps are in the "America/NewYork" timezone (GMT-5), aka Eastern Standard Time (EST) or Eastern Daylight Savings Time (EDT).

      Fields

      Name Type Null? Notes
      donation_KEY int YES Primary key, assigned by Salsa
      supporter_KEY int NO (Required) Primary key for the supporter making the donation
      event_KEY int NO Primary key for an event that charges fees, typically null
      donate_page_KEY int NO Primary key for the donation page used to collect the donation
      recurring_donation_KEY int NO For payment donations, link to recurring_donation record
      membership_invoice_KEY int NO For membership package, used rarely
      Last_Modified timestamp YES Timestamp for last modification. Updated by Salsa on any update to the record. See "Format notes" (above)
      Transaction_Date timestamp YES Timestamp for the time that a donation was sent to the gateway See "Format notes" (above)
      Date_Entered date NO Date that a donation was entered manually (i.e. via Salsa HQ)
      amount decimal NO Number of dollars. Positive is a deposit to the client. Negative is a refund from the client.
      Currency_Code varchar(3) NO Currency code from ISO 4217.
      Salsa submits this field to the merchant gateway for payment.
      A null Currency_Code is interpreted as US Dollars (USD) Salsa stores the original value of the donation.
      No currency conversions.
      Transaction_Type enum NO 'Donation'
      'Purchase'
      'Payment'
      'Recurring'
      'Other'
      'New Member'
      'Renewal'
      'Gift Membership'
      'Event Fee'
      'Publication Purchase'
      'Testing'
      'Refund'
      'In-Kind'
      Form_Of_Payment enum NO Credit Card'
      'Check'
      'Cash'
      'Other'
      'Unknown'
      cc_type varchar(32) NO (Optional) credit card type, typically one of
      'visa'- Vista
      'mc'- Master Card
      'amex'- American Express
      'disc'- Discover
      Credit_Card_Digits varchar(16) NO Important: See "Notes" above.
      Credit_Card_Expiration varchar(5) NO Date as MM/YYYY
      PNREF varchar(128) NO Returned by the gateway for a successful donation
      RESULT int NO These are the values that Salsa saves:
      0 indicates a successful online donation
      -1 indicates either a successful donation via the UI or a test donation
      other all other values indicate errors"
      RESPMSG varchar(255) NO Response returned from the gateway. Will contain an error message (e.g. 'Declined') if the transaction fails.
      AUTHCODE varchar(8) NO (Unknown)
      AVS varchar(10) NO (Unknown)
      Order_Info mediumtext NO

      Order_Info is a comma-separated list of purchased items, most typically generated by a Salsa Storefront

      Items are not in HTML, and look really ugly in a web page or email.

      16,777,215 bytes

      Status enum NO Donation Only'
      'New Order'
      'Order Pending'
      'Order Fulfilled'
      'Transaction Failed'
      'Refunded'
      'Event Fee'
      Disbursement_Status enum NO Unknown'
      'In Account'
      'Disbursed'
      'Refunded'
      'Other'
      Responsible_Party varchar(255) NO (Unknown)
      Date_Fulfilled date NO Date that a payment for goods or services was fulfilled. Rarely used. See "Format notes" (above)
      PRIVATE_Complete_Summary blob NO

      (Salsa Only) JSON blob containing details of the donation record created by Salsa.

      Not for public consumption!

      First_Name varchar(64) NO Name on the front of the credit card.
      Last_Name varchar(64) NO Name on the front of the credit card.
      Email varchar(255) NO Generally required by merchant gateway.
      Tracking_Code varchar(64) NO Organizational specific tracking code for the donation
      Donation_Tracking_Code varchar(64) NO Donation_Tracking_Code contains the value of "Tracking_Code" at the time that the donation record is created.
      Tax_Status enum NO Unknown'
      'C3'
      'C4'
      'C5'
      'C6'
      '527'
      'PAC'
      Designation_Code varchar(128) NO (Optional) field set by the organization. Typically used for tracking or accounting reasons.
      PRIVATE_Donation_Source enum NO (Salsa Only)DIA'
      'Other'
      Note mediumtext NO (Optional) note, typically displayed in an HTML text area. 16,777,215 bytes
      Thank_You_Sent tinyint NO Boolean (0,1} set by a campaign manager and is not set automatically by Salsa.
      Thank_Date date NO Thank_Date is set by the campaign manager. Salsa does not automatically send reciepts or thank you messages.
      referral_supporter_KEY int NO (Unknown)
      merchant_account_KEY int NO Merchant gateway used to process this donation.
      IP_Address varchar(16) NO IP address that submitted the donation.
      In_Honor_Name varchar(128) NO In honor full name.
      In_Honor_Email varchar(128) NO In honor email.
      In_Honor_Address mediumtext NO In honor address. 16,777,215 bytes
      uid varchar(16) NO

      (Optional) External primary key provided by the organization.

      Salsa reads this key to locate matching donation records during imports.

      External applications can use this key to synch existing records.

      Batch_Code varchar(16) NO (Optional) key to denote a processing batch. Particularly useful if an organization processes a lot of paper checks.
      VARCHAR0 varchar(64) NO (Optional) field not used by Salsa, typically used to store extra stuff in the donation record
      VARCHAR1 varchar(64) NO (Optional) field not used by Salsa, typically used to store extra stuff in the donation record
      VARCHAR2 varchar(64) NO (Optional) field not used by Salsa, typically used to store extra stuff in the donation record
      In_Memory_Name varchar(128) NO In memory of name
      event_fee_KEY int NO The event fee associated with the event_KEY (above). The event fee defines the amount and describes the fee.
      Employer varchar(64) NO (Optional) employer. Has been used by merchant gateways in the past.
      Occupation varchar(64) NO (Optional) occupation. Has been used by merchant gateways in the past.
      Employer_Street varchar(64) NO (Optional)Employer address info. Sometimes used to track donations by a person on behalf of a company.
      Employer_Street_2 varchar(64) NO (Optional)Employer address info. Sometimes used to track donations by a person on behalf of a company.
      Employer_City varchar(32) NO (Optional)Employer address info. Sometimes used to track donations by a person on behalf of a company.
      Employer_State varchar(32) NO (Optional)Employer address info. Sometimes used to track donations by a person on behalf of a company.
      Employer_Zip varchar(16) NO (Optional)Employer address info. Sometimes used to track donations by a person on behalf of a company.
      salesforce_id varchar(16) NO ID in SalsesForce
       
      Was this article helpful?
      0 out of 0 found this helpful
      Have more questions? Submit a request

      Comments

      0 comments

      Please sign in to leave a comment.