We understand and value the importance that nonprofits place on quality data and donor management. Your use of our online fundraising platform should enhance your data management and fundraising goals. Therefore, as part of our continuum of tools, we have developed an API to help you integrate the donor information in our system with your organization’s CRM.

Below is a description of our API for exporting donors and donation details to external CRMs, including Salesforce and others.

The API is a web service that can be found here:
https://www.israelgives.org/DonationAPI/DonationWebService.asmx?op=DonationsExport

It receives 4 parameters:

  1. User ID of client
  2. Password of client
  3. Start date
  4. End date

The data exported will be all the donors and their donations in the selected date range. The data will be exported using web services, and the result will be sent in the following structure:

<string xmlns="http://tempuri.org/">
<?xml version="1.0" encoding="UTF- 8"?>
<data>
<donors>
<donor>

<donor_id>1234</donor_id>
<donor_name_title>גברת</donor_name_title>
<donor_first_name><![CDATA[ישראלה ]]></donor_first_name>
<donor_last_name><![CDATA[ישראלי ]]></donor_last_name>
<donor_address><![CDATA[]]></donor_address>
<donor_address1><![CDATA[אלנבי]]></donor_address1>
<donor_address2><![CDATA[]]></donor_address2>
<donor_zip><![CDATA[64230]]></donor_zip>
<donor_city><![CDATA[תל אביב ]]></donor_city>
<donor_country_id>104</donor_country_id>
<donor_country_name>Israel</donor_country_name>
<donor_state_id></donor_state_id>
<donor_state_name></donor_state_name>
<donor_phone_code></donor_phone_code>
<donor_phone></donor_phone>
<donor_ssn>012345678</donor_ssn>
<donor_email><![CDATA[test@example.com]]></donor_email>
<donation>
<donation_item_id>12345</donation_item_id>
<transaction_date>31/21/2011 13:08:23.820</transaction_date>
<currency_id>1</currency_id>
<currency_name>NIS</currency_name>
<transaction_status_id>2</transaction_status_id>
<transaction_status_name>Complete</transaction_status_name>
<is_anonymous>False</is_anonymous>
<project_id>111</project_id>
<project_name><![CDATA[Fighting Cancer]]></project_name>
<sum>100.00000</sum>
<custom_field><![CDATA[]]></custom_field>
<recipient_name><![CDATA[]]></recipient_name>
<recipient_mail><![CDATA[]]></recipient_mail>
<receipt_I4U><![CDATA[]]></receipt_I4U>
<frequency>1</frequency>
<personal_message><![CDATA[]]></personal_message>
<is_honor><![CDATA[]></is_honor>
<represent_name><![CDATA[]]></represent_name>
<sender_name><![CDATA[]]></sender_name>
<country_short_name><![CDATA[]]></country_short_name>
<country_name_he><![CDATA[]]></country_name_he>
<country_name_en><![CDATA[]]></country_name_en>
<state_short_name><![CDATA[]]></state_short_name>
<state_name_en><![CDATA[]]></state_name_en>
<state_name_he><![CDATA[]]></state_name_he>
<ecard_city><![CDATA[]]></ecard_city>
<ecard_address><![CDATA[]]></ecard_address>
<ecard_zipcode><![CDATA[]]></ecard_zipcode>
<ecard_zipcode><![CDATA[]]></ecard_zipcode>
<comments><![CDATA[]]></comments>
<language_id></language_id>
<payment_transaction_id></payment_transaction_id>
<first_donation_to_amuta></first_donation_to_amuta>
<gb_gift_aid></gb_gift_aid>
<pfp_id></pfp_id>
<first_donation_of_recurring></first_donation_of_recurring>
<installments></installments>
 
</donation>
</donor>
</donors>
</data>
</string>

Comments:

  • Each value that is stored in the database as a number will have also the textual value of it (Country ID and Name, Status ID, and name)
  • Textual values entered by the donor will be sent in cdata wrapper.
  • donor_id – unique identifier of the donor
  • donation_item_id – unique identifier of donation
  • donor_ssn – teudat zehut
  • custom_field – a list of the requested custom fields, separated by the character ~
  • frequency – 1 – regular , 2 – monthly, 3  - annual
  • receipt_I4U – the number of the receipt as appears in invoice4u account
  • comments – text entered on the donation form , personal_message – text from ecard
  • first_donation_of_recurring – indication that this donation is recurring, and this was the first in the list (True/False)
  • Installments – no of installments (Tashlumim)

Export to json format
This method converts the xml into json format
https://www.israelgives.org/DonationAPI/DonationWebService.asmx?op=DonationsExportToJson

  • To preserve structure of json with arrays, if there are results then at least 2 donors items are created. If there is only one donor, then we create another empty one with donor_id = -2
  • To preserve structure of json with arrays, we always have 2 doantions under the donor, even if there is only one real one. So fake donation id will also be -2

Export of receipt file
https://www.israelgives.org/donationapi/DonationWebService.asmx?op=InvoiceExport
It receives 3 parameters:

  1. User ID of client
  2. Password of client
  3. Donation item id, as received previously in the xml.

The result is a byte array that represents serialization of the actual file.

Did this answer your question?