GLAggregateEntry

Version: 1.33

GLAggregateEntry is provided to you by Gotransverse and is an aggregation of General Ledger (G/L) Accounting Entries of payments, invoices, adjustments, and accruals. Refer to API 1.32 Entity GLAccountingEntry if needed.

The quantity of G/L Accounting Entries depends on how many entries have occurred in the time period in which Gotransverse aggregates, which is one to several times per day. Different G/L Aggregation strategies can be set in the GUI in the Gotransverse application parameters, including categorizing by BillingAccountCategory.

GLAggregateEntry can be queried, viewed, and used through the API. Gotransverse creates the GLAggregateEntry.

Parameters

Each GLAggregateEntry 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 GLAggregateEntry.
GLAccount		GLAccount	- -	The unique G/L Account number that you designated for the G/L Account when you created it.
billingAccountCategory		BillingAccountCategory	- -	Used in G/L Aggregation strategy.
amount		Decimal	As needed	The amount of the GLAggregate Entry.
entrytype		GLAggregateEntryType	- -	The type of the G/L Aggregate Entry: - Debit - Credit
count		Long	As needed	The number of G/L Accounting Entries that have been aggregated.
currencyType		CurrencyType	- -	The type of currency used. Refer to CurrencyType for list of currencies.
originalAmount		Decimal	As needed	The original amount of the GL Account Entry if the amount has changed due to a currency change.
originalCurrencyType		CurrencyType	- -	The original type of currency used if the currency changed. Refer to CurrencyType for list of currencies.

Entity GLAggregateEntries

The entity GLAggregateEntries enables you to see multiple pages of the entity GLAggregateEntry.

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.
GLAggregateEntry	GLAggregateEntry	- -	Shows the list of GLAggregateEntries.

Information for the related Entity of GLAggregateEntries:

• Entity GLAggregateEntries

Query a GLAggregateEntry

Query Key Information for SOAP and REST

Querying to see GLAggregateEntries 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 - GLAggregateEntry

Query Key	Value	Definition
eid	Long	The eid number of the GLAggregateEntry.
GLAggregateBatchEid	Long	The eid number of the GLAggregateBatch.
GLAccountEid	Long	The eid number of the GLAccount.
batchPostedOn	Date	The date on which the Aggregate Batch was posted.
batchNum	String	The unique number of the Aggregate Batch.

Query to Use

Query to Use	Query for	Parameter Name and Value
SimpleDataQuery	GLAggregateEntry	<parameter name><parameter value>	List of your GLAggregateEntries for that parameter and value.

SOAP Example Query and Response

In the following example SOAP query, the parameter of GLAccountEid was used. The G/L Account EID's value (in this example "27"), was learned in a previous query of G/L Accounts.

<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>GLAggregateEntry</type>
                    <parameter parameter="glAccountEid" parameterValue="27"/>
                </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">
                <glAggregateEntries pageNumber="1" pageSize="50" totalElements="1" elementCount="1" totalPages="1">
                    <glAggregateEntry amount="15.00" entryType="DEBIT" count="1" eid="197">
                        <glAccount currentBalance="15.00000" accountNum="1000" name="Cash" eid="27">
                            <glAccountCategory name="Cash" description="Cash Assets" status="ACTIVE" eid="427">
                                <accountType name="Asset" description="Asset" eid="1"/>
                            </glAccountCategory>
                            <type name="Asset" description="Asset" eid="1"/>
                            <generalLedger name="Smith Country Store #2, General Ledger" description="General Ledger for Smith Country Store #2." status="ACTIVE" eid="13">
                                <chartOfAccounts pageNumber="1" pageSize="50" totalElements="7" elementCount="0" totalPages="1"/>
                            </generalLedger>
                        </glAccount>
                    </glAggregateEntry>
                </glAggregateEntries>
            </ns2:return>
        </ns2:queryResponse>
    </soap:Body>
</soap:Envelope>

REST Mount Point and Parameters

Query

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

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

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

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

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

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

REST Example Query and Response

In the following example REST query, the parameter of GLAccountEid was used. The GL Account's EID value (in this example "27"), was learned through a previous query on GLAccount.

• GET https://my.tractbilling.com/t/s/r/1.33/glAggregateEntries?glAccountEid=27

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

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<glAggregateEntries xmlns:ns2="http://www.tractbilling.com/billing/1_31/domain" pageNumber="1" pageSize="50" totalElements="1" elementCount="1" totalPages="1">
    <ns2:glAggregateEntry amount="15.00" entryType="DEBIT" count="1" eid="197">
        <ns2:glAccount currentBalance="15.00000" accountNum="1000" name="Cash" eid="27">
            <ns2:glAccountCategory name="Cash" description="Cash Assets" status="ACTIVE" eid="427">
                <ns2:accountType name="Asset" description="Asset" eid="1"/>
            </ns2:glAccountCategory>
            <ns2:type name="Asset" description="Asset" eid="1"/>
            <ns2:generalLedger name="Smith Country Store #2, General Ledger" description="General Ledger for Smith Country Store #2." status="ACTIVE" eid="13">
                <ns2:chartOfAccounts pageNumber="1" pageSize="50" totalElements="7" elementCount="0" totalPages="1"/>
            </ns2:generalLedger>
        </ns2:glAccount>
    </ns2:glAggregateEntry>
</glAggregateEntries>