Giving detail

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

>>>

GET /api/v2/deposit_detail_designation_detail_with_contact_info
Returns details about deposits, their designations, and the contact information for their respective donors

Params

Param name Description
start_date
required

Start Deposit Date

Validations:

  • Must be a String
end_date
required

End Deposit Date

Validations:

  • Must be a String
include_pending
optional

Include Pending Deposits

Validations:

  • Must be one of: true, false.

Returns

Code: 200

Description:

Deposit Detail Designation Detail With Contact Info

Param name Description
response
required

Response for deposit detail designation detail with contact info

Validations:

  • Must be a Hash
response[deposit_id]
required

ID of the deposit

Validations:

  • Must be a String
response[transaction_date]
required

Date of the transaction

Validations:

  • Must be a String
response[deposit_date]
required

Date of the deposit

Validations:

  • Must be a String
response[transaction_id]
required

ID of the transaction

Validations:

  • Must be a String
response[allocation_id]
required

ID of the allocation

Validations:

  • Must be a String
response[donor_id]
required

ID of the Donor

Validations:

  • Must be a number.
response[donor_first_name]
required

Donor’s first name

Validations:

  • Must be a String
response[donor_last_name]
required

Donor’s last name

Validations:

  • Must be a String
response[address1]
required

Address line 1

Validations:

  • Must be a String
response[address2]
required

Address line 2

Validations:

  • Must be a String
response[address3]
required

Address line 3

Validations:

  • Must be a String
response[city]
required

Address city

Validations:

  • Must be a String
response[state]
required

Address state

Validations:

  • Must be a String
response[zip]
required

Address zip code

Validations:

  • Must be a String
response[phone]
required

Phone number

Validations:

  • Must be a String
response[email_address]
required

Email Address

Validations:

  • Must be a String
response[amount]
required

Amount of the transaction

Validations:

  • Must be a String
response[fee_amount]
required

Amount of the transaction fee

Validations:

  • Must be a String
response[net_amount]
required

Amount of both the transaction and fee

Validations:

  • Must be a String
response[status]
required

Status of the transaction

Validations:

  • Must be a String
response[account_type]
required

Type of account

Validations:

  • Must be a String
response[payment_type]
required

Type of payment

Validations:

  • Must be a String
response[designation_id]
required

ID of the designation

Validations:

  • Must be a number.
response[designation]
required

Designation

Validations:

  • Must be a String
response[designation_memo]
required

Memo of the Designation

Validations:

  • Must be a String
response[main_memo]
required

Main Memo

Validations:

  • Must be a String

Examples

GET /api/v2/deposit_detail_designation_detail_with_contact_info
422
{
  "errors": [
    {
      "error": "Start date cannot be greater than the end date.",
      "status": 422
    }
  ]
}
GET /api/v2/deposit_detail_designation_detail_with_contact_info
422
{
  "errors": [
    {
      "error": "Invalid parameter(s)",
      "status": 422
    }
  ]
}
GET /api/v2/deposit_detail_designation_detail_with_contact_info
200
{
  "response": [
    {
      "deposit_id": "1206200",
      "transaction_date": "2014-09-14",
      "deposit_date": "2021-04-01",
      "transaction_id": "P114",
      "allocation_id": "P269",
      "donor_id": 0,
      "donor_first_name": "",
      "donor_last_name": "",
      "address1": "",
      "address2": "",
      "address3": "",
      "city": "",
      "state": "",
      "zip": "",
      "phone": "",
      "email_address": "",
      "amount": "2758.0",
      "fee_amount": "86.62",
      "net_amount": "2671.38",
      "status": "",
      "account_type": "",
      "designation_id": 6,
      "designation": "Memorial",
      "designation_memo": "",
      "main_memo": "Test gift"
    },
    {
      "deposit_id": "1206200",
      "transaction_date": "2021-06-11",
      "deposit_date": "2022-03-24",
      "transaction_id": "2053",
      "allocation_id": "2783",
      "donor_id": 1,
      "donor_first_name": "Pablo & Paula",
      "donor_last_name": "*Manning",
      "address1": "305 Crossfield Drive 3",
      "address2": "",
      "address3": "",
      "city": "Big City",
      "state": "KY",
      "zip": "40383",
      "phone": "",
      "email_address": "jasen@suran.com",
      "amount": "442.0",
      "fee_amount": "14.36",
      "net_amount": "427.64",
      "status": "",
      "account_type": "",
      "designation_id": 119,
      "designation": "Overseas Ministries",
      "designation_memo": "",
      "main_memo": ""
    },
    {
      "deposit_id": "1206201",
      "transaction_date": "2021-07-11",
      "deposit_date": "2022-03-24",
      "transaction_id": "P2054",
      "allocation_id": "P2784",
      "donor_id": 1,
      "donor_first_name": "Pablo & Paula",
      "donor_last_name": "*Manning",
      "address1": "305 Crossfield Drive 3",
      "address2": "",
      "address3": "",
      "city": "Big City",
      "state": "KY",
      "zip": "40383",
      "phone": "",
      "email_address": "jasen@suran.com",
      "amount": "442.0",
      "fee_amount": "14.36",
      "net_amount": "427.64",
      "status": "",
      "account_type": "",
      "designation_id": 119,
      "designation": "Overseas Ministries",
      "designation_memo": "",
      "main_memo": ""
    }
  ]
}
GET /api/v2/deposit_detail_designation_detail_with_contact_info
200
{
  "response": [
    {
      "deposit_id": "1206200",
      "transaction_date": "2014-09-14",
      "deposit_date": "2021-04-01",
      "transaction_id": "P114",
      "allocation_id": "P269",
      "donor_id": 0,
      "donor_first_name": "",
      "donor_last_name": "",
      "address1": "",
      "address2": "",
      "address3": "",
      "city": "",
      "state": "",
      "zip": "",
      "phone": "",
      "email_address": "",
      "amount": "2758.0",
      "fee_amount": "86.62",
      "net_amount": "2671.38",
      "status": "",
      "account_type": "",
      "designation_id": 6,
      "designation": "Memorial",
      "designation_memo": "",
      "main_memo": "Test gift"
    },
    {
      "deposit_id": "1206200",
      "transaction_date": "2021-06-11",
      "deposit_date": "2022-03-24",
      "transaction_id": "2053",
      "allocation_id": "2783",
      "donor_id": 1,
      "donor_first_name": "Pablo & Paula",
      "donor_last_name": "*Manning",
      "address1": "305 Crossfield Drive 3",
      "address2": "",
      "address3": "",
      "city": "Big City",
      "state": "KY",
      "zip": "40383",
      "phone": "",
      "email_address": "jasen@suran.com",
      "amount": "442.0",
      "fee_amount": "14.36",
      "net_amount": "427.64",
      "status": "",
      "account_type": "",
      "designation_id": 119,
      "designation": "Overseas Ministries",
      "designation_memo": "",
      "main_memo": ""
    }
  ]
}
GET /api/v2/deposit_detail_designation_detail_with_contact_info
422
{
  "errors": [
    {
      "error": "Start date cannot be greater than the end date.",
      "status": 422
    }
  ]
}
GET /api/v2/deposit_detail_designation_detail_with_contact_info
422
{
  "errors": [
    {
      "error": "Invalid parameter(s)",
      "status": 422
    }
  ]
}
GET /api/v2/deposit_detail_designation_detail_with_contact_info
200
{
  "response": [
    {
      "deposit_id": "1206200",
      "transaction_date": "2014-09-14",
      "deposit_date": "2021-04-01",
      "transaction_id": "P114",
      "allocation_id": "P269",
      "donor_id": 0,
      "donor_first_name": "",
      "donor_last_name": "",
      "address1": "",
      "address2": "",
      "address3": "",
      "city": "",
      "state": "",
      "zip": "",
      "phone": "",
      "email_address": "",
      "amount": "2758.0",
      "fee_amount": "86.62",
      "net_amount": "2671.38",
      "status": "",
      "account_type": "",
      "designation_id": 6,
      "designation": "Memorial",
      "designation_memo": "",
      "main_memo": "Test gift"
    },
    {
      "deposit_id": "1206200",
      "transaction_date": "2021-06-11",
      "deposit_date": "2022-03-24",
      "transaction_id": "2053",
      "allocation_id": "2783",
      "donor_id": 1,
      "donor_first_name": "Pablo & Paula",
      "donor_last_name": "*Manning",
      "address1": "305 Crossfield Drive 3",
      "address2": "",
      "address3": "",
      "city": "Big City",
      "state": "KY",
      "zip": "40383",
      "phone": "",
      "email_address": "jasen@suran.com",
      "amount": "442.0",
      "fee_amount": "14.36",
      "net_amount": "427.64",
      "status": "",
      "account_type": "",
      "designation_id": 119,
      "designation": "Overseas Ministries",
      "designation_memo": "",
      "main_memo": ""
    }
  ]
}
GET /api/v2/deposit_detail_designation_detail_with_contact_info
200
{
  "response": [
    {
      "deposit_id": "1206200",
      "transaction_date": "2014-09-14",
      "deposit_date": "2021-04-01",
      "transaction_id": "P114",
      "allocation_id": "P269",
      "donor_id": 0,
      "donor_first_name": "",
      "donor_last_name": "",
      "address1": "",
      "address2": "",
      "address3": "",
      "city": "",
      "state": "",
      "zip": "",
      "phone": "",
      "email_address": "",
      "amount": "2758.0",
      "fee_amount": "86.62",
      "net_amount": "2671.38",
      "status": "",
      "account_type": "",
      "designation_id": 6,
      "designation": "Memorial",
      "designation_memo": "",
      "main_memo": "Test gift"
    },
    {
      "deposit_id": "1206200",
      "transaction_date": "2021-06-11",
      "deposit_date": "2022-03-24",
      "transaction_id": "2053",
      "allocation_id": "2783",
      "donor_id": 1,
      "donor_first_name": "Pablo & Paula",
      "donor_last_name": "*Manning",
      "address1": "305 Crossfield Drive 3",
      "address2": "",
      "address3": "",
      "city": "Big City",
      "state": "KY",
      "zip": "40383",
      "phone": "",
      "email_address": "jasen@suran.com",
      "amount": "442.0",
      "fee_amount": "14.36",
      "net_amount": "427.64",
      "status": "",
      "account_type": "",
      "designation_id": 119,
      "designation": "Overseas Ministries",
      "designation_memo": "",
      "main_memo": ""
    },
    {
      "deposit_id": "1206201",
      "transaction_date": "2021-07-11",
      "deposit_date": "2022-03-24",
      "transaction_id": "P2054",
      "allocation_id": "P2784",
      "donor_id": 1,
      "donor_first_name": "Pablo & Paula",
      "donor_last_name": "*Manning",
      "address1": "305 Crossfield Drive 3",
      "address2": "",
      "address3": "",
      "city": "Big City",
      "state": "KY",
      "zip": "40383",
      "phone": "",
      "email_address": "jasen@suran.com",
      "amount": "442.0",
      "fee_amount": "14.36",
      "net_amount": "427.64",
      "status": "",
      "account_type": "",
      "designation_id": 119,
      "designation": "Overseas Ministries",
      "designation_memo": "",
      "main_memo": ""
    }
  ]
}