GLAccountingTransaction

Version: 1.33

GlAccountingTransactions includes a list of GLAccountingEntries. GlAccountingTransactions also includes GLAdjustmentAccountingTransactions, GLPaymentAccountingTransactions, and GLInvoiceAccountingTransactions.

GlAccountingTransactions are grouped into a GLTransactionBatch.

G/L Accounting Transactions can be viewed in the Gotransverse interface as well as queried and viewed through the Gotransverse API.

Parameters

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 GLAccountingTransactions.
GLAccountingEntries		a list of GLAccountingEntries	- -	A list of G/L Accounting Entries. Refer to GLAccountingEntry.
occurredOn	Y	DateTime		The date and time the G/L Accounting Transaction occurred (not posted).
postedOn		DateTime		The date and time the G/L Accounting Transaction was posted.
type		GLSourceDocumentType	- -
amount	Y	Decimal	as needed	The current amount of the G/L Accounting Transaction.
currencyType	Y	CurrencyType	- -	The current type of currency used. Refer to CurrencyType for list of currencies.
originalAmount		Decimal	as needed	The previous monetary amount of the G/L Accounting Transaction before the most recent monetary conversion.
originalCurrencyType	Y	CurrencyType	- -	The previous type of currency used, if different than the current type of currency. Refer to CurrencyType for list of currencies.

Query a GLAccountingTransaction

Query Key Information

Querying to see GLAccountingTransactions 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 Parameters - GLAccountingTransaction
Query Key	Value	Definition
eid	Long	The eid number of the GLAccountingTransaction.
batchNum	String	The number of the GLTransactionBatch in which the GLAccountingTransaction is a member.
GLTransactionBatchEid	Long	The eid number of the GLTransactionBatch in which the GLAccountingTransaction is a member.
batchPostedOn	Date	The date on which the GLTransactionBatch was posted in which the GLAccountingTransaction is a member.
occurredOn	Date	The date on which the GLAccountingTransaction occurred.
currencyType		The current currency type of the GLAccountingTransaction.
originalCurrencyType		If applicable, the original currency type of the GLAccountingTransaction. Refer to CurrencyType for list of currencies used in Gotransverse.

Query to Use

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

SOAP Examples Queries and Responses

SOAP Example Query and Response for Parameters "originalCurrencyType" and "GLAccountingTransaction EID"

In the following SOAP query of GLAccountingTransaction, the parameter of "originalCurrencyType" was used, which in this example is "USD" and the parameter of the EID of the GLAccountingTransaction ("36080305") that can be learned through a separate query. Refer to CurrencyType for list of currencies used in Gotransverse.

<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>GLAccountingTransaction</dom:type>
                    <parameter parameter="originalCurrencyType" parameterValue="USD"/>
                    <parameter parameter="eid" parameterValue="36080305"/>
                </dom:simpleDataQuery>
            </ser:queryRequest>
        </ser:query>
    </soapenv:Body>
</soapenv:Envelope>

This was the response that also shows the additionalInformation fields:

<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">
                <glAccountingTransactions pageNumber="1" pageSize="50" totalElements="1" elementCount="1" totalPages="1">
                    <glAccountingTransaction occurredOn="2014-07-05T00:00:00-05:00" postedOn="2014-07-05T00:00:00-05:00" type="GLRULE" amount="100.00" currencyType="USD" originalAmount="100.00" originalCurrencyType="USD" eid="36080305" queryScope="DEEP">
                        <glAccountingEntries pageNumber="1" pageSize="50" totalElements="2" elementCount="2" totalPages="1">
                            <glAccountingEntry amount="100.00" occurredOn="2014-07-05" credit="true" description="45" currencyType="USD" originalAmount="100.00" originalCurrencyType="USD" eid="84068310" queryScope="DEEP">
                                <glAccount currentBalance="-7176.16" accountNum="1001" name="1001 Cash" description="Cash Account" eid="2736" queryScope="DEEP">
                                    <glAccountCategory name="Cash" description="Cash assets" status="ACTIVE" eid="29078" queryScope="DEEP">
                                        <accountType name="Asset" description="Asset" 
eid="1" queryScope="DEEP"/>
                                    </glAccountCategory>
                                    <type name="Asset" description="Asset" eid="1" 
queryScope="DEEP"/>
                                    <generalLedger name="Smith Company General Ledger" status="ACTIVE" eid="370" queryScope="DEEP">
                                        <chartOfAccounts pageNumber="1" pageSize="50" 
totalElements="41" elementCount="0" totalPages="1"/>
                                    </generalLedger>
                                </glAccount>
                                <additionalInformation name="Roll-Up" value="t" 
additionalInformationType="BILLING_ACCOUNT_CUSTOM_FIELD_VALUE"/>
                                <additionalInformation name="Smith Company Account Name" 
value="t" additionalInformationType="BILLING_ACCOUNT_CUSTOM_FIELD_VALUE"/>
                                <additionalInformation name="P.O.#" value="t" 
additionalInformationType="BILLING_ACCOUNT_CUSTOM_FIELD_VALUE"/>
                            </glAccountingEntry>
                            <glAccountingEntry amount="100.00" occurredOn="2014-07-05" credit="false" description="45" currencyType="USD" originalAmount="100.00" originalCurrencyType="USD" eid="84068311" queryScope="DEEP">
                                <glAccount currentBalance="7628.16" accountNum="1100" name="1100 Accounts Receivable" description="A/R" eid="2738" queryScope="DEEP">
                                    <glAccountCategory name="Accounts Receivable" description="Accounts Receivable" status="ACTIVE" eid="29080" queryScope="DEEP">
                                        <accountType name="Asset" description="Asset" 
eid="1" queryScope="DEEP"/>
                                    </glAccountCategory>
                                    <type name="Asset" description="Asset" eid="1" 
queryScope="DEEP"/>
                                    <generalLedger name="Smith Company General Ledger" status="ACTIVE" eid="370" queryScope="DEEP">
                                        <chartOfAccounts pageNumber="1" pageSize="50" 
totalElements="41" elementCount="0" totalPages="1"/>
                                    </generalLedger>
                                </glAccount>
                                <additionalInformation name="Roll-Up" value="t" 
additionalInformationType="BILLING_ACCOUNT_CUSTOM_FIELD_VALUE"/>
                                <additionalInformation name="Smith Company Account Name" 
value="t" additionalInformationType="BILLING_ACCOUNT_CUSTOM_FIELD_VALUE"/>
                                <additionalInformation name="P.O.#" value="t" 
additionalInformationType="BILLING_ACCOUNT_CUSTOM_FIELD_VALUE"/>
                            </glAccountingEntry>
                        </glAccountingEntries>
                    </glAccountingTransaction>
                </glAccountingTransactions>
            </ns2:return>
        </ns2:queryResponse>
    </soap:Body>
</soap:Envelope>

SOAP Example Query and Response for Parameters "batchPostedOn" and "GLAccountingTransaction EID"

In the following SOAP query of GLAccountingTransaction, the parameter of "batchPostedOn" was used, which in this example is "2014-01-08" and the parameter of the EID of the GLAccountingTransaction ("36080305") that can be learned through a separate query. For information on the use of the "greater than" operator of "GT" Refer to SQLOperator.

<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>GLAccountingTransaction</dom:type>
                    <parameter parameter="batchPostedOn" operator="GT" parameterValue="2014-01-08"/>
                    <parameter parameter="eid" parameterValue="36080305"/>
                </dom:simpleDataQuery>
            </ser:queryRequest>
        </ser:query>
    </soapenv:Body>

This was the response that also shows the additionalInformation fields:

<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">
                <glAccountingTransactions pageNumber="1" pageSize="50" totalElements="1" elementCount="1" totalPages="1">
                    <glAccountingTransaction occurredOn="2014-07-05T00:00:00-05:00" postedOn="2014-07-05T00:00:00-05:00" type="GLRULE" amount="100.00" currencyType="USD" originalAmount="100.00" originalCurrencyType="USD" eid="36080305" queryScope="DEEP">
                        <glAccountingEntries pageNumber="1" pageSize="50" totalElements="2" elementCount="2" totalPages="1">
                            <glAccountingEntry amount="100.00" occurredOn="2014-07-05" credit="true" description="45" currencyType="USD" originalAmount="100.00" originalCurrencyType="USD" eid="84068310" queryScope="DEEP">
                                <glAccount currentBalance="-7176.16" accountNum="1001" name="1001 Cash" description="Cash Account" eid="2736" queryScope="DEEP">
                                    <glAccountCategory name="Cash" description="Cash assets" status="ACTIVE" eid="29078" queryScope="DEEP">
                                        <accountType name="Asset" description="Asset" 
eid="1" queryScope="DEEP"/>
                                    </glAccountCategory>
                                    <type name="Asset" description="Asset" 
eid="1" queryScope="DEEP"/>
                                    <generalLedger name="Smith Company General Ledger" status="ACTIVE" eid="370" queryScope="DEEP">
                                        <chartOfAccounts pageNumber="1" 
pageSize="50" totalElements="41" elementCount="0" totalPages="1"/>
                                    </generalLedger>
                                </glAccount>
                                <additionalInformation name="Roll-Up" value="t" 
additionalInformationType="BILLING_ACCOUNT_CUSTOM_FIELD_VALUE"/>
                                <additionalInformation name="Smith Company Account Name" 
value="t" additionalInformationType="BILLING_ACCOUNT_CUSTOM_FIELD_VALUE"/>
                                <additionalInformation name="P.O.#" value="t" 
additionalInformationType="BILLING_ACCOUNT_CUSTOM_FIELD_VALUE"/>
                            </glAccountingEntry>
                            <glAccountingEntry amount="100.00" occurredOn="2014-07-05" credit="false" description="45" currencyType="USD" originalAmount="100.00" originalCurrencyType="USD" eid="84068311" queryScope="DEEP">
                                <glAccount currentBalance="7628.16" accountNum="1100" name="1100 Accounts Receivable" description="A/R" eid="2738" queryScope="DEEP">
                                    <glAccountCategory name="Accounts Receivable" description="Accounts Receivable" status="ACTIVE" eid="29080" queryScope="DEEP">
                                        <accountType name="Asset" description="Asset" 
eid="1" queryScope="DEEP"/>
                                    </glAccountCategory>
                                    <type name="Asset" description="Asset" 
eid="1" queryScope="DEEP"/>
                                    <generalLedger name="Smith Company General Ledger" status="ACTIVE" eid="370" queryScope="DEEP">
                                        <chartOfAccounts pageNumber="1" pageSize="50" 
totalElements="41" elementCount="0" totalPages="1"/>
                                    </generalLedger>
                                </glAccount>
                                <additionalInformation name="Roll-Up" value="t" 
additionalInformationType="BILLING_ACCOUNT_CUSTOM_FIELD_VALUE"/>
                                <additionalInformation name="Smith Company Account Name" 
value="t" additionalInformationType="BILLING_ACCOUNT_CUSTOM_FIELD_VALUE"/>
                                <additionalInformation name="P.O.#" value="t" 
additionalInformationType="BILLING_ACCOUNT_CUSTOM_FIELD_VALUE"/>
                            </glAccountingEntry>
                        </glAccountingEntries>
                    </glAccountingTransaction>
                </glAccountingTransactions>
            </ns2:return>
        </ns2:queryResponse>
    </soap:Body>
</soap:Envelope>

REST Mount Points

Query

GET https://my.tractbilling.com/t/s/r/1.33/glAccountingTransactions/<eid>
GET https://my.tractbilling.com/t/s/r/1.33/glAccountingTransactions?eid=<eid>
GET https://my.tractbilling.com/t/s/r/1.33/glAccountingTransactions?batchNum=<batchNum>
GET https://my.tractbilling.com/t/s/r/1.33/glAccountingTransactions?glTransactionBatchEid=<glTransactionBatchEid>
GET https://my.tractbilling.com/t/s/r/1.33/glAccountingTransactions?batchPostedOn=<batchPostedOn>
GET https://my.tractbilling.com/t/s/r/1.33/glAccountingTransactions?occurredOn=<occurredOn>
GET https://my.tractbilling.com/t/s/r/1.33/glAccountingTransactions?currencyType=<currencyType>
GET https://my.tractbilling.com/t/s/r/1.33/glAccountingTransactions?originalCurrencyType=<originalCurrencyType>

REST Example Queries and Responses

The following examples show different sets of parameters in the queries.

REST Example Query and Response for Parameters "batchNum" and "currencyType"

The following REST query and response of a GLAccountingTransaction uses the parameter of batchNum ("327") and currencyType ("USD").

GET https://my.tractbilling.com/t/s/r/1.33/glAccountingTransactions?batchNum=327&currencyType=USD&queryScope=DEEP

This was the response that also shows the additionalInformation fields:

<glAccountingTransactions xmlns:ns2="http://www.tractbilling.com/billing/1_31/domain" pageNumber="1"pageSize="50" totalElements="1" elementCount="1" totalPages="1">
    <ns2:glAccountingTransaction occurredOn="2014-02-01T00:00:00.000-06:00"postedOn="2014-02-01T00:00:00.000-06:00" type="GLRULE" amount="0.00" currencyType="USD"originalAmount="0.00" originalCurrencyType="USD" eid="5128465" queryScope="DEEP">
        <ns2:glAccountingEntries pageNumber="1" pageSize="50" totalElements="2" elementCount="2" totalPages="1">
            <ns2:glAccountingEntry amount="0.00" occurredOn="2014-02-01T00:00:00.000-06:00" credit="true" currencyType="USD" eid="16966927" queryScope="DEEP">
                <ns2:glAccount currentBalance="976.07" accountNum="3900" name="Deferred Revenue" eid="882" queryScope="DEEP">
                    <ns2:glAccountCategory name="Revenue - All Sources" description="Revenue from all sources" status="ACTIVE" eid="22434" queryScope="DEEP">
                        <ns2:accountType name="Revenue" 
description="Revenue" eid="4" queryScope="DEEP"/>
                    </ns2:glAccountCategory>
                    <ns2:type name="Revenue" 
description="Revenue" eid="4" queryScope="DEEP"/>
                    <ns2:generalLedger name="Complex G/L-with charge category" description="Complex Gl Charge Category" status="ACTIVE" eid="320" queryScope="DEEP">
                        <ns2:chartOfAccounts pageNumber="1" 
pageSize="50" totalElements="5" elementCount="0" totalPages="1"/>
                    </ns2:generalLedger>
                </ns2:glAccount>
                <ns2:additionalInformation name="Account Custom Field" 
value="1" additionalInformationType="BILLING_ACCOUNT_CUSTOM_FIELD_VALUE"/>
                <ns2:additionalInformation name="Term" value="12" 
additionalInformationType="BILLING_ACCOUNT_CUSTOM_FIELD_VALUE"/>
                <ns2:additionalInformation name="LOCATION" 
value="texas" additionalInformationType="BILLING_ACCOUNT_CUSTOM_FIELD_VALUE"/>
                <ns2:additionalInformation name="Account Custom Field-3" 
value="3" additionalInformationType="BILLING_ACCOUNT_CUSTOM_FIELD_VALUE"/>
                <ns2:additionalInformation name="Account Custom Field-2" 
value="2" additionalInformationType="BILLING_ACCOUNT_CUSTOM_FIELD_VALUE"/>
            </ns2:glAccountingEntry>
            <ns2:glAccountingEntry amount="0.00" occurredOn="2014-02-01T00:00:00.000-06:00" credit="false" currencyType="USD" eid="16966927" queryScope="DEEP">
                <ns2:glAccount currentBalance="-2729.93" accountNum="5100" name="Credit-GL" eid="880" queryScope="DEEP">
                    <ns2:glAccountCategory name="Accounts Receivable" description="Accounts Receivable" status="ACTIVE" eid="22427" 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="Complex G/L-with charge category" description="Complex Gl Charge Category" status="ACTIVE" eid="320" queryScope="DEEP">
                        <ns2:chartOfAccounts pageNumber="1" 
pageSize="50" totalElements="5" elementCount="0" totalPages="1"/>
                    </ns2:generalLedger>
                </ns2:glAccount>
                <ns2:additionalInformation name="Account Custom Field" 
value="1" additionalInformationType="BILLING_ACCOUNT_CUSTOM_FIELD_VALUE"/>
                <ns2:additionalInformation name="Term" value="12" 
additionalInformationType="BILLING_ACCOUNT_CUSTOM_FIELD_VALUE"/>
                <ns2:additionalInformation name="LOCATION" value="texas" 
additionalInformationType="BILLING_ACCOUNT_CUSTOM_FIELD_VALUE"/>
                <ns2:additionalInformation name="Account Custom Field-3" 
value="3" additionalInformationType="BILLING_ACCOUNT_CUSTOM_FIELD_VALUE"/>
                <ns2:additionalInformation name="Account Custom Field-2" 
value="2" additionalInformationType="BILLING_ACCOUNT_CUSTOM_FIELD_VALUE"/>
            </ns2:glAccountingEntry>
        </ns2:glAccountingEntries>
    </ns2:glAccountingTransaction>
</glAccountingTransactions>

REST Example Query and Response for Parameters "GLAccountingTransactionEID" and "batchPostedOn"

The following REST query and response of a GLAccountingTransaction uses the parameter of GLAccountingTransactionEID ("36080305"), which can be learned through a separate query, and batchPostedOn ("2014-07-05").

GET https://my.tractbilling.com/t/s/r/1.33/glAccountingTransactions?eid=36080305&batchPostedOn=2014-07-05&queryScope=DEEP

This was the response that also shows the additionalInformation fields:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<glAccountingTransactions xmlns:ns2="http://www.tractbilling.com/billing/1_31/domain" pageNumber="1" pageSize="50" totalElements="1" elementCount="1" totalPages="1">
    <ns2:glAccountingTransaction occurredOn="2014-07-05T00:00:00-05:00" postedOn="2014-07-05T00:00:00-05:00" type="RECURRING" amount="100.00" currencyType="USD" originalAmount="100.00" originalCurrencyType="USD" eid="36080305" queryScope="DEEP">
        <ns2:glAccountingEntries pageNumber="1" pageSize="50" totalElements="2" elementCount="2" totalPages="1">
            <ns2:glAccountingEntry amount="100.00" occurredOn="2014-07-05" credit="true" description="45" currencyType="USD" originalAmount="100.00" originalCurrencyType="USD" eid="84068310" queryScope="DEEP">
                <ns2:glAccount currentBalance="-7627.44" accountNum="1001" name="1001 Cash" description="Cash Account" currencyType="USD" eid="2736" queryScope="DEEP">
                    <ns2:glAccountCategory name="Cash" description="Cash assets" status="ACTIVE" eid="29078" 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 Company General Ledger" status="ACTIVE" targetCurrencyType="USD" eid="370" queryScope="DEEP">
                        <ns2:chartOfAccounts pageNumber="1" 
pageSize="50" totalElements="41" elementCount="0" totalPages="1"/>
                    </ns2:generalLedger>
                </ns2:glAccount>
                <ns2:additionalInformation name="Roll-Up" 
value="t" additionalInformationType="BILLING_ACCOUNT_CUSTOM_FIELD_VALUE"/>
                <ns2:additionalInformation name="Smith Company Account Name" 
value="t" additionalInformationType="BILLING_ACCOUNT_CUSTOM_FIELD_VALUE"/>
                <ns2:additionalInformation name="P.O.#" 
value="t" additionalInformationType="BILLING_ACCOUNT_CUSTOM_FIELD_VALUE"/>
            </ns2:glAccountingEntry>
            <ns2:glAccountingEntry amount="100.00" occurredOn="2014-07-05" credit="false" description="45" currencyType="USD" originalAmount="100.00" originalCurrencyType="USD" eid="84068311" queryScope="DEEP">
                <ns2:glAccount currentBalance="8077.44" accountNum="1100" name="1100 Accounts Receivable" description="A/R" currencyType="USD" eid="2738" queryScope="DEEP">
                    <ns2:glAccountCategory name="Accounts Receivable" description="Accounts Receivable" status="ACTIVE" eid="29080" 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 Company General Ledger" status="ACTIVE" targetCurrencyType="USD" eid="370" queryScope="DEEP">
                        <ns2:chartOfAccounts pageNumber="1" 
pageSize="50" totalElements="41" elementCount="0" totalPages="1"/>
                    </ns2:generalLedger>
                </ns2:glAccount>
                <ns2:additionalInformation name="Roll-Up" 
value="t" additionalInformationType="BILLING_ACCOUNT_CUSTOM_FIELD_VALUE"/>
                <ns2:additionalInformation name="Smith Company Account Name" 
value="t" additionalInformationType="BILLING_ACCOUNT_CUSTOM_FIELD_VALUE"/>
                <ns2:additionalInformation name="P.O.#" 
value="t" additionalInformationType="BILLING_ACCOUNT_CUSTOM_FIELD_VALUE"/>
            </ns2:glAccountingEntry>
        </ns2:glAccountingEntries>
    </ns2:glAccountingTransaction>
</glAccountingTransactions>