ScheduledCharge

Version: 1.33

The scheduledCharge is optional in Gotransverse and is used in ServicePrice and in OrderItem. Use scheduledCharge to schedule a one-time charge.

scheduledCharge is different than ScheduledOneTimePriceCharge which is used to schedule a one-time charge that shows on the invoice.

ScheduledCharge is set in the graphical user interface (GUI) when setting or creating the Recurring Price of a Product. Scheduled Charge is a check box titled "Allow Scheduled Charges" and when it has a check mark, that means that when this item is purchased during an Order, the person creating the Order has the option of scheduling the charge to the customer. Scheduling the charge includes:

• Setting the number of payments the charge can contain

• Selecting the amount and date for each charge

• Adding a description of each charge

ScheduledCharges can be viewed and edited in the GUI in a BillingAccount under the Subscription details as well as viewed in the Order details. Changes that can be made to a not-yet-invoiced-charge include changing the scheduled date, splitting a charge into two charges, or combining two charges into one charge. The charge schedule defined during the Order is included in the Order Receipt so that the customer receives a confirmation of his payment schedule. These scheduled charges are automatically invoiced to the customer on their defined date.

Check mark in the GUI in the "Allow Scheduled Charges" check box also means that the following options become UNavailable: Prorated on Order, Prorate on Order - No Charge, Prorated on Cancel, Pay on Purchase, Automatic Recurring Payment Required.

This page provides the following Gotransverse API information for this entity of ScheduledCharge:

Parameters

Each ScheduledCharge shown from the Query shows information for a number of elements in the entity. The following table shows the elements, details of the elements, and brief descriptions.

Elements

Element Name	Query Key	Element Type	Field Length	Required to Create	Description
queryScope		QueryScope	- -	No	Whether default query results are overridden by ueryScope resulting in SHALLOW or DEEP query results. Refer to QueryScope for details.
eid	Y	Long	System Generated	System Generated	System generated unique identity number assigned to all entities in Gotransverse.
description		String	255	No	The description of the Scheduled Charge.
amount		Decimal	As needed	Yes	The amount of the Scheduled Charge.
invoiced	Y	Boolean	Enter either: "true" (Yes) or "false" (No)		Is the Scheduled Charge invoiced? Yes, the scheduled charge IS invoiced. No, the scheduled charge is NOT invoiced.
chargeDate		dateTime	Refer to Data Types for dateTime formats.	Yes	The date of the Scheduled Charge.

Entity ScheduledCharges

The entity ScheduledCharges enables you to see multiple entries of the entity ScheduledCharge.

Elements

Element Name	Element Type	Field Length	Description
pageNumber	Integer	as needed	Shows the current page number.
pageSize	Integer	as needed	Shows the page size.
totalElements	Long	as needed	Shows the total number of items found.
elementCount	Integer	as needed	Shows the current count of the item in the number of items that were found.
totalPages	Integer	as needed	Shows the total number of pages.
scheduledCharge	ScheduledCharge	- -	Shows the list of ScheduledCharges.

Information for the related entity of ScheduledCharges:

• Entity ScheduledCharges

Query a ScheduledCharge

Query Key Information for SOAP and REST

Querying to see ScheduledCharges needs to include one of the following parameters. If you do not know the value for the parameter, query separately to learn the value.

Query Key Parameters

ScheduledCharge

Query Key	Value	Definition
eid	Long	The eid number of the ScheduledCharge.
servicePriceEid	Long	The eid number of the ServicePrice.
orderItemEid	Long	The eid number of the OrderItem.
invoiced	Boolean	Whether or not the Billing Account has been invoiced for this scheduledCharge.

Query to Use

Query to Use	Query for	Parameter Name and Value	Returns
SimpleDataQuery	ScheduledCharge	<parameter name><parameter value>	List of ScheduledCharges for that parameter and value.

SOAP Example Query and Response

In the following example SOAP query, the parameter of orderItemEid was used. The Order Item's EID value (in this example "19863"), was learned through a previous query on OrderItem.

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
    <soap:Body>
        <ns2:query xmlns="http://www.tractbilling.com/billing/1_31/domain" xmlns:ns2="http://www.tractbilling.com/billing/1_31/service">
            <ns2:queryRequest>
                <simpleDataQuery startIndex="0" size="50">
                    <type>ScheduledCharge</type>
                    <parameter parameter="orderItemEid" parameterValue="19863"/>
                </simpleDataQuery>
            </ns2:queryRequest>
        </ns2:query>
    </soap:Body>
</soap:Envelope>

This was the response (this OrderItem had no scheduled charges):

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
    <soap:Body>
        <ns2:queryResponse xmlns="http://www.tractbilling.com/billing/1_31/domain" xmlns:ns2="http://www.tractbilling.com/billing/1_31/service">
            <ns2:return successful="true">
                <scheduledCharges pageNumber="1" pageSize="50" 
totalElements="0" elementCount="0" totalPages="0"/>
            </ns2:return>
        </ns2:queryResponse>
    </soap:Body>
</soap:Envelope>

REST Mount Point and Parameters

Query

• GET https://my.tractbilling.com/t/s/r/1.33/scheduledCharges/<eid>

• GET https://my.tractbilling.com/t/s/r/1.33/scheduledCharges?eid=<eid>

• GET https://my.tractbilling.com/t/s/r/1.33/scheduledCharges?servicePriceEid=<servicePriceEid>

• GET https://my.tractbilling.com/t/s/r/1.33/scheduledCharges?orderItemEid=<orderItemEid>

• GET https://my.tractbilling.com/t/s/r/1.33/scheduledCharges?invoiced=<invoiced>

REST Example Query

In the following example REST query, the parameter of orderItemEid was used. The Order Item's EID value (in this example "19863"), was learned through a previous query on OrderItem.

• GET https://my.tractbilling.com/t/s/r/1.33/scheduledCharges?orderItemEid=19863