BillCycle

Version: 1.33

Assigning a Billing Cycle is required in BillingAccount. Gotransverse comes with one pre-defined Billing Cycle. If you do not have the need to add any other Bill Cycles, Gotransverse does not require you to add Billing Cycles.

In Gotransverse, Billing Cycles are referred to as "Bill Cycles."

Create and add Billing Cycles in Gotransverse. View and use Billing Cycles in either the application or the API.

You cannot create and add Billing Cycles through the API. You can only view and use them.

Through the API, the entity BillCycle enables you to query for Daily, Monthly, Quarterly, Yearly, or Monthly Segmented Bill Cycles.

Perform Through the GUI

  • CREATE as many new Billing Cycles as you need which can include any of the following Billing Cycles:

    • Daily

    • Monthly

    • Quarterly

    • Yearly

    • SegmentedMonthly

  • View the list of Billing Cycles

  • Select one of the Billing Cycles

Perform Through the API

  • Query and view the list of Billing Cycles

  • Select one of the existing Billing Cycles

Parameters

Elements
Element Name Query Key Element Type Field Length Description

billingAccountCategory

  

billingAccountCategory

Billing account category associated with this bill cycle. Used to identify the bill cycle for multiple business entities within a single tenant.

queryScope

QueryScope

- -

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 unique identity number assigned to all entities in Gotransverse.

name

Y

String

40

The name of the BillCycle. You may have many BillCycles from which to choose and you need to specify which one by using its name. Example: "Daily 12" or "Yearly 278."

startDate

dateTime

Refer to Data Types for dateTime formats.

Thestart date of the Billing Cycle.

endDate

dateTime

Refer to Data Types for dateTime formats.

The end date of the Billing Cycle.

billCycleType

BillCycleType

- -

Refer to the Bill Cycle Type:

- Daily

- Monthly

- Quarterly

- Yearly

- SegmentedMonthly

autoBill

Boolean

Shows either:

"true" (Yes) or "false" (No)

Will this Billing Cycle auto bill or not?

YES, this Billing Cycle will auto bill. Gotransverseruns the Billing Cycles automatically on the day after the billing period expires.

This includes the “auto-approve” function for the Billing Cycle meaning that you do not see samples or manually approve each bill cycle run. Example: Monthly Billing Cycle 08/15 - 09/14, then the auto bill cycle will run on 09/15. The invoice date will be the date of the run, in this example: 09/15. The due date of the invoices depends on whether or not you use Payment Terms (the next Element usePaymentTerm).

NO, this Billing Cycle will NOT auto bill and therefore you decide when to run this Billing Cycle, you can view Billing Cycle samples, and you need to manually approve the Billing Cycle run.

usePaymentTerm

Boolean

Shows either:

"true" (Yes) or "false" (No)

Will this Billing Cycle use Payment Terms or not? Payment Terms can only be used if autoBill (the Element above this) is used. Payment Terms are the period of time between the Invoice Date and when the Invoice is considered Past Due. You create Payment Terms and then use them through BillingAccountCategories. All Billing Accounts have a Billing Account Category.YES, Payment Terms are in use. The due date of the invoices is defined by the Payment Terms associated with the Billing Account Categories of the Billing Accounts in the Billing Cycle.NO, Payment Terms are NOT used in the auto run of the Billing Cycle, but instead, (in the GUI) you had set an Invoice Due Date.

status

Y

AccountingStatus

- -

AccountingStatus is the status of the generalLedger:

- Active

- Suspended

- Canceled

currencyType

Y

CurrencyType

- -

The type of Currency already in use (for example: USD, GBP). Refer to CurrencyType for a list.

Query a Billing Cycle

Query Key Information for SOAP and REST

To query for all Billing Cycles of any length of time, use the SimpleDataQuery with no parameters.

Query All
Query to Use Query for Returns

SimpleDataQuery

BillCycle

A list of all of your Billing Cycles of any length of time.

To query for more specific information, use the SimpleDataQuery with the parameter of one of the following Query Keys:

Query
Query Key Value Definition

eid

Long

The eid number of the Bill Cycle.

name

String

The name of the Bill Cycle.

type

The type of Bill Cycle: daily, monthly, quarterly, yearly,segmentedMonthly.

status

The accountingStatus of the generalLedger:Active, Suspended, or Canceled.

currencyType

String

The type of currency already in use. Refer to currencyType.

Unknown Query Key Information

If you do not know the Billing Cycle's eid or name:

Query
Query to Use Query for Returns

SimpleDataQuery

BillCycle

A list of all of your Billing Cycles of any length of time.

Code Samples

SOAP

REST

SOAP Example Query and Response

The following SOAP example is a query of BillCycle:

<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>BillCycle</type>
                </simpleDataQuery>
            </ns2:queryRequest>
        </ns2:query>
    </soap:Body>
</soap:Envelope>

This was the response:

<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">
                <billCycles pageNumber="1" pageSize="50" totalElements="1" elementCount="1" totalPages="1">
                    <monthlyBillCycle dayOfMonth="1" name="Bill Cycle 1" 
startDate="2012-10-01T00:00:00-05:00" endDate="2012-11-01T00:00:00-05:00" 
billCycleType="Monthly" autoBill="false" eid="35"/>
                </billCycles>
            </ns2:return>
        </ns2:queryResponse>
    </soap:Body>
</soap:Envelope>

REST Mount Point

Query

  • GET https://my.tractbilling.com/t/s/r/1.33/billCycles

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

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

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

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

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

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

REST Example Query and Response

The following example is a REST query:

  • GET https://my.tractbilling.com/t/s/r/1.33/billCycles

This was the response (line breaks and formatting added for ease of reading):

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<billCycles xmlns:ns2="http://www.tractbilling.com/billing/1_31/domain" pageNumber="1" pageSize="50" totalElements="1" elementCount="1" totalPages="1">
    <ns2:monthlyBillCycle dayOfMonth="1" name="Bill Cycle 1" 
startDate="2013-01-01T00:00:00-06:00" endDate="2013-02-01T00:00:00-06:00" 
billCycleType="Monthly" autoBill="false" eid="2289"/>
</billCycles>

Refer to the following topics for more information: