GLAggregateBatch

Version: 1.33

GLAggregateBatch is a batch of General Ledger (G/L) Aggregate Entries provided to you by Gotransverse once per day. Refer to GLAggregateEntry for more information.

GLAggregateBatch can be queried, viewed, and used through the Gotransverse API. Gotransverse creates the GLAggregateBatch. In the GUI, GLAggregateBatch is called GL Extract Batch and is managed through Admin > Company > GL Extract Processors and through Receivables > Extract Management.

Each GLAggregateBatch 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 Description

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 the GLAggregateBatch.

batchNumber

String

255

The number of the G/L Extract Batch (G/L Aggregate Batch).

description

 

255

A description of the Batch.

totalRecords

Int

As needed

The total number of records in the Batch.

status

Y

GLExtractBatchStatus

- -

The status of the Batch.

xref

String

255

xrefMsg

String

255

Any message related to the import of the GLAggregateBatch.

xrefImportedDate

String

255

The import date of the GLAggregateBatch.

GLAggregateEntries

Sequence of GLAggregateEntry

- -

The list of G/L Aggregate Entries in this Batch.

batchCreatedOn

DateTime

Refer to Data Types for dateTime formats.

The date and time the Batch was created.

batchPostedOn

DateTime

Refer to Data Types for dateTime formats.

The date and time the Batch was posted.

exported

Y

Boolean

Shown either:

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

Has this GLAggregateBatch (G/L Extract Batch) been exported or not?

YES, this Batch has been exported.

NO, this Batch has NOT been exported.

sequence

Long

As needed

Every G/L Aggregate Batch has a unique sequence used to identify the batch.

Entity GLAggregateBatches

The entity GLAggregateBatches enables you to see multiple pages of the entity GLAggregateBatch.

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 eeded

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.

GLAggregateBatch

GLAggregateBatch

- -

Shows the list of GLAggregateBatches.

Information for the related Entity of GLAggregateBatches:

  • Entity GLAggregateBatches

Query a GLAggregateBatch

Query Key Information for SOAP and REST

Querying to see GLAggregateBatch 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: GLAggregateBatch
Query Key Value Definition

eid

Long

The eid number of the GLAggregateBatch.

batchNum

String

The batch number of the GLAggregateBatch.

postedOn

Date

The date on which the Aggregate Batch was posted.

exported

Boolean

Whether or not this Aggregate Batch was exported.

status

The status of the Aggregate Batch.
Query to Use
Query to Use Query to Use Query to Use Query to Use

SimpleDataQuery

GLAggregateBatch

<parameter name><parameter value>

List of your GLAggregateBatches for that parameter name and value.

SOAP Example Query and Response

In the following SOAP query of GLAggregateBatch, the parameter of "exported" with the value of "false" (which means the GLAggregateBatch information was not exported to an external system) was used.

<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>GLAggregateBatch</type>
                    <parameter parameter="exported" parameterValue="False"/>
                </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">
                <glAggregateBatches pageNumber="1" pageSize="50" totalElements="1" elementCount="1" totalPages="1">
                    <glAggregateBatch batchCreatedOn="2012-04-18" batchPostedOn="2012-04-16" exported="false" sequence="1" batchNumber="1" totalRecords="2" status="COMPLETED" eid="111">
                        <glAggregateEntries pageNumber="1" pageSize="50" totalElements="2" elementCount="0" totalPages="1"/>
                    </glAggregateBatch>
                </glAggregateBatches>
            </ns2:return>
        </ns2:queryResponse>
    </soap:Body>
</soap:Envelope>

SOAP Example Query

In the following SOAP query of GLAggregateBatch, the parameter of "batchNum" with its value of "3" was used for this Query Request:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://www.tractbilling.com/billing/1_31/service">
    <soapenv:Header/>
    <soapenv:Body>
        <ser:query>
            <ser:queryRequest queryScope="DEEP">
                <dom:simpleDataQuery>
                    <dom:type>GLAggregateBatch</dom:type>
                    <dom:parameter parameter="batchNum" parameterValue="3"/>
                </dom:simpleDataQuery>
            </ser:queryRequest>
        </ser:query>
    </soapenv:Body>
</soapenv:Envelope>

SOAP Example Update

The following code sample shows the Update call:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://www.tractbilling.com/billing/1_31/service">
    <soapenv:Header/>
    <soapenv:Body>
        <ser:update>
            <ser:updateRequest>
                <dom:glAggregateBatch eid="16" exported="true"/>
            </ser:updateRequest>
        </ser:update>
    </soapenv:Body>
</soapenv:Envelope>

REST Mount Point and Parameters

Query

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

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

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

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

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

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

  • Get the aggregate entries posted on a particular date (same as "postedOn" query parameter)

  • GET https://my.tractbilling.com/t/s/r/1.33/glAggregateBatches?batchPostedOn=<date>

Example GET https://my.tractbilling.com/t/s/r/1.33/glAggregateBatches?batchPostedOn=2012-12-10T17:48:44-06:00

Update

  • PUT https://my.tractbilling.com/t/s/r/1.33/glAggregateBatches/<eid>

REST Examples

REST Example Update

PUT https://my.tractbilling.com/t/s/r/1.33/glAggregateBatches/777654
<glAggregateBatch xmlns="http://www.tractbilling.com/billing/1_31/domain" eid="777654" exported="true"/>

REST Example Query and Response

In the following example REST query, the parameter of status was used.

  • GET https://my.tractbilling.com/t/s/r/1.33/glAggregateBatches?status=False

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

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<glAggregateBatches xmlns:ns2="http://www.tractbilling.com/billing/1_31/domain" pageNumber="1" pageSize="50" totalElements="1" elementCount="1" totalPages="1">
    <ns2:glAggregateBatch batchCreatedOn="2012-04-18" batchPostedOn="2012-04-16" exported="false" sequence="1" batchNumber="1" totalRecords="2" status="COMPLETED" eid="111">
        <ns2:glAggregateEntries pageNumber="1" pageSize="50" totalElements="2" elementCount="0" totalPages="1"/>
    </ns2:glAggregateBatch>
</glAggregateBatches>