CanadianDonationReceipt

The CanadianDonationReceipt object

The CanadianDonationReceipt object looks like this in JSON:

{
    "object": "canadian_donation_receipt",
    "id": 1,
    "tax_year": 2021,
    "donor_id": 1,
    "number": 1,
    "num_donations": 5,
    "donor_name": "Freddy Smith",
    "donor_street": "45 Maple Street",
    "donor_city": "Vancouver",
    "donor_province": "BC",
    "donor_postal": "99999",
    "donor_country": "CA",
    "donation_received_date": null,
    "receipt_date": null,
    "total_amount": 0,
    "advantage_amount": 0,
    "tax_deductible_amount": 0,
    "original_currency": null,
    "advantage_description": null,
    "location_issued": null,
    "charity_name": null,
    "charity_street": null,
    "charity_city": null,
    "charity_province": null,
    "charity_postal": null,
    "charity_registration_number": null,
    "added_at": null,
    "added_by_id": null,
    "sandbox": true
}

Attribute	Required	Data Type
id	Yes	int
tax_year	No	int
donor_id	No	int
number	No	int
num_donations	No	int
donor_name	No	text (500)
donor_street	No	text (500)
donor_city	No	text (200)
donor_province	No	text (100)
donor_postal	No	text (100)
donor_country	No	text (100)
donation_received_date	No	date
receipt_date	No	date
total_amount	Yes	decimal
advantage_amount	Yes	decimal
tax_deductible_amount	Yes	decimal
original_currency	No	text (3)
advantage_description	No	text (1000)
location_issued	No	text (500)
charity_name	No	text (500)
charity_street	No	text (200)
charity_city	No	text (100)
charity_province	No	text (100)
charity_postal	No	text (50)
charity_registration_number	No	text (50)
added_at	No	datetime
added_by_id	No	int
sandbox	No	bool

show

Example code to call this method:

curl "https://yourschool.populiweb.com/api2/canadiandonationreceipts/(canadiandonationreceipt)" \
-H "Content-Type: application/json" \ 
-H "Authorization: Bearer YOUR_POPULI_API_KEY" \ 
-X GET

require 'httparty'
response = HTTParty.get(
 'https://yourschool.populiweb.com/api2/canadiandonationreceipts/(canadiandonationreceipt)',
 headers: {
  'Authorization' => 'Bearer YOUR_POPULI_API_KEY'
 },
)
puts response.body

import requests
response = requests.get(
 'https://yourschool.populiweb.com/api2/canadiandonationreceipts/(canadiandonationreceipt)',
 headers={
  'Authorization': 'Bearer YOUR_POPULI_API_KEY'
 },
)
print(response.json())

using Newtonsoft.Json;
using RestSharp;
var client = new RestClient();
var request = new RestRequest(new Uri("https://yourschool.populiweb.com/api2/canadiandonationreceipts/(canadiandonationreceipt)"), Method.Get);
request.AddHeader("Authorization", "Bearer YOUR_POPULI_API_KEY");
var response = client.Execute(request);
var response_object = JsonConvert.DeserializeObject(response.Content);
Console.Write(response_object);

$curl = curl_init();
curl_setopt($curl, CURLOPT_URL, 'https://yourschool.populiweb.com/api2/canadiandonationreceipts/(canadiandonationreceipt)');
curl_setopt($curl, CURLOPT_HTTPHEADER, ['Authorization: Bearer YOUR_POPULI_API_KEY']);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($curl, CURLOPT_CUSTOMREQUEST, 'GET');
$response = curl_exec($curl);
$response_decoded = json_decode($response);
var_dump($response_decoded);

Example response:

{
    "object": "canadian_donation_receipt",
    "id": 1,
    "tax_year": 2021,
    "donor_id": 1,
    "number": 1,
    "num_donations": 5,
    "donor_name": "Freddy Smith",
    "donor_street": "45 Maple Street",
    "donor_city": "Vancouver",
    "donor_province": "BC",
    "donor_postal": "99999",
    "donor_country": "CA",
    "donation_received_date": null,
    "receipt_date": null,
    "total_amount": 0,
    "advantage_amount": 0,
    "tax_deductible_amount": 0,
    "original_currency": null,
    "advantage_description": null,
    "location_issued": null,
    "charity_name": null,
    "charity_street": null,
    "charity_city": null,
    "charity_province": null,
    "charity_postal": null,
    "charity_registration_number": null,
    "added_at": null,
    "added_by_id": null,
    "sandbox": true
}

Retrieves a specific CanadianDonationReceipt object.

HTTP Request

GET /canadiandonationreceipts/(canadiandonationreceipt)

Parameters

No additional parameters are needed beyond the ID of the object being requested that appears in the URL.

Permissions

One of the following roles is required to call this method:

Financial Admin
Donations
Financial Auditor