Check gift reports

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

>>>

GET /api/v2/pay/check_gift_reports SESSION
Report gifts within 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 entry date. Expects format YYYY-MM-DD

Validations:

  • Must be a String
end_date
required

Upper bound for entry date. Expects format YYYY-MM-DD

Validations:

  • Must be a String

Returns

Code: 200

Description:

Gift Reports

Param name Description
data
required

check gift report

Validations:

  • Must be a Hash
data[id]
required

ID of the giving detail

Validations:

  • Must be a number.
data[attributes]
required

Attributes of the check gift report

Validations:

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

giving detail check number

Validations:

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

giving detail gift date

Validations:

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

deposit date

Validations:

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

giving fund id

Validations:

  • Must be a number.
data[attributes][Designation]
required

giving fund designation

Validations:

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

giving detail contreference

Validations:

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

giving unit email address

Validations:

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

giving unit name

Validations:

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

giving unit id

Validations:

  • Must be a number.
data[attributes][EntryDate]
required

giving detail offering date

Validations:

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

giving detail fundamount

Validations:

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

giving detail givingnote

Validations:

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

giving detail depositid

Validations:

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

gift type

Validations:

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

zip code

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