GiftAidDeclarations Test
CRM/GiftAidDeclarations?constituentId={constituentId}&includeAffiliations={includeAffiliations}
Gets all Gift Aid Declarations for a provided constituent including primary affiliates by default.
Http Verb GET
Resource URL https://ts-stg-appgw.calacademy.org/TessituraService/CRM/GiftAidDeclarations?constituentId={constituentId}&includeAffiliations={includeAffiliations}

URI Parameters

Parameter Name Data Type Required Notes
constituentId integer Y Limit results by constituent.
includeAffiliations boolean N Include all of the constituent's affiliates in the results (default: true).

Request Body

None.
No request body.

Response object type : Collection of GiftAidDeclaration

Response object type Collection of GiftAidDeclaration has the following properties.
Property Name Data Type Length Required Readonly Notes
ConfirmDateTime date
Constituent Entity N
ContactMethod GiftAidContactMethodSummary N
FK: TR_GIFTAID_CONTACT_METHOD.id   Resource: GiftAidContactMethods
CreatedBy string N readonly
CreatedDateTime date N readonly
CreateLocation string N readonly
DocumentStatus GiftAidDocumentStatusSummary N
FK: TR_GIFTAID_DOCUMENT_STATUS.id   Resource: GiftAidDocumentStatuses
EligibleIndicator boolean N
EndDateTime date
GiftAidType GiftAidTypeSummary N
FK: TR_GIFTAID_TYPE.id   Resource: GiftAidTypes
Id integer N
IneligibleReason GiftAidIneligibleReasonSummary N
FK: TR_GIFTAID_INELIGIBLE_REASON.id   Resource: GiftAidIneligibleReasons
Notes string
ReceivedDateTime date N
StartDateTime date N
UpdatedBy string N readonly
UpdatedDateTime date N readonly 
[
  {
    "ConfirmDateTime": "2025-04-24T09:39:09.0902274-07:00",
    "CreatedDateTime": "2025-04-24T09:39:09.0902274-07:00",
    "CreateLocation": "sample string 1",
    "CreatedBy": "sample string 2",
    "EligibleIndicator": true,
    "EndDateTime": "2025-04-24T09:39:09.0902274-07:00",
    "Id": 1,
    "UpdatedDateTime": "2025-04-24T09:39:09.0902274-07:00",
    "UpdatedBy": "sample string 3",
    "Notes": "sample string 4",
    "ReceivedDateTime": "2025-04-24T09:39:09.0902274-07:00",
    "StartDateTime": "2025-04-24T09:39:09.0902274-07:00",
    "ContactMethod": {
      "Id": 1,
      "Description": "sample string 1",
      "Inactive": true
    },
    "Constituent": {
      "Id": 1
    },
    "DocumentStatus": {
      "Id": 1,
      "Description": "sample string 1",
      "Inactive": true
    },
    "GiftAidType": {
      "Id": 1,
      "Description": "sample string 1",
      "Inactive": true,
      "ControlGroup": {
        "Description": "sample string 1",
        "Id": 2,
        "Inactive": true
      }
    },
    "IneligibleReason": {
      "Id": 1,
      "Description": "sample string 1",
      "Inactive": true
    }
  },
  {
    "ConfirmDateTime": "2025-04-24T09:39:09.0902274-07:00",
    "CreatedDateTime": "2025-04-24T09:39:09.0902274-07:00",
    "CreateLocation": "sample string 1",
    "CreatedBy": "sample string 2",
    "EligibleIndicator": true,
    "EndDateTime": "2025-04-24T09:39:09.0902274-07:00",
    "Id": 1,
    "UpdatedDateTime": "2025-04-24T09:39:09.0902274-07:00",
    "UpdatedBy": "sample string 3",
    "Notes": "sample string 4",
    "ReceivedDateTime": "2025-04-24T09:39:09.0902274-07:00",
    "StartDateTime": "2025-04-24T09:39:09.0902274-07:00",
    "ContactMethod": {
      "Id": 1,
      "Description": "sample string 1",
      "Inactive": true
    },
    "Constituent": {
      "Id": 1
    },
    "DocumentStatus": {
      "Id": 1,
      "Description": "sample string 1",
      "Inactive": true
    },
    "GiftAidType": {
      "Id": 1,
      "Description": "sample string 1",
      "Inactive": true,
      "ControlGroup": {
        "Description": "sample string 1",
        "Id": 2,
        "Inactive": true
      }
    },
    "IneligibleReason": {
      "Id": 1,
      "Description": "sample string 1",
      "Inactive": true
    }
  }
]
<GiftAidDeclarations xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <GiftAidDeclaration>
    <ConfirmDateTime>2025-04-24T09:39:09.0902274-07:00</ConfirmDateTime>
    <Constituent>
      <Id>1</Id>
    </Constituent>
    <ContactMethod>
      <Description>sample string 1</Description>
      <Id>1</Id>
      <Inactive>true</Inactive>
    </ContactMethod>
    <CreateLocation>sample string 1</CreateLocation>
    <CreatedBy>sample string 2</CreatedBy>
    <CreatedDateTime>2025-04-24T09:39:09.0902274-07:00</CreatedDateTime>
    <DocumentStatus>
      <Description>sample string 1</Description>
      <Id>1</Id>
      <Inactive>true</Inactive>
    </DocumentStatus>
    <EligibleIndicator>true</EligibleIndicator>
    <EndDateTime>2025-04-24T09:39:09.0902274-07:00</EndDateTime>
    <GiftAidType>
      <ControlGroup>
        <Description>sample string 1</Description>
        <Id>2</Id>
        <Inactive>true</Inactive>
      </ControlGroup>
      <Description>sample string 1</Description>
      <Id>1</Id>
      <Inactive>true</Inactive>
    </GiftAidType>
    <Id>1</Id>
    <IneligibleReason>
      <Description>sample string 1</Description>
      <Id>1</Id>
      <Inactive>true</Inactive>
    </IneligibleReason>
    <Notes>sample string 4</Notes>
    <ReceivedDateTime>2025-04-24T09:39:09.0902274-07:00</ReceivedDateTime>
    <StartDateTime>2025-04-24T09:39:09.0902274-07:00</StartDateTime>
    <UpdatedBy>sample string 3</UpdatedBy>
    <UpdatedDateTime>2025-04-24T09:39:09.0902274-07:00</UpdatedDateTime>
  </GiftAidDeclaration>
  <GiftAidDeclaration>
    <ConfirmDateTime>2025-04-24T09:39:09.0902274-07:00</ConfirmDateTime>
    <Constituent>
      <Id>1</Id>
    </Constituent>
    <ContactMethod>
      <Description>sample string 1</Description>
      <Id>1</Id>
      <Inactive>true</Inactive>
    </ContactMethod>
    <CreateLocation>sample string 1</CreateLocation>
    <CreatedBy>sample string 2</CreatedBy>
    <CreatedDateTime>2025-04-24T09:39:09.0902274-07:00</CreatedDateTime>
    <DocumentStatus>
      <Description>sample string 1</Description>
      <Id>1</Id>
      <Inactive>true</Inactive>
    </DocumentStatus>
    <EligibleIndicator>true</EligibleIndicator>
    <EndDateTime>2025-04-24T09:39:09.0902274-07:00</EndDateTime>
    <GiftAidType>
      <ControlGroup>
        <Description>sample string 1</Description>
        <Id>2</Id>
        <Inactive>true</Inactive>
      </ControlGroup>
      <Description>sample string 1</Description>
      <Id>1</Id>
      <Inactive>true</Inactive>
    </GiftAidType>
    <Id>1</Id>
    <IneligibleReason>
      <Description>sample string 1</Description>
      <Id>1</Id>
      <Inactive>true</Inactive>
    </IneligibleReason>
    <Notes>sample string 4</Notes>
    <ReceivedDateTime>2025-04-24T09:39:09.0902274-07:00</ReceivedDateTime>
    <StartDateTime>2025-04-24T09:39:09.0902274-07:00</StartDateTime>
    <UpdatedBy>sample string 3</UpdatedBy>
    <UpdatedDateTime>2025-04-24T09:39:09.0902274-07:00</UpdatedDateTime>
  </GiftAidDeclaration>
</GiftAidDeclarations>
Change Version Description Contract Old New
Parameter Changed 15.0.0 constituentId has been marked as required. Required