PledgeBilling Test
TXN/PledgeBilling
This is not intended for use outside of the Tessitura application. There is no standard way to return billing details for a run. For a given campaign, funds, bill types etc., It raises bills for all those scheduled payments that have due date between given start and end dates. It also checks to see that a bill was not raised after a given 'cut off date'.
Http Verb POST
Resource URL https://ts-stg-appgw.calacademy.org/TessituraService/TXN/PledgeBilling

URI Parameters

This resource has no URI (Query) parameters.

Request Body

Request object type : PledgeBillingRequest

Request object type PledgeBillingRequest has the following properties.
Property Name Data Type Length Required Readonly Notes
AcknowledgementLetterId integer
AppealId integer
BatchTypeId integer
BillingTypeId integer
CampaignId integer
CutoffDateTime date
EndDateTime date
FundIds string
IsLabel boolean
ListId integer
MailDateTime date
MailTypeId integer
MaxNumberOfBillsToPrint integer
MediaTypeId integer
MinAmount decimal number
MinNumberOfBillsToPrint integer
NewSourceDescription string
PaymentMethodGroupId integer
SalutationTypeId integer
ShouldUpdate boolean
StartDateTime date
UserId string 
{
  "CampaignId": 1,
  "FundIds": "sample string 2",
  "BillingTypeId": 3,
  "StartDateTime": "2025-04-24T05:23:04.4837871-07:00",
  "EndDateTime": "2025-04-24T05:23:04.4837871-07:00",
  "CutoffDateTime": "2025-04-24T05:23:04.4837871-07:00",
  "MinAmount": 4.0,
  "ShouldUpdate": true,
  "AppealId": 6,
  "NewSourceDescription": "sample string 7",
  "MediaTypeId": 8,
  "MinNumberOfBillsToPrint": 9,
  "MaxNumberOfBillsToPrint": 10,
  "ListId": 11,
  "MailDateTime": "2025-04-24T05:23:04.4837871-07:00",
  "MailTypeId": 12,
  "IsLabel": true,
  "SalutationTypeId": 14,
  "UserId": "sample string 15",
  "BatchTypeId": 16,
  "PaymentMethodGroupId": 17,
  "AcknowledgementLetterId": 1
}
<PledgeBillingRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <AcknowledgementLetterId>1</AcknowledgementLetterId>
  <AppealId>6</AppealId>
  <BatchTypeId>16</BatchTypeId>
  <BillingTypeId>3</BillingTypeId>
  <CampaignId>1</CampaignId>
  <CutoffDateTime>2025-04-24T05:23:04.4837871-07:00</CutoffDateTime>
  <EndDateTime>2025-04-24T05:23:04.4837871-07:00</EndDateTime>
  <FundIds>sample string 2</FundIds>
  <IsLabel>true</IsLabel>
  <ListId>11</ListId>
  <MailDateTime>2025-04-24T05:23:04.4837871-07:00</MailDateTime>
  <MailTypeId>12</MailTypeId>
  <MaxNumberOfBillsToPrint>10</MaxNumberOfBillsToPrint>
  <MediaTypeId>8</MediaTypeId>
  <MinAmount>4</MinAmount>
  <MinNumberOfBillsToPrint>9</MinNumberOfBillsToPrint>
  <NewSourceDescription>sample string 7</NewSourceDescription>
  <PaymentMethodGroupId>17</PaymentMethodGroupId>
  <SalutationTypeId>14</SalutationTypeId>
  <ShouldUpdate>true</ShouldUpdate>
  <StartDateTime>2025-04-24T05:23:04.4837871-07:00</StartDateTime>
  <UserId>sample string 15</UserId>
</PledgeBillingRequest>

Response object type : AutomatedBillingRunResponse

Response object type AutomatedBillingRunResponse has the following properties.
Property Name Data Type Length Required Readonly Notes
BillCount integer N Number of bills to be processed.
Id integer N Billing run id.
IsComplete boolean N Whether billing process is complete. If false, billing run continues on a background thread. Call GET Txn/{BillingProcess}/{id}/Status for progress where Billing process is PledgeBilling, OrderBilling, or InvoiceBilling. 
{
  "Id": 1,
  "BillCount": 2,
  "IsComplete": true
}
<AutomatedBillingRunResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <BillCount>2</BillCount>
  <Id>1</Id>
  <IsComplete>true</IsComplete>
</AutomatedBillingRunResponse>
Change Version Description Contract Old New
Response Type Changed 15.1.0 Response type has changed from PledgeBillingResponses to AutomatedBillingRunResponse PledgeBillingResponses AutomatedBillingRunResponse