RenewalOrder

Version: 1.33

The Renewal Order is the order containing the Product or group of products that your customer is renewing before their expiration on the customer's Billing Account. The renewalOrder contains between one and numerous orderItems. The Renewal Order contains your customer's Billing Account number and the unique order number. This page provides the following Gotransverse API information for this entity of RenewalOrder:

• Query a Renewal Order

  • Query Key Information for SOAP and REST

  • Query Key Parameters

  • Query to Use

  • REST Mount Point and Parameters

  • Create or Query a Renewal Order

Information for the related Entity of RenewalOrders:

• Entity RenewalOrders

Query to See a Renewal Order

Query Key Information for SOAP and REST

Querying to see RenewalOrders 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

Query Key	Value	Definition
eid	Long	The eid number of the Renewal Order.
orderNum	String	The Order Number of the Order.
billingAccountEid	Long	The unique eid number for the Billing Account.
accountNum	String	The Account Number for the Billing Account.
orderDate	DateTime	The date of the Order.
referral	String	The name of the Person who referred the customer.
externalAccountNum	String	The External Account Number for the Billing Account.
purchaseOrderNumber	String	The Purchase Order number.
renewalDate	DateTime	The date of the Renewal Order.
customFieldValueEid	Long	The unique eid number for the customFieldValue.

If you query by Order you see all SalesOrders and RenewalsOrders, and the Query Key list is not identical to the Query Key list for RenewalOrder.

Query

Query Key	Value	Definition
eid	Long	The eid number of the Renewal Order.
orderNum	String	The Order Number of the Order.
Eid	Long	The unique eid number for the Billing Account.
accountNum	String	The Account Number for the Billing Account.
orderDate	DateTime	The date of the Order.
status	- -	The status of the Renewal Order (for example: "Completed")
referral	String	The name of the Person who referred the customer.
externalAccountNum	String	The External Account Number for the Billing Account.
purchaseOrderNumber	String	The Purchase Order number.
customFieldValueEid	Long	The unique eid number for the customFieldValue.

Query To Use

Query to Use	Query For	Parameter Name and Value	Returns
SimpleDataQuery	RenewalOrder	<parameter name><parameter value>	List of your Renewal Orders for that parameter and value.

Or you can query by Order to see all SalesOrders and RenewalsOrders.

Query To See All

Query to Use	Query For	Parameter Name and Value	Returns
SimpleDataQuery	Order	<parameter name><parameter value>	List of your SalesOrders AND RenewalOrders for that parameter and value.

REST Mount Point and Parameters

Query

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

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

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

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

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

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

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

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

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

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

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

Create or Query a Renewal Order

When you create a Renewal Order in the Gotransverse API, use the following table for information for your entries. When you query a Renewal Order, the following table provides information about the values returned from the query:

Query Results

Element Name	Query Key	Element Type	Field Length	Required to Create	Description
queryScope		QueryScope	- -	N	Whether default query results are overridden by QueryScope 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.
orderItems		Sequence of: OrderItem or TenantOrderItem or TaxOrderItem	- -	List generated when queried	This is the list of ordered items that is generated when queried. TenantOrderItem is only used when creating a Tenant.
billingAccount	Y	BillingAccount	- -	Y	The Billing Account eid number of your customer who is renewing the order.
payments		Sequence of Payment	- -	List generated when queried	This is the list of payments generated when queried.
customFieldValues		CustomFieldValue	- -	N	If used, the value of the Custom Field. Refer to CustomFieldValue for details.
orderNum	Y	String	255	System Generated	The unique number assigned to this order.
note		String	255	N	Description of this Renewal Order.
purchaseOrderNumber	Y	String	255	N	The Purchase Order (PO) number associated with this Renewal Order.
emailReceipt		Boolean	Enter either: "true" (Yes) or "false"	Y	Will the email receipt be sent? YES, the email receipt will be sent. NO, the email receipt will NOT be sent.
referral	Y	String	255	N	Name of other customer or Sales Person who referred the customer to this Renewal.
orderDate	Y	DateTime	Refer to Data Types for dateTime formats.	System Generated	The date and time the original Sales Order was placed.
totalAmount		Decimal	as needed	System Generated	The total amount of the Renewal Order.
orderStatus		OrderStatus	- -	System Generated	The status of the Order. Refer to OrderStatus for details.
renewalDate	Y	DateTime	Refer to Data Types for dateTime formats.	SystemGenerated	The date and time the Renewal Order was placed.

Entity RenewalOrders

The entity RenewalOrders enables you to see multiple pages of the entity RenewalOrder.

Entity

Element Name	Element Type	Field Length	Description
pageNumber	Integer	s 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.
renewalOrder	RenewalOrder	- -	Shows the list of renewalOrder.