GLTransactionBatch

Version: 1.33

GLTransactionBatch is a batch of General Ledger (G/L) Accounting Transactions (GLAccountingTransaction) provided to you by Gotransverse. Querying GLTransactionBatch shows you a list of GL Transactions.

Parameters

Each GLTransactionBatch 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		String	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.
xre		String	255	External reference identification, if any.
xrefMsg		String	255	Message referring to external reference, if any.
xrefImportedDate		String	255	External reference imported date.
GLTransactions		Sequence of GLAccountingTransaction	- -	The list of G/L Accounting Transactions in this Batch.
createdOn		DateTime	Refer to Data Types for dateTime formats.	The date and time the Batch was created.
postedOn		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 GLTransactionBatch been exported or not? YES, this Batch has been exported. NO, this Batch has NOT been exported.
sequence		Long	As needed	Every G/L Transaction Batch has a unique sequence used to identify the batch.

Entity GLTransactionBatches

The entity GLTransactionBatches enables you to see multiple pages of the entity GLTransactionBatch.

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.
GLTransactionBatch	GLTransactionBatch	- -	Shows the list of GLTransactionBatches.

Information for the related Entity of GLTransactionBatches:

• Entity GLTransactionBatches

Query a GLTransactionBatch

Query Key Information for SOAP and REST

Querying to see GLTransactionBatch 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 - GLTransactionBatch

Query Key	Value	Definition
eid	Long	The eid number of the GLTransactionBatch.
batchNum	String	The batch number.
postedOn	Date	The date on which the Transaction Batch was posted.
exported	Boolean	Whether or not this Transaction Batch was exported.
status		The status of the Transaction Batch.

Query to Use

Query

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

SOAP Example Query

The following SOAP query GLTransactionBatch used the value of "286" for the parameter of "batchNum".

<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>GLTransactionBatch</dom:type>
			<dom:parameter parameter="<b>batchNum</b>" parameterValue="
			<b>286</b>"/>
			</dom:simpleDataQuery>
			</ser:queryRequest>
			</ser:query>
			</soapenv:Body>
		</soapenv:Envelope>

This was the response:

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
			<soap:Body>
			<ns2:queryResponse xmlns:ns2="http://www.tractbilling.com/billing/1_31/service">
			<ns2:return successful="true">
			<glTransactionBatches elementCount="1" pageNumber="1" pageSize="50" totalElements="1" totalPages="1" xmlns="http://www.tractbilling.com/billing/1_23/domain">
			<glTransactionBatch batchNumber="286" createdOn="2014-07-01T00:07:23-05:00" eid="272328" exported="false" postedOn="2014-06-30T00:00:00-05:00" queryScope="DEEP" sequence="1" status="COMPLETED" totalRecords="12">
			<glTransactions elementCount="0" 
			pageNumber="1" pageSize="50" totalElements="12" totalPages="1"/>
			</glTransactionBatch>
			</glTransactionBatches>
			</ns2:return>
			</ns2:queryResponse>
			</soap:Body>
		</soap:Envelope>

REST Mount Points

Query

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

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

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

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

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

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

Update

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

REST Examples

REST Example Update

• PUT https://my.tractbilling.com/t/s/r/1.33/glTransactionBatches/16 <glTransactionBatch xmlns="http://www.tractbilling.com/billing/1_31/domain" eid="27" exported="true"/>

REST Example Queries

The following examples are REST queries:

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

• GET https://my.tractbilling.com/t/s/r/1.33/glTransactionBatches?batchNum=20