GiftAidDeclarations Test
CRM/GiftAidDeclarations/{giftAidDeclarationId}
Update a Gift Aid Declaration.
Http Verb PUT
Resource URL https://ts-stg-appgw.calacademy.org/TessituraService/CRM/GiftAidDeclarations/{giftAidDeclarationId}

URI Parameters

Parameter Name Data Type Required Notes
giftAidDeclarationId integer Y

Request Body

Request object type : GiftAidDeclaration

Request object type GiftAidDeclaration has the following properties.
Property Name Data Type Length Required Readonly Notes
ConfirmDateTime date
Constituent Entity Y
ContactMethod GiftAidContactMethodSummary Y
FK: TR_GIFTAID_CONTACT_METHOD.id   Resource: GiftAidContactMethods
CreatedBy string N readonly Non-updatable
CreatedDateTime date N readonly Non-updatable
CreateLocation string N readonly Non-updatable
DocumentStatus GiftAidDocumentStatusSummary Y
FK: TR_GIFTAID_DOCUMENT_STATUS.id   Resource: GiftAidDocumentStatuses
EligibleIndicator boolean Y
EndDateTime date
GiftAidType GiftAidTypeSummary Y
FK: TR_GIFTAID_TYPE.id   Resource: GiftAidTypes
Id integer Y Non-updatable
IneligibleReason GiftAidIneligibleReasonSummary N
FK: TR_GIFTAID_INELIGIBLE_REASON.id   Resource: GiftAidIneligibleReasons
Notes string
ReceivedDateTime date Y
StartDateTime date Y
UpdatedBy string N readonly Non-updatable
UpdatedDateTime date N readonly Non-updatable 
{
  "ConfirmDateTime": "2025-04-24T05:23:05.3976551-07:00",
  "CreatedDateTime": "2025-04-24T05:23:05.3976551-07:00",
  "CreateLocation": "sample string 1",
  "CreatedBy": "sample string 2",
  "EligibleIndicator": true,
  "EndDateTime": "2025-04-24T05:23:05.3976551-07:00",
  "Id": 1,
  "UpdatedDateTime": "2025-04-24T05:23:05.3976551-07:00",
  "UpdatedBy": "sample string 3",
  "Notes": "sample string 4",
  "ReceivedDateTime": "2025-04-24T05:23:05.3976551-07:00",
  "StartDateTime": "2025-04-24T05:23:05.3976551-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
  }
}
<GiftAidDeclaration xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <ConfirmDateTime>2025-04-24T05:23:05.3976551-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-24T05:23:05.3976551-07:00</CreatedDateTime>
  <DocumentStatus>
    <Description>sample string 1</Description>
    <Id>1</Id>
    <Inactive>true</Inactive>
  </DocumentStatus>
  <EligibleIndicator>true</EligibleIndicator>
  <EndDateTime>2025-04-24T05:23:05.3976551-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-24T05:23:05.3976551-07:00</ReceivedDateTime>
  <StartDateTime>2025-04-24T05:23:05.3976551-07:00</StartDateTime>
  <UpdatedBy>sample string 3</UpdatedBy>
  <UpdatedDateTime>2025-04-24T05:23:05.3976551-07:00</UpdatedDateTime>
</GiftAidDeclaration>

Response object type : GiftAidDeclaration

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