Memberships Test
CRM/Memberships/Calculate
This returns a result of calculated changes to a constituent membership. This resource makes no actual changes and only returns calculated membership data for information purposes.

NOTE: As part of the upcoming changes to membership functionality, this resource will change significantly in an upcoming major Tessitura release and likely break code that references it. Please make a note that code that references it will need to be revisited as part of that upgrade process.
Http Verb POST
Resource URL https://ts-stg-appgw.calacademy.org/TessituraService/CRM/Memberships/Calculate

URI Parameters

This resource has no URI (Query) parameters.

Request Body

Request object type : CalculateMembershipRequest

Request object type CalculateMembershipRequest has the following properties.
Property Name Data Type Length Required Readonly Notes
CalcCampaignId integer N Intended campaign to use for membership calculation.
CalcConstituentId integer N Intended constituent for membership.
CalcContributionAmount decimal number N Intended contribution amount to use for membership calculation.
CalcContributionDate date N Intended contribution date to use for membership calculation.
CalcExpirationDate date N Intended membership expiration date to use for membership calculation.
CalcInitialDate date N Intended membership initial start date to use for membership calculation.
CrediteeId integer N A constituent id to credit the membership
DeclineBenefits string N Y to decline benefits. N to retain benefits of membership.
MembershipLevelOverride string 3 N Override calculated membership level based on giving amount by providing three character membership level code (within the membership organization).
MembershipOrganizationId integer N Membership Organization Id
RealOrMirror string N 'R' (Real) or 'M' Mirror (for controlled batch). This should be set to 'R' in most cases.
RenewUpgradeIndicator string N Either 'R' (Renew) or 'U' (Upgrade) 
{
  "MembershipOrganizationId": 1,
  "RealOrMirror": "sample string 2",
  "DeclineBenefits": "sample string 3",
  "MembershipLevelOverride": "sample string 4",
  "RenewUpgradeIndicator": "sample string 5",
  "CrediteeId": 1,
  "CalcContributionDate": "2025-04-24T05:00:55.092984-07:00",
  "CalcContributionAmount": 1.0,
  "CalcInitialDate": "2025-04-24T05:00:55.092984-07:00",
  "CalcExpirationDate": "2025-04-24T05:00:55.092984-07:00",
  "CalcConstituentId": 1,
  "CalcCampaignId": 1
}
<CalculateMembershipRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <CalcCampaignId>1</CalcCampaignId>
  <CalcConstituentId>1</CalcConstituentId>
  <CalcContributionAmount>1</CalcContributionAmount>
  <CalcContributionDate>2025-04-24T05:00:55.092984-07:00</CalcContributionDate>
  <CalcExpirationDate>2025-04-24T05:00:55.092984-07:00</CalcExpirationDate>
  <CalcInitialDate>2025-04-24T05:00:55.092984-07:00</CalcInitialDate>
  <CrediteeId>1</CrediteeId>
  <DeclineBenefits>sample string 3</DeclineBenefits>
  <MembershipLevelOverride>sample string 4</MembershipLevelOverride>
  <MembershipOrganizationId>1</MembershipOrganizationId>
  <RealOrMirror>sample string 2</RealOrMirror>
  <RenewUpgradeIndicator>sample string 5</RenewUpgradeIndicator>
</CalculateMembershipRequest>

Response object type : CalculateMembershipResponse

Response object type CalculateMembershipResponse has the following properties.
Property Name Data Type Length Required Readonly Notes
CalculatedMembership CalculatedMembership N A potential membership calculated from the request values.
CurrentMembershipSummary CurrentMembership N Current membership summary for the request constituent. 
{
  "CalculatedMembership": {
    "MembershipLevel": "sample string 1",
    "MembershipLevelId": 1,
    "MembershipAmount": 1.0,
    "CurrentMembershipAmount": 1.0,
    "ContributionAmount": 1.0,
    "AVCAmount": 1.0,
    "InitialDate": "2025-04-24T05:00:55.1086066-07:00",
    "ExpirationDate": "2025-04-24T05:00:55.1086066-07:00",
    "InceptionDate": "2025-04-24T05:00:55.1086066-07:00",
    "CurrentStatus": {
      "Id": 1,
      "Description": "sample string 2"
    },
    "CurrentRecord": "sample string 2",
    "Trend": 1,
    "MacroTrend": 1,
    "NRRStatus": "sample string 3",
    "ParentConstituentMembershipId": 1,
    "DeclineBenefits": "sample string 4",
    "CampaignId": 1,
    "MembershipMode": 1,
    "RenewUpgradeOverride": "sample string 5"
  },
  "CurrentMembershipSummary": {
    "InitialDate": "2025-04-24T05:00:55.1086066-07:00",
    "ExpirationDate": "2025-04-24T05:00:55.1086066-07:00",
    "MembershipOrg": {
      "Id": 1,
      "Description": "sample string 2"
    },
    "MembershipLevel": {
      "Id": 1,
      "Description": "sample string 2",
      "StartAmount": 1.0,
      "EndAmount": 1.0
    },
    "CurrentStatus": {
      "Id": 1,
      "Description": "sample string 2"
    },
    "CurrentRecord": "sample string 1",
    "ConstituentMembershipId": 2,
    "CreateDate": "2025-04-24T05:00:55.1086066-07:00"
  }
}
<CalculateMembershipResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <CalculatedMembership>
    <AVCAmount>1</AVCAmount>
    <CampaignId>1</CampaignId>
    <ContributionAmount>1</ContributionAmount>
    <CurrentMembershipAmount>1</CurrentMembershipAmount>
    <CurrentRecord>sample string 2</CurrentRecord>
    <CurrentStatus>
      <Description>sample string 2</Description>
      <Id>1</Id>
    </CurrentStatus>
    <DeclineBenefits>sample string 4</DeclineBenefits>
    <ExpirationDate>2025-04-24T05:00:55.1086066-07:00</ExpirationDate>
    <InceptionDate>2025-04-24T05:00:55.1086066-07:00</InceptionDate>
    <InitialDate>2025-04-24T05:00:55.1086066-07:00</InitialDate>
    <MacroTrend>1</MacroTrend>
    <MembershipAmount>1</MembershipAmount>
    <MembershipLevel>sample string 1</MembershipLevel>
    <MembershipLevelId>1</MembershipLevelId>
    <MembershipMode>1</MembershipMode>
    <NRRStatus>sample string 3</NRRStatus>
    <ParentConstituentMembershipId>1</ParentConstituentMembershipId>
    <RenewUpgradeOverride>sample string 5</RenewUpgradeOverride>
    <Trend>1</Trend>
  </CalculatedMembership>
  <CurrentMembershipSummary xmlns:d2p1="http://schemas.datacontract.org/2004/07/Tessitura.Service.Client.CRM">
    <d2p1:ConstituentMembershipId>2</d2p1:ConstituentMembershipId>
    <d2p1:CreateDate>2025-04-24T05:00:55.1086066-07:00</d2p1:CreateDate>
    <d2p1:CurrentRecord>sample string 1</d2p1:CurrentRecord>
    <d2p1:CurrentStatus>
      <Description>sample string 2</Description>
      <Id>1</Id>
    </d2p1:CurrentStatus>
    <d2p1:ExpirationDate>2025-04-24T05:00:55.1086066-07:00</d2p1:ExpirationDate>
    <d2p1:InitialDate>2025-04-24T05:00:55.1086066-07:00</d2p1:InitialDate>
    <d2p1:MembershipLevel>
      <d2p1:Description>sample string 2</d2p1:Description>
      <d2p1:EndAmount>1</d2p1:EndAmount>
      <d2p1:Id>1</d2p1:Id>
      <d2p1:StartAmount>1</d2p1:StartAmount>
    </d2p1:MembershipLevel>
    <d2p1:MembershipOrg>
      <Description>sample string 2</Description>
      <Id>1</Id>
    </d2p1:MembershipOrg>
  </CurrentMembershipSummary>
</CalculateMembershipResponse>

No entries in change log for this operation.