GLAccountingEntry

Version: 1.33

General Ledger (G/L) Accounting Entries are produced by Gotransverse from posted transactions such as a customer paying his Invoice. G/L Accounting Entries can be viewed in the Gotransverse interface as well as queried and viewed through the Gotransverse API.

Query GLAccountingEntries directly or through GLAccountingTransaction.

Parameters

Each GLAccountingEntry 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 GLAccountingEntries.
GLAccount		GLAccount	- -	The name of the G/L Account to which this entry is posted.
invoiceItem		InvoiceItem	- -	The name of the Invoice Item that posted to the G/L Account.
additionalInformaton		AdditionalInformation	- -	Any additional information needed for G/L Accounting Entry. Refer to AdditionalInformation for more information.
amount		Decimal	as needed	The current amount of the G/L Accounting Entry.
occurredOn		DateTime		The date and time the G/L Accounting Entry was posted.
credit		Boolean	Shows either: "true" (Yes) or "false" (No)	Is this G/L Accounting Entry a credit? Yes, this G/L Accounting Entry is a credit. No, G/L Accounting Entry is NOT a credit (it is a debit).
description		String	255	A description of the G/L Accounting Entry.
currencyType		CurrencyType	- -	The current type of currency used. Refer to CurrencyType for list of currencies.
convertedRate		Decimal	as needed	If applicable. The conversion rate from the previous monetary amount to the current monetary amount.
originalAmount		Decimal	as needed	The previous monetary amount of the G/L Accounting Entry before the most recent monetary conversion.
originalCurrencyType		CurrencyType	- -	The previous type of currency used, if different than the current type of currency. Refer to CurrencyType for list of currencies.

Entity GLAccountingEntries

The entity GLAccountingEntries enables you to see multiple pages of the entity GLAccountingEntry.

Entities

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.
GLAccountingEntries	GLAccountingEntry	- -	Shows the list of GLAccountingEntries.

Information for the related Entity of GLAccountingEntries:

• Entity GLAccountingEntries

Query a GLAccountingEntry

Query Key Information

Querying to see GLAccountingEntries 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 - GLAccountingEntry

Query Key	Value	Definition
eid	Long	The eid number of the GLAccountingEntry.
GLAccountEid	Long	The eid number of the GLAccount to which this GLAccountEntry is posted.
GLAccountingTransactionEid	Long	The eid number of the GLAccountingTransaction to which this GLAccountEntry is associated.
GLAccountingTransactionBatchNum	String	The number of the GLTransactionBatch.
GLAggregateEid	Long	The eid number of the GLAggregate.
GLAggregateBatchNum	String	The number of the GLAggregateBatch.

Query

Query to Use	Query for	Parameter Name and Value	Returns
SimpleDataQuery	GLAccountingEntry	<parameter name><parameter value>	List of your GLAccountingEntries for that parameter name and value.

SOAP Example Query and Response

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

<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>GLAccountingEntry</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">
                <glAccountingEntries pageNumber="1" pageSize="50" totalElements="1" elementCount="1" totalPages="1">
                    <glAccountingEntry amount="15.00000" occurredOn="2012-04-16" credit="false" eid="1050">
                        <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>
                    </glAccountingEntry>
                </glAccountingEntries>
            </ns2:return>
        </ns2:queryResponse>
    </soap:Body>
</soap:Envelope>

REST Mount Point and Parameters

Query

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

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

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

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

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

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

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

REST Example Queries and Responses

The following REST queries and responses of a GLAccountingEntryall use the parameter of Eid. The GL Accounting Entry's EID value (in this example "1050"), was learned through a previous query of GLAccount.

The default queryScope set for the tenant is SHALLOW.

Query

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

This was the response:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<glAccountingEntry xmlns="http://www.tractbilling.com/billing/1_31/domain"amount="15.00" occurredOn="2012-04-16" credit="false" currencyType="USD" eid="1050"queryScope="SHALLOW">
    <glAccount eid="27" queryScope="EID"/>
</glAccountingEntry>

Query

• GET https://my.tractbilling.com/t/s/r/1.33/glAccountingEntries?eid=1050

This was the response:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<glAccountingEntries xmlns:ns2="http://www.tractbilling.com/billing/1_31/domain" pageNumber="1" pageSize="50"totalElements="1" elementCount="1" totalPages="1">
    <ns2:glAccountingEntry amount="15.00" occurredOn="2012-04-16"credit="false" currencyType="USD" eid="1050" queryScope="SHALLOW">
        <ns2:glAccount eid="27" queryScope="EID"/>
    </ns2:glAccountingEntry>
</glAccountingEntries>

Query

• GET https://my.tractbilling.com/t/s/r/1.33/glAccountingEntries?eid=1050&queryScope=DEEP

This was the response with queryScope of DEEP:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<glAccountingEntries xmlns:ns2="http://www.tractbilling.com/billing/1_31/domain"pageNumber="1" pageSize="50" totalElements="1" elementCount="1" totalPages="1">
    <ns2:glAccountingEntry amount="15.00" occurredOn="2012-04-16" credit="false"currencyType="USD" eid="1050" queryScope="DEEP">
        <ns2:glAccount currentBalance="55.00" accountNum="1000" name="Cash"eid="27" queryScope="DEEP">
            <ns2:glAccountCategory name="Cash" description="Cash Assets" status="ACTIVE" eid="427" queryScope="DEEP">
                <ns2:accountType name="Asset" description="Asset" eid="1" queryScope="DEEP"/>
            </ns2:glAccountCategory>
            <ns2:type name="Asset" description="Asset" eid="1" queryScope="DEEP"/>
            <ns2:generalLedger name="Smith Country Store #2, General Ledger"description="General Ledger for Smith Country Store #2." status="ACTIVE" eid="13" queryScope="DEEP">
                <ns2:chartOfAccounts pageNumber="1" pageSize="50" totalElements="7"elementCount="0" totalPages="1"/>
            </ns2:generalLedger>
        </ns2:glAccount>
    </ns2:glAccountingEntry>
</glAccountingEntries>