🔁 Schedules

When a donor is making a donation they can have the option to make a recurring payment monthly, quarterly or yearly. This will continue to take a donation at the chosen frequency. This is referred to a schedule and will have a unique 'scheduleId'.

A schedule can be created on a personal fundraising page, team fundraising page, event page or charity page.

The following table contains the fields that are returned within the response call of the schedules page endpoint.

Key	Label	Type	Description
supporterId	Supporter Id	Long	Supporter Id - will be blank of the payment was marked as Anonymous
schedulesId	Schedules Id	Long	Schedules Id
amount	Amount	Long	Amount
email	Email	String	Email
createdOn	Created On	Date	Date schedule created
endDate	End Date	Date	End date of schedule
status	Status	String	Status
frequency	Frequency	String	Frequency
pfId	Personal Fundraising Id	Long	Personal fundraising Id
teamId	Team Id	Long	Team Id
eventPageId	Event Page Id	Long	Event page Id
charityAccountGuid	Charity Account Guid	UUID	Charity account GUID
charityId	Charity Id	Long	Charity Id
companyId	Company Id	Long	Company Id
companyAccountGuid	Company Account Guid	UUID	Company account GUID
lastUpdatedDate	Last Updated Date	Date	Date schedule was last updated

🚀Search schedule donation records

/schedules

Returns a list of schedules within your account filterable by the attributes below.

Key	Label	Type	Description
campaign_guids	Campaign Guids	Array[string]	Campaign GUID associated with the schedule
event_ids	Event Ids	Array[Long]	Event Ids associated with the schedules object
date_from	Date From	String	Date from which to filter based on the creation date of the schedule
date_to	Date To	String	Date to filter to based on the creation date of the schedule
new_schedules_only	New Schedules Only	Boolean	Used in conjunction with date filters, if set to true will filter using createdOn, otherwise will use both createdOn and lastUpdatedAt (defaults to false)
limit	Limit	Integer	Number of records to be returned in the response
page	Page	Integer	The number of pages to skip before starting to collect the result set

Sample Request

GET - http://dataapi.enthuse.com/schedule?access_token=rR5_kQN_TVZMwqz4tyc8vzJ0ltc
&campaign_guids=00000000-0000-0000-0000-000000000000
&date_from=2020-02-25%2000%3A00%3A00
&date_to=2020-03-01%2000%3A00%3A00
&limit=25
&page=1

Sample Responses:

200 - OK call was successful and returned data

{
    "createdOn": "2022-08-04T15:32:17.297Z",
    "endDate": "2022-08-04T15:32:17.297Z",
    "supporterId": 7236487,
    "schedulesId": 7236487,
    "amount": 0,
    "email": "string",
    "status": "string",
    "frequency": "string",
    "pfId": 7236487,
    "teamId": 7236487,
    "eventPageId": 7236487,
    "campaign_guid": "d290f1ee-6c54-4b01-90e6-d701748f0851",
    "charityAccountGuid": "d290f1ee-6c54-4b01-90e6-d701748f0851",
    "charityId": 7236487,
    "companyId": 7236487,
    "companyAccountGuid": "d290f1ee-6c54-4b01-90e6-d701748f0851"
    "lastUpdatedData": "2022-05-17T12:00:00.0000000Z"
}

401 - Access token has expired or is incorrect

{
    "createdOn": "2022-08-04T15:32:17.297Z",
    "endDate": "2022-08-04T15:32:17.297Z",
    "supporterId": 7236487,
    "schedulesId": 7236487,
    "amount": 0,
    "email": "string",
    "status": "string",
    "frequency": "string",
    "pfId": 7236487,
    "teamId": 7236487,
    "eventPageId": 7236487,
    "campaign_guid": "d290f1ee-6c54-4b01-90e6-d701748f0851",
    "charityAccountGuid": "d290f1ee-6c54-4b01-90e6-d701748f0851",
    "charityId": 7236487,
    "companyId": 7236487,
    "companyAccountGuid": "d290f1ee-6c54-4b01-90e6-d701748f0851"
    "lastUpdatedData": "2022-05-17T12:00:00.0000000Z"
}

403 - The account linked to the token does not match the account of the records attempting to retrieve

{
  "message": "Forbidden.",
  "status": 403
}

404 - Call authenticated but no records match the searched criteria

{
  "message": "No records found.",
  "status": 404
}

416 - Call authenticated but both eventId and campaignGuid used together

{
  "message": "eventId and campaignGuid cannot be used in unison",
  "status": 416
}

500 - Error occurred within Service, data could not be returned

{
  "message": "Internal Server Error.",
  "status": 500
}

🚀 Search for a specific schedule

/schedule/{schedule_id}

Get a schedule with a known Schedule ID.

Key	Label	Type	Description
schedule_id	Schedule Id	String	Schedule Id

Sample Request

GET - http://dataapi.enthuse.com/schedules/1234?access_token=rR5_kQN_TVZMwqz4tyc8vzJ0ltc

Sample Responses:

200 - OK call successful and returned data

{
  "amount": 0,
  "charityAccountGuid": "d290f1ee-6c54-4b01-90e6-d701748f0851",
  "charityId": 7236487,
  "companyAccountGuid": "d290f1ee-6c54-4b01-90e6-d701748f0851",
  "companyId": 7236487,
  "createdOn": "2020-01-01 00:00:00",
  "email": "string",
  "endDate": "2020-01-01 00:00:00",
  "eventPageId": 7236487,
  "frequency": "string",
  "pfId": 7236487,
  "schedulesId": 7236487,
  "status": "string",
  "supporterId": 7236487,
  "teamId": 7236487
  "lastUpdatedData": "2022-05-17T12:00:00.0000000Z"
}

401 - Access token has expired or is incorrect

{
  "message": "Unauthorized.",
  "status": 401
}

403 - The account linked to the token does not match the account of the records attempting to retrieve

{
  "message": "Forbidden.",
  "status": 403
}

404 - Call authentication but no records match the searched criteria

{
  "message": "No records found.",
  "status": 404
}

500 - Error occurred within Service, data could not be returned

{
  "message": "Internal Server Error.",
  "status": 500
}