Plans Test
Finance/Plans
Create a new plan.
Http Verb POST
Resource URL https://ts-stg-appgw.calacademy.org/TessituraService/Finance/Plans

URI Parameters

This resource has no URI (Query) parameters.

Request Body

Request object type : Plan

Request object type Plan has the following properties.
Property Name Data Type Length Required Readonly Notes
AskAmount decimal number N
Campaign CampaignSummary Y
FK: T_CAMPAIGN.campaign_no   Resource: Campaigns
CompleteByDateTime date N
Constituent ConstituentDisplaySummary Y
FK: T_CUSTOMER.customer_no   Resource: Constituents
ContributionAmount decimal number N
ContributionDesignation ContributionDesignationSummary Y
FK: TR_CONT_DESIGNATION.id   Resource: ContributionDesignations
CreatedBy string N Auto-assigned
CreatedDateTime date N Auto-assigned
CreateLocation string N Auto-assigned
CustomDataItems Collection of CustomDataItem
EditIndicator boolean
Fund FundSummary N
FK: T_FUND.fund_no   Resource: Funds
GoalAmount decimal number N
HasOpenSteps boolean
HasSteps boolean
Id integer N Auto-assigned
LastStepDate date
LastStepType StepTypeSummary
LastWorkerDisplayName string
NextStepDate date
NextStepType StepTypeSummary
Notes string N
OriginalSource PlanSourceSummary Y
FK: TR_PLAN_SOURCE.id   Resource: PlanSources
PlanAssociates string
PrimaryWorker ConstituentShortDisplayNameSummary
Priority PlanPrioritySummary N
FK: TR_PLAN_PRIORITY.id   Resource: PlanPriorities
Probability decimal number Y
RecordedAmount decimal number N
StartDateTime date N
Status PlanStatusSummary Y
FK: TR_PLAN_STATUS.id   Resource: PlanStatuses
Type PlanTypeSummary Y
FK: TR_PLAN_TYPE.id   Resource: PlanTypes
UpdatedBy string N Auto-assigned
UpdatedDateTime date N Auto-assigned 
{
  "AskAmount": 1.0,
  "Campaign": {
    "Id": 1,
    "Description": "sample string 1",
    "FYear": 1,
    "Inactive": true,
    "MembershipOrganization": {
      "Description": "sample string 1",
      "Id": 1,
      "EditIndicator": true
    }
  },
  "CompleteByDateTime": "2025-04-24T05:23:04.390055-07:00",
  "ContributionAmount": 1.0,
  "ContributionDesignation": {
    "Description": "sample string 1",
    "Id": 1,
    "Inactive": true
  },
  "HasSteps": true,
  "HasOpenSteps": true,
  "CreatedDateTime": "2025-04-24T05:23:04.390055-07:00",
  "CreateLocation": "sample string 1",
  "CreatedBy": "sample string 2",
  "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
    }
  ],
  "EditIndicator": true,
  "Constituent": {
    "Id": 1,
    "SortName": "sample string 1",
    "DisplayName": "sample string 2"
  },
  "Fund": {
    "Description": "sample string 1",
    "Id": 1,
    "BusinessUnitId": 1,
    "Inactive": true,
    "TicketingIndicator": true,
    "EditIndicator": true,
    "ConstituencyId": 3
  },
  "GoalAmount": 1.0,
  "UpdatedDateTime": "2025-04-24T05:23:04.390055-07:00",
  "UpdatedBy": "sample string 3",
  "Notes": "sample string 4",
  "Priority": {
    "Description": "sample string 1",
    "Id": 1,
    "Inactive": true,
    "Ranking": 1
  },
  "Probability": 1.0,
  "RecordedAmount": 1.0,
  "Id": 1,
  "PlanAssociates": "sample string 5",
  "StartDateTime": "2025-04-24T05:23:04.390055-07:00",
  "Status": {
    "Description": "sample string 1",
    "Id": 1,
    "Inactive": true,
    "Rank": 2
  },
  "Type": {
    "Description": "sample string 1",
    "Id": 1,
    "Inactive": true
  },
  "OriginalSource": {
    "Description": "sample string 1",
    "Id": 1,
    "Inactive": true
  },
  "PrimaryWorker": {
    "Id": 1,
    "SortName": "sample string 1",
    "ShortDisplayName": "sample string 2"
  },
  "LastStepType": {
    "Description": "sample string 1",
    "Id": 1,
    "Inactive": true,
    "AllowAttachments": "sample string 2",
    "UseCompletedOnDateTime": "sample string 3",
    "UseDueDateTime": "sample string 4"
  },
  "LastStepDate": "2025-04-24T05:23:04.390055-07:00",
  "NextStepType": {
    "Description": "sample string 1",
    "Id": 1,
    "Inactive": true,
    "AllowAttachments": "sample string 2",
    "UseCompletedOnDateTime": "sample string 3",
    "UseDueDateTime": "sample string 4"
  },
  "NextStepDate": "2025-04-24T05:23:04.390055-07:00",
  "LastWorkerDisplayName": "sample string 6"
}
<Plan xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <AskAmount>1</AskAmount>
  <Campaign>
    <Description>sample string 1</Description>
    <FYear>1</FYear>
    <Id>1</Id>
    <Inactive>true</Inactive>
    <MembershipOrganization>
      <Description>sample string 1</Description>
      <EditIndicator>true</EditIndicator>
      <Id>1</Id>
    </MembershipOrganization>
  </Campaign>
  <CompleteByDateTime>2025-04-24T05:23:04.390055-07:00</CompleteByDateTime>
  <Constituent>
    <DisplayName>sample string 2</DisplayName>
    <Id>1</Id>
    <SortName>sample string 1</SortName>
  </Constituent>
  <ContributionAmount>1</ContributionAmount>
  <ContributionDesignation>
    <Description>sample string 1</Description>
    <Id>1</Id>
    <Inactive>true</Inactive>
  </ContributionDesignation>
  <CreateLocation>sample string 1</CreateLocation>
  <CreatedBy>sample string 2</CreatedBy>
  <CreatedDateTime>2025-04-24T05:23:04.390055-07:00</CreatedDateTime>
  <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>
  <EditIndicator>true</EditIndicator>
  <Fund>
    <BusinessUnitId>1</BusinessUnitId>
    <ConstituencyId>3</ConstituencyId>
    <Description>sample string 1</Description>
    <EditIndicator>true</EditIndicator>
    <Id>1</Id>
    <Inactive>true</Inactive>
    <TicketingIndicator>true</TicketingIndicator>
  </Fund>
  <GoalAmount>1</GoalAmount>
  <HasOpenSteps>true</HasOpenSteps>
  <HasSteps>true</HasSteps>
  <Id>1</Id>
  <LastStepDate>2025-04-24T05:23:04.390055-07:00</LastStepDate>
  <LastStepType>
    <AllowAttachments>sample string 2</AllowAttachments>
    <Description>sample string 1</Description>
    <Id>1</Id>
    <Inactive>true</Inactive>
    <UseCompletedOnDateTime>sample string 3</UseCompletedOnDateTime>
    <UseDueDateTime>sample string 4</UseDueDateTime>
  </LastStepType>
  <LastWorkerDisplayName>sample string 6</LastWorkerDisplayName>
  <NextStepDate>2025-04-24T05:23:04.390055-07:00</NextStepDate>
  <NextStepType>
    <AllowAttachments>sample string 2</AllowAttachments>
    <Description>sample string 1</Description>
    <Id>1</Id>
    <Inactive>true</Inactive>
    <UseCompletedOnDateTime>sample string 3</UseCompletedOnDateTime>
    <UseDueDateTime>sample string 4</UseDueDateTime>
  </NextStepType>
  <Notes>sample string 4</Notes>
  <OriginalSource>
    <Description>sample string 1</Description>
    <Id>1</Id>
    <Inactive>true</Inactive>
  </OriginalSource>
  <PlanAssociates>sample string 5</PlanAssociates>
  <PrimaryWorker>
    <Id>1</Id>
    <ShortDisplayName>sample string 2</ShortDisplayName>
    <SortName>sample string 1</SortName>
  </PrimaryWorker>
  <Priority>
    <Description>sample string 1</Description>
    <Id>1</Id>
    <Inactive>true</Inactive>
    <Ranking>1</Ranking>
  </Priority>
  <Probability>1</Probability>
  <RecordedAmount>1</RecordedAmount>
  <StartDateTime>2025-04-24T05:23:04.390055-07:00</StartDateTime>
  <Status>
    <Description>sample string 1</Description>
    <Id>1</Id>
    <Inactive>true</Inactive>
    <Rank>2</Rank>
  </Status>
  <Type>
    <Description>sample string 1</Description>
    <Id>1</Id>
    <Inactive>true</Inactive>
  </Type>
  <UpdatedBy>sample string 3</UpdatedBy>
  <UpdatedDateTime>2025-04-24T05:23:04.390055-07:00</UpdatedDateTime>
</Plan>

Response object type : Plan

Response object type Plan has the following properties.
Property Name Data Type Length Required Readonly Notes
AskAmount decimal number N
Campaign CampaignSummary Y
FK: T_CAMPAIGN.campaign_no   Resource: Campaigns
CompleteByDateTime date N
Constituent ConstituentDisplaySummary Y
FK: T_CUSTOMER.customer_no   Resource: Constituents
ContributionAmount decimal number N
ContributionDesignation ContributionDesignationSummary Y
FK: TR_CONT_DESIGNATION.id   Resource: ContributionDesignations
CreatedBy string N Auto-assigned
CreatedDateTime date N Auto-assigned
CreateLocation string N Auto-assigned
CustomDataItems Collection of CustomDataItem
EditIndicator boolean
Fund FundSummary N
FK: T_FUND.fund_no   Resource: Funds
GoalAmount decimal number N
HasOpenSteps boolean
HasSteps boolean
Id integer N Auto-assigned
LastStepDate date
LastStepType StepTypeSummary
LastWorkerDisplayName string
NextStepDate date
NextStepType StepTypeSummary
Notes string N
OriginalSource PlanSourceSummary Y
FK: TR_PLAN_SOURCE.id   Resource: PlanSources
PlanAssociates string
PrimaryWorker ConstituentShortDisplayNameSummary
Priority PlanPrioritySummary N
FK: TR_PLAN_PRIORITY.id   Resource: PlanPriorities
Probability decimal number Y
RecordedAmount decimal number N
StartDateTime date N
Status PlanStatusSummary Y
FK: TR_PLAN_STATUS.id   Resource: PlanStatuses
Type PlanTypeSummary Y
FK: TR_PLAN_TYPE.id   Resource: PlanTypes
UpdatedBy string N Auto-assigned
UpdatedDateTime date N Auto-assigned 
{
  "AskAmount": 1.0,
  "Campaign": {
    "Id": 1,
    "Description": "sample string 1",
    "FYear": 1,
    "Inactive": true,
    "MembershipOrganization": {
      "Description": "sample string 1",
      "Id": 1,
      "EditIndicator": true
    }
  },
  "CompleteByDateTime": "2025-04-24T05:23:04.4056622-07:00",
  "ContributionAmount": 1.0,
  "ContributionDesignation": {
    "Description": "sample string 1",
    "Id": 1,
    "Inactive": true
  },
  "HasSteps": true,
  "HasOpenSteps": true,
  "CreatedDateTime": "2025-04-24T05:23:04.4056622-07:00",
  "CreateLocation": "sample string 1",
  "CreatedBy": "sample string 2",
  "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
    }
  ],
  "EditIndicator": true,
  "Constituent": {
    "Id": 1,
    "SortName": "sample string 1",
    "DisplayName": "sample string 2"
  },
  "Fund": {
    "Description": "sample string 1",
    "Id": 1,
    "BusinessUnitId": 1,
    "Inactive": true,
    "TicketingIndicator": true,
    "EditIndicator": true,
    "ConstituencyId": 3
  },
  "GoalAmount": 1.0,
  "UpdatedDateTime": "2025-04-24T05:23:04.4056622-07:00",
  "UpdatedBy": "sample string 3",
  "Notes": "sample string 4",
  "Priority": {
    "Description": "sample string 1",
    "Id": 1,
    "Inactive": true,
    "Ranking": 1
  },
  "Probability": 1.0,
  "RecordedAmount": 1.0,
  "Id": 1,
  "PlanAssociates": "sample string 5",
  "StartDateTime": "2025-04-24T05:23:04.4056622-07:00",
  "Status": {
    "Description": "sample string 1",
    "Id": 1,
    "Inactive": true,
    "Rank": 2
  },
  "Type": {
    "Description": "sample string 1",
    "Id": 1,
    "Inactive": true
  },
  "OriginalSource": {
    "Description": "sample string 1",
    "Id": 1,
    "Inactive": true
  },
  "PrimaryWorker": {
    "Id": 1,
    "SortName": "sample string 1",
    "ShortDisplayName": "sample string 2"
  },
  "LastStepType": {
    "Description": "sample string 1",
    "Id": 1,
    "Inactive": true,
    "AllowAttachments": "sample string 2",
    "UseCompletedOnDateTime": "sample string 3",
    "UseDueDateTime": "sample string 4"
  },
  "LastStepDate": "2025-04-24T05:23:04.4056622-07:00",
  "NextStepType": {
    "Description": "sample string 1",
    "Id": 1,
    "Inactive": true,
    "AllowAttachments": "sample string 2",
    "UseCompletedOnDateTime": "sample string 3",
    "UseDueDateTime": "sample string 4"
  },
  "NextStepDate": "2025-04-24T05:23:04.4056622-07:00",
  "LastWorkerDisplayName": "sample string 6"
}
<Plan xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <AskAmount>1</AskAmount>
  <Campaign>
    <Description>sample string 1</Description>
    <FYear>1</FYear>
    <Id>1</Id>
    <Inactive>true</Inactive>
    <MembershipOrganization>
      <Description>sample string 1</Description>
      <EditIndicator>true</EditIndicator>
      <Id>1</Id>
    </MembershipOrganization>
  </Campaign>
  <CompleteByDateTime>2025-04-24T05:23:04.4056622-07:00</CompleteByDateTime>
  <Constituent>
    <DisplayName>sample string 2</DisplayName>
    <Id>1</Id>
    <SortName>sample string 1</SortName>
  </Constituent>
  <ContributionAmount>1</ContributionAmount>
  <ContributionDesignation>
    <Description>sample string 1</Description>
    <Id>1</Id>
    <Inactive>true</Inactive>
  </ContributionDesignation>
  <CreateLocation>sample string 1</CreateLocation>
  <CreatedBy>sample string 2</CreatedBy>
  <CreatedDateTime>2025-04-24T05:23:04.4056622-07:00</CreatedDateTime>
  <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>
  <EditIndicator>true</EditIndicator>
  <Fund>
    <BusinessUnitId>1</BusinessUnitId>
    <ConstituencyId>3</ConstituencyId>
    <Description>sample string 1</Description>
    <EditIndicator>true</EditIndicator>
    <Id>1</Id>
    <Inactive>true</Inactive>
    <TicketingIndicator>true</TicketingIndicator>
  </Fund>
  <GoalAmount>1</GoalAmount>
  <HasOpenSteps>true</HasOpenSteps>
  <HasSteps>true</HasSteps>
  <Id>1</Id>
  <LastStepDate>2025-04-24T05:23:04.4056622-07:00</LastStepDate>
  <LastStepType>
    <AllowAttachments>sample string 2</AllowAttachments>
    <Description>sample string 1</Description>
    <Id>1</Id>
    <Inactive>true</Inactive>
    <UseCompletedOnDateTime>sample string 3</UseCompletedOnDateTime>
    <UseDueDateTime>sample string 4</UseDueDateTime>
  </LastStepType>
  <LastWorkerDisplayName>sample string 6</LastWorkerDisplayName>
  <NextStepDate>2025-04-24T05:23:04.4056622-07:00</NextStepDate>
  <NextStepType>
    <AllowAttachments>sample string 2</AllowAttachments>
    <Description>sample string 1</Description>
    <Id>1</Id>
    <Inactive>true</Inactive>
    <UseCompletedOnDateTime>sample string 3</UseCompletedOnDateTime>
    <UseDueDateTime>sample string 4</UseDueDateTime>
  </NextStepType>
  <Notes>sample string 4</Notes>
  <OriginalSource>
    <Description>sample string 1</Description>
    <Id>1</Id>
    <Inactive>true</Inactive>
  </OriginalSource>
  <PlanAssociates>sample string 5</PlanAssociates>
  <PrimaryWorker>
    <Id>1</Id>
    <ShortDisplayName>sample string 2</ShortDisplayName>
    <SortName>sample string 1</SortName>
  </PrimaryWorker>
  <Priority>
    <Description>sample string 1</Description>
    <Id>1</Id>
    <Inactive>true</Inactive>
    <Ranking>1</Ranking>
  </Priority>
  <Probability>1</Probability>
  <RecordedAmount>1</RecordedAmount>
  <StartDateTime>2025-04-24T05:23:04.4056622-07:00</StartDateTime>
  <Status>
    <Description>sample string 1</Description>
    <Id>1</Id>
    <Inactive>true</Inactive>
    <Rank>2</Rank>
  </Status>
  <Type>
    <Description>sample string 1</Description>
    <Id>1</Id>
    <Inactive>true</Inactive>
  </Type>
  <UpdatedBy>sample string 3</UpdatedBy>
  <UpdatedDateTime>2025-04-24T05:23:04.4056622-07:00</UpdatedDateTime>
</Plan>

No entries in change log for this operation.