List Recurring Donors

This request retrieves a list of accounts who have recurring donation records. You can use this to search for upcoming donations or find donors whose credit cards are expiring soon.

REST

Request

https://api.neoncrm.com/neonws/services/api/donation/listRecurringDonors?userSessionId=T1361518584807&responseType=json&donorSearch.setupDateFrom=2012-09-31&donorSearch.setupDateTo=2013-02-22&donorSearch.nextRecurringDateFrom=2012-12-01&donorSearch.nextRecurringDateTo=2012-12-31&donorSearch.cardExpirationDateFrom=2012-06-21&donorSearch.cardExpirationDateTo=2014-01-01&donorSearch.status=Active&page.pageSize=5

Response

{
    "listRecurringDonors": {
        "operationResult": "SUCCESS",
        "responseMessage": "list recurring donors success",
        "responseDateTime": "2013-02-22T01:41:47.608-06:00",
        "recurringDonors": {
            "recurringDonor": [
                {
                    "donorId": 100574,
                    "donorName": "test 1125b",
                    "amount": 121,
                    "frequency": "1 MONTH",
                    "nextDate": "2012-12-22-06:00"
                },
                {
                    "donorId": 123582,
                    "donorName": "Ralf 091101",
                    "amount": 111,
                    "frequency": "1 MONTH",
                    "nextDate": "2012-12-22-06:00"
                }
            ]
        },
        "page": {
            "currentPage": 1,
            "pageSize": 5,
            "totalPage": 1,
            "totalResults": 2
        }
    }
}

SOAP

Request

<soapenv:envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:neon="http://www.z2systems.com/schemas/neonws/">
   <soapenv:header>
       <soapenv:body>
          <neon:listrecurringdonorsrequest>
             <usersessionid>T1361758244044</usersessionid>
            <donorsearch>
                <setupdatefrom>2012-09-30</setupdatefrom>
                <setupdateto>2013-02-22</setupdateto>
                <nextrecurringdatefrom>2012-12-01</nextrecurringdatefrom>
                <nextrucurringdateto>2012-12-31</nextrucurringdateto>
                <cardexpirationdatefrom>2012-06-21</cardexpirationdatefrom>
                <cardexpirationdateto>2014-01-01</cardexpirationdateto>
                <status>Active</status>
             </donorsearch>
            <page>
                <currentpage>1</currentpage>
                <pagesize>20</pagesize>
              </page>
          </neon:listrecurringdonorsrequest>
       </soapenv:body>
    </soapenv:header>
</soapenv:envelope>

Response

<soap:envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
   <soap:body>
      <ns2:listrecurringdonorsresponse xmlns:ns2="http://www.z2systems.com/schemas/neonws/">
         <operationresult>SUCCESS</operationresult>
         <responsemessage>list recurring donors success</responsemessage>
         <responsedatetime>2013-02-24T20:17:59.051-06:00</responsedatetime>
         <recurringdonors>
            <recurringdonor>
               <donorid>100574</donorid>
               <donorname>test 1125b</donorname>
               <amount>121.0</amount>
               <frequency>1 MONTH</frequency>
               <nextdate>2012-12-22-06:00</nextdate>
            </recurringdonor>
            <recurringdonor>
               <donorid>123582</donorid>
               <donorname>Ralf 091101</donorname>
               <amount>111.0</amount>
               <frequency>1 MONTH</frequency>
               <nextdate>2012-12-22-06:00</nextdate>
            </recurringdonor>
         </recurringdonors>
         <page>
            <currentpage>1</currentpage>
            <pagesize>20</pagesize>
            <totalpage>1</totalpage>
            <totalresults>2</totalresults>
         </page>
      </ns2:listrecurringdonorsresponse>
   </soap:body>
</soap:envelope>

Request Parameters

Name	Required	Description
donorSearch.setupDateFrom		Find recurring donors based on the date their recurring donation was first set up. Format: 2012-09-31
donorSearch.setupDateTo
donorSearch.nextRecurringDateFrom		Find recurring donors based on the date of their next scheduled donation. Format: 2012-09-31
donorSearch.nextRecurringDateTo
donorSearch.cardExpirationDateFrom		Find recurring donors based on the date their credit card will expire. Format: 2012-09-31
donorSearch.cardExpirationDateTo
donorSearch.status		Possible values: Active, Inactive
page.currentPage
page.pageSize
page.totalPage
page.totalResults
page.sortColumn
page.sortDirection

Response Parameters

Name	Required	Description
recurringDonor.donorId		Account ID of the donor
recurringDonor.donorName		Name of Donor
recurringDonor.amount		Recurring Donation Amount
recurringDonor.frequency		Frequency of recurring donation
recurringDonor.nextDate		Next scheduled date for recurring donation