CumulativeGivingReceipts Test
CRM/CumulativeGivingReceipts?constituentId={constituentId}&includeAffiliations={includeAffiliations}
Get Cumulative Giving Receipts for the specified constituent id and affiliation Cumulative Giving Receipts as well. To exclude receipts of the visible affiliations pass includeAffiliations=false.
Http Verb GET
Resource URL https://ts-stg-appgw.calacademy.org/TessituraService/CRM/CumulativeGivingReceipts?constituentId={constituentId}&includeAffiliations={includeAffiliations}

URI Parameters

Parameter Name Data Type Required Notes
constituentId integer Y
includeAffiliations boolean N

Request Body

None.
No request body.

Response object type : Collection of CumulativeGivingReceipt

Response object type Collection of CumulativeGivingReceipt has the following properties.
Property Name Data Type Length Required Readonly Notes
AttachPdf boolean N Whether to attach the giving summary as a PDF (AttachPDF = true) or include in the body of the email (AttachPDF = false).
Constituent ConstituentDisplaySummary N Constituent assigned to the contributions.
FK: T_CUSTOMER.customer_no   Resource: Constituents
ContributionTotalAmount decimal number N Total giving amount for selected funds and date range for the cumulative giving receipt run.
ControlGroup ControlGroupSummary N Control group assigned to the session for the utility run.
FK: TR_CONTROL_GROUP.id   Resource: ControlGroups
CreatedBy string N
CreatedDateTime date N
CreateLocation string N
DateSent date N The date the receipt was queued for email delivery.
EmailAddress string N Assigned email address from ElectronicAddresses when the receipt was generated.
EndDateTime date N End date for the contributions considered based on contribution date.
Format Entity N Format used in the receipt generation.
FK: T_FORMAT_INFO.id   Resource: Formats
Funds string N Comma delimited string of fund ids used when the receipt was generated.
Id integer N Primary key for the entity.
SessionId integer N Unique session id for the run of the giving receipt utility.
StartDateTime date N Start date for the contributions considered based on contribution date.
TaxReceiptId integer N Unique tax receipt number for this generated summary receipt.
UpdatedBy string N
UpdatedDateTime date N
Year integer N Year of the end date/time for the giving summary. 
[
  {
    "AttachPdf": true,
    "ContributionTotalAmount": 1.0,
    "CreatedDateTime": "2025-04-24T05:14:47.0017093-07:00",
    "CreateLocation": "sample string 2",
    "CreatedBy": "sample string 3",
    "DateSent": "2025-04-24T05:14:47.0017093-07:00",
    "EmailAddress": "sample string 4",
    "EndDateTime": "2025-04-24T05:14:47.0017093-07:00",
    "Funds": "sample string 5",
    "Id": 1,
    "UpdatedDateTime": "2025-04-24T05:14:47.0017093-07:00",
    "UpdatedBy": "sample string 6",
    "SessionId": 7,
    "StartDateTime": "2025-04-24T05:14:47.0017093-07:00",
    "TaxReceiptId": 1,
    "Year": 1,
    "ControlGroup": {
      "Description": "sample string 1",
      "Id": 2,
      "Inactive": true
    },
    "Constituent": {
      "Id": 1,
      "SortName": "sample string 1",
      "DisplayName": "sample string 2"
    },
    "Format": {
      "Id": 1
    }
  },
  {
    "AttachPdf": true,
    "ContributionTotalAmount": 1.0,
    "CreatedDateTime": "2025-04-24T05:14:47.0017093-07:00",
    "CreateLocation": "sample string 2",
    "CreatedBy": "sample string 3",
    "DateSent": "2025-04-24T05:14:47.0017093-07:00",
    "EmailAddress": "sample string 4",
    "EndDateTime": "2025-04-24T05:14:47.0017093-07:00",
    "Funds": "sample string 5",
    "Id": 1,
    "UpdatedDateTime": "2025-04-24T05:14:47.0017093-07:00",
    "UpdatedBy": "sample string 6",
    "SessionId": 7,
    "StartDateTime": "2025-04-24T05:14:47.0017093-07:00",
    "TaxReceiptId": 1,
    "Year": 1,
    "ControlGroup": {
      "Description": "sample string 1",
      "Id": 2,
      "Inactive": true
    },
    "Constituent": {
      "Id": 1,
      "SortName": "sample string 1",
      "DisplayName": "sample string 2"
    },
    "Format": {
      "Id": 1
    }
  }
]
<CumulativeGivingReceipts xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <CumulativeGivingReceipt>
    <AttachPdf>true</AttachPdf>
    <Constituent>
      <DisplayName>sample string 2</DisplayName>
      <Id>1</Id>
      <SortName>sample string 1</SortName>
    </Constituent>
    <ContributionTotalAmount>1</ContributionTotalAmount>
    <ControlGroup>
      <Description>sample string 1</Description>
      <Id>2</Id>
      <Inactive>true</Inactive>
    </ControlGroup>
    <CreateLocation>sample string 2</CreateLocation>
    <CreatedBy>sample string 3</CreatedBy>
    <CreatedDateTime>2025-04-24T05:14:47.0017093-07:00</CreatedDateTime>
    <DateSent>2025-04-24T05:14:47.0017093-07:00</DateSent>
    <EmailAddress>sample string 4</EmailAddress>
    <EndDateTime>2025-04-24T05:14:47.0017093-07:00</EndDateTime>
    <Format>
      <Id>1</Id>
    </Format>
    <Funds>sample string 5</Funds>
    <Id>1</Id>
    <SessionId>7</SessionId>
    <StartDateTime>2025-04-24T05:14:47.0017093-07:00</StartDateTime>
    <TaxReceiptId>1</TaxReceiptId>
    <UpdatedBy>sample string 6</UpdatedBy>
    <UpdatedDateTime>2025-04-24T05:14:47.0017093-07:00</UpdatedDateTime>
    <Year>1</Year>
  </CumulativeGivingReceipt>
  <CumulativeGivingReceipt>
    <AttachPdf>true</AttachPdf>
    <Constituent>
      <DisplayName>sample string 2</DisplayName>
      <Id>1</Id>
      <SortName>sample string 1</SortName>
    </Constituent>
    <ContributionTotalAmount>1</ContributionTotalAmount>
    <ControlGroup>
      <Description>sample string 1</Description>
      <Id>2</Id>
      <Inactive>true</Inactive>
    </ControlGroup>
    <CreateLocation>sample string 2</CreateLocation>
    <CreatedBy>sample string 3</CreatedBy>
    <CreatedDateTime>2025-04-24T05:14:47.0017093-07:00</CreatedDateTime>
    <DateSent>2025-04-24T05:14:47.0017093-07:00</DateSent>
    <EmailAddress>sample string 4</EmailAddress>
    <EndDateTime>2025-04-24T05:14:47.0017093-07:00</EndDateTime>
    <Format>
      <Id>1</Id>
    </Format>
    <Funds>sample string 5</Funds>
    <Id>1</Id>
    <SessionId>7</SessionId>
    <StartDateTime>2025-04-24T05:14:47.0017093-07:00</StartDateTime>
    <TaxReceiptId>1</TaxReceiptId>
    <UpdatedBy>sample string 6</UpdatedBy>
    <UpdatedDateTime>2025-04-24T05:14:47.0017093-07:00</UpdatedDateTime>
    <Year>1</Year>
  </CumulativeGivingReceipt>
</CumulativeGivingReceipts>
Change Version Description Contract Old New
Property Changed 15.1.13 Constituent has changed from Entity to ConstituentDisplaySummary CumulativeGivingReceipt Entity ConstituentDisplaySummary
Property Changed 15.1.12 Constituent has changed from ConstituentDisplaySummary to Entity CumulativeGivingReceipt ConstituentDisplaySummary Entity
Resource Added 15.1.10 New resource added. CumulativeGivingReceipts