Cart Test
Web/Cart/{sessionKey}/Contributions
Adds a contribution to the cart

The donation must be applied directly to a fund. This method also allows a specific membership level ID to be specified.
Http Verb POST
Resource URL https://ts-stg-appgw.calacademy.org/TessituraService/Web/Cart/{sessionKey}/Contributions

URI Parameters

Parameter Name Data Type Required Notes
sessionKey string Y

Request Body

Request object type : AddContributionRequest

Request object type AddContributionRequest has the following properties.
Property Name Data Type Length Required Readonly Notes
Amount decimal number Y
CustomDataItems Collection of CustomDataItem Up to 10 custom data values for the created contribution.
FundId integer Y The ID number of the fund to which the donation should be applied. The contribution is created and campaign and acknowledgment defaults for the fund are used. If the default camapaign is a membership campaign, the default membership rules can be overridden to allow an early renewal or a late upgrade.
FK: T_FUND.fund_no   Resource: Funds
MembershipLevelId integer Y A membership level id to create the membership. If the fund specified is not associated with a membership, this parameter has no effect. Do not pass this parameter when you want the level to be calculated based on the amount.
FK: T_MEMB_LEVEL.memb_level_no   Resource: MembershipLevels
Notes string 255 N Optional notes to associate with the contribution.
Renew boolean Pass True to override an automatic upgrade and renew the membership instead. Pass False to use the default membership rules to determine if the contribution will upgrade or renew a membership. Note that if both the Upgrade and Renew parameters are set to True, an existing membership will be upgraded rather than renewed.
Upgrade boolean Pass True to override an automatic renewal and upgrade the membership instead. Pass False to use the default membership rules to determine if the contribution will upgrade or renew a membership. Note that if both the Upgrade and Renew parameters are set to True, an existing membership will be upgraded rather than renewed. 
{
  "Amount": 1.0,
  "FundId": 2,
  "Upgrade": true,
  "Renew": true,
  "MembershipLevelId": 5,
  "Notes": "sample string 6",
  "CustomDataItems": [
    {
      "Name": "sample string 1",
      "Index": 1,
      "KeywordId": 1,
      "IsDropdown": true,
      "Value": "sample string 2",
      "DataType": "sample string 3",
      "Description": "sample string 4",
      "EditIndicator": true
    },
    {
      "Name": "sample string 1",
      "Index": 1,
      "KeywordId": 1,
      "IsDropdown": true,
      "Value": "sample string 2",
      "DataType": "sample string 3",
      "Description": "sample string 4",
      "EditIndicator": true
    }
  ]
}
<AddContributionRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <Amount>1</Amount>
  <CustomDataItems>
    <CustomDataItem>
      <DataType>sample string 3</DataType>
      <Description>sample string 4</Description>
      <EditIndicator>true</EditIndicator>
      <Index>1</Index>
      <IsDropdown>true</IsDropdown>
      <KeywordId>1</KeywordId>
      <Name>sample string 1</Name>
      <Value>sample string 2</Value>
    </CustomDataItem>
    <CustomDataItem>
      <DataType>sample string 3</DataType>
      <Description>sample string 4</Description>
      <EditIndicator>true</EditIndicator>
      <Index>1</Index>
      <IsDropdown>true</IsDropdown>
      <KeywordId>1</KeywordId>
      <Name>sample string 1</Name>
      <Value>sample string 2</Value>
    </CustomDataItem>
  </CustomDataItems>
  <FundId>2</FundId>
  <MembershipLevelId>5</MembershipLevelId>
  <Notes>sample string 6</Notes>
  <Renew>true</Renew>
  <Upgrade>true</Upgrade>
</AddContributionRequest>

Response object type : AddContributionResponse

Response object type AddContributionResponse has the following properties.
Property Name Data Type Length Required Readonly Notes
LineItemId integer 
{
  "LineItemId": 1
}
<AddContributionResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <LineItemId>1</LineItemId>
</AddContributionResponse>
Change Version Description Contract Old New
Property Added 15.1.7 Notes has been added to AddContributionRequest AddContributionRequest AddContributionRequest.Notes
Parameter Changed 15.0.0 sessionKey has been marked as required. Required