InvoiceBilling Test
TXN/InvoiceBilling
Invoice billing
Http Verb POST
Resource URL https://ts-stg-appgw.calacademy.org/TessituraService/TXN/InvoiceBilling

URI Parameters

This resource has no URI (Query) parameters.

Request Body

Request object type : InvoiceBillingRequest

Request object type InvoiceBillingRequest has the following properties.
Property Name Data Type Length Required Readonly Notes
AppealId integer
BatchTypeId integer
BillingTypeId integer
BusinessUnitId integer
CutoffDateTime date
ElectronicAddressPurposeId integer
ElectronicAddressTypeId integer
EndDateTime date
InvoiceEndDateTime date
InvoiceStartDateTime date
IsLabel boolean
ListId integer
MailDateTime date
MailTypeId integer
MaxNumberOfBillsToPrint integer
MediaTypeId integer
MinAmount decimal number
MinNumberOfBillsToPrint integer
NewSourceDescription string
PaymentMethodGroupId integer
PaymentMethodId integer
RespectElectronicAddressMarketingFlag boolean
SalutationTypeId integer
ShouldCollectAll boolean
ShouldUpdate boolean
StartDateTime date
UserId string 
{
  "InvoiceStartDateTime": "2025-04-24T05:14:53.3741718-07:00",
  "InvoiceEndDateTime": "2025-04-24T05:14:53.3741718-07:00",
  "PaymentMethodId": 1,
  "BillingTypeId": 2,
  "StartDateTime": "2025-04-24T05:14:53.3741718-07:00",
  "EndDateTime": "2025-04-24T05:14:53.3741718-07:00",
  "CutoffDateTime": "2025-04-24T05:14:53.3741718-07:00",
  "MinAmount": 3.0,
  "ShouldUpdate": true,
  "AppealId": 5,
  "NewSourceDescription": "sample string 6",
  "MediaTypeId": 7,
  "MinNumberOfBillsToPrint": 8,
  "MaxNumberOfBillsToPrint": 9,
  "ListId": 10,
  "UserId": "sample string 11",
  "BatchTypeId": 12,
  "ShouldCollectAll": true,
  "MailDateTime": "2025-04-24T05:14:53.3741718-07:00",
  "MailTypeId": 1,
  "IsLabel": true,
  "SalutationTypeId": 1,
  "ElectronicAddressTypeId": 1,
  "ElectronicAddressPurposeId": 1,
  "RespectElectronicAddressMarketingFlag": true,
  "PaymentMethodGroupId": 16,
  "BusinessUnitId": 17
}
<InvoiceBillingRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <AppealId>5</AppealId>
  <BatchTypeId>12</BatchTypeId>
  <BillingTypeId>2</BillingTypeId>
  <BusinessUnitId>17</BusinessUnitId>
  <CutoffDateTime>2025-04-24T05:14:53.3741718-07:00</CutoffDateTime>
  <ElectronicAddressPurposeId>1</ElectronicAddressPurposeId>
  <ElectronicAddressTypeId>1</ElectronicAddressTypeId>
  <EndDateTime>2025-04-24T05:14:53.3741718-07:00</EndDateTime>
  <InvoiceEndDateTime>2025-04-24T05:14:53.3741718-07:00</InvoiceEndDateTime>
  <InvoiceStartDateTime>2025-04-24T05:14:53.3741718-07:00</InvoiceStartDateTime>
  <IsLabel>true</IsLabel>
  <ListId>10</ListId>
  <MailDateTime>2025-04-24T05:14:53.3741718-07:00</MailDateTime>
  <MailTypeId>1</MailTypeId>
  <MaxNumberOfBillsToPrint>9</MaxNumberOfBillsToPrint>
  <MediaTypeId>7</MediaTypeId>
  <MinAmount>3</MinAmount>
  <MinNumberOfBillsToPrint>8</MinNumberOfBillsToPrint>
  <NewSourceDescription>sample string 6</NewSourceDescription>
  <PaymentMethodGroupId>16</PaymentMethodGroupId>
  <PaymentMethodId>1</PaymentMethodId>
  <RespectElectronicAddressMarketingFlag>true</RespectElectronicAddressMarketingFlag>
  <SalutationTypeId>1</SalutationTypeId>
  <ShouldCollectAll>true</ShouldCollectAll>
  <ShouldUpdate>true</ShouldUpdate>
  <StartDateTime>2025-04-24T05:14:53.3741718-07:00</StartDateTime>
  <UserId>sample string 11</UserId>
</InvoiceBillingRequest>

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 InvoiceBillingResponses to AutomatedBillingRunResponse InvoiceBillingResponses AutomatedBillingRunResponse