Account schedules

Learn how to use Suran API on the Suran Help Center.

>>>

GET /api/v2/pay/account_schedules SESSION
Get all account schedules within a date range

Headers

Header name Description
Cookie
required 		Login session cookie
Provision
required 		Web/Mobile/API Provision UUID

Params

Param name Description
start_date
required

lower bound for created date. Expects format YYYY-MM-DD

Validations:

  • Must be a String
end_date
required

upper bound for created date. Expects format YYYY-MM-DD

Validations:

  • Must be a String

Returns

Code: 200

Description:

account schedule

Param name Description
data
required

account schedule

Validations:

  • Must be a Hash
data[id]
required

ID of the account schedule

Validations:

  • Must be a number.
data[type]
required

Type of record

Validations:

  • Must be a String
data[attributes]
required

Attributes of the account schedule

Validations:

  • Must be a Hash
data[attributes][AccountScheduleGUID]
required

GUID of the account schedule

Validations:

  • Must be a String
data[attributes][DonorGUID]
required

guid of the donor

Validations:

  • Must be a String
data[attributes][FirstName]
required

guid of the account

Validations:

  • Must be a String
data[attributes][LastName]
required

guid of the account

Validations:

  • Must be a String
data[attributes][AccountGUID]
required

guid of the account

Validations:

  • Must be a String
data[attributes][RecurringType]
required

type of the recurring setup

Validations:

  • Must be a String
data[attributes][RecurringName]
required

type name of the recurring setup

Validations:

  • Must be a String
data[attributes][ScheduledDate]
required

next recurring date

Validations:

  • Must be a String
data[attributes][Quantity]
required

number of recurring setups

Validations:

  • Must be a String
data[attributes][TotalAmount]
required

total giving of recurring setups

Validations:

  • Must be a String
data[attributes][NumberOfDesignations]
required

number of designation_information

Validations:

  • Must be a String
data[attributes][Status]
required

status of the recurring setup

Validations:

  • Must be a String
data[attributes][StatusName]
required

status of the recurring setup

Validations:

  • Must be a String
data[attributes][Memo]
required

recurring setup memo

Validations:

  • Must be a String
data[attributes][CreateDateTime]
required

date entered of recurring setup

Validations:

  • Must be a String
data[attributes][designation_information]
required

Attributes of the designation_information

Validations:

  • Must be a Hash
data[attributes][designation_information][DesignationID]
required

designation id

Validations:

  • Must be a String
data[attributes][designation_information][DesignationGUID]
required

designation guid

Validations:

  • Must be a String
data[attributes][designation_information][DesignationName]
required

designation name

Validations:

  • Must be a String
data[attributes][designation_information][DesignationAmount]
required

designation amount

Validations:

  • Must be a String
data[attributes][designation_information][designationmemo]
required

designation memo

Validations:

  • Must be a String

Code: 401

Description:

Unauthorized

Param name Description
errors
required

Errors returned by request

Validations:

  • Must be an Array of nested elements
errors[error]
required

Why the request failed

Validations:

  • Must be a String
errors[status]
required

HTTP response code

Validations:

  • Must be a Integer

Code: 404

Description:

Not Found

Param name Description
errors
required

Errors returned by request

Validations:

  • Must be an Array of nested elements
errors[error]
required

Why the request failed

Validations:

  • Must be a String
errors[status]
required

HTTP response code

Validations:

  • Must be a Integer

Code: 422

Description:

Unprocessable Entity

Param name Description
errors
required

Errors returned by request

Validations:

  • Must be an Array of nested elements
errors[error]
required

Why the request failed

Validations:

  • Must be a String
errors[status]
required

HTTP response code

Validations:

  • Must be a Integer

Code: 500

Description:

Internal Server Error

Param name Description
errors
required

Errors returned by request

Validations:

  • Must be an Array of nested elements
errors[error]
required

Why the request failed

Validations:

  • Must be a String
errors[status]
required

HTTP response code

Validations:

  • Must be a Integer

Errors

Code Description
404 Data source query failed
422 Invalid parameter(s)
422 Provision header missing
422 Invalid provision
422 Under maintenance
422 Incorrect host for provision
422 Establishing session failed
422 Privilege to perform the action was not found
422 Not logged in
422 Provision does not match logged in provision
422 The start date or end date is invalid
422 Start date cannot be greater than the end date
500 No connection to data source