GLAccount
Version: 1.33
GLPaymentAccountingTransaction is a type of GLAccountingTransaction.
GLAccountingTransactions include GLAdjustmentAccountingTransactions, GLPaymentAccountingTransactions (details below), and GLInvoiceAccountingTransactions.
GLAccountingTransactions are grouped into a GLTransactionBatch.
GL Payment Accounting Transactions can be viewed in the Gotransverse GUI as well as queried and viewed through the Gotransverse API.
Parameters
Each GLPaymentAccountingTransaction 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.
Element Name | Query Key |
Element Type | Field Length | Description |
---|---|---|---|---|
GLAccountingTransaction |
GLAccountingTransaction |
- - |
Refer to GLAccountingTransaction. |
|
payment |
Payment |
- - |
The payment. Refer to Payment for more information. |
Query a GLPaymentAccountingTransaction
Query Key Information
Querying to see GLPaymentAccountingTransactions 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 Key | Value | Definition | ||
---|---|---|---|---|
eid |
Long |
The eid number of the GLPaymentAccountingTransaction. |
||
batchNum |
String |
The number of the GLTransactionBatch in which the GLPaymentAccountingTransaction is a member. |
||
GLTransactionBatchEid |
Long |
The eid number of the GLTransactionBatch in which the GLPaymentAccountingTransaction is a member. | ||
batchPostedOn |
Date |
The date on which the GLTransactionBatch was posted in which the GLPaymentAccountingTransaction is a member. |
||
occurredOn |
Date |
The date on which the GLPaymentAccountingTransaction occurred. |
||
currencyType |
The current currency type of the GLPaymentAccountingTransaction. |
|||
originalCurrencyType |
If applicable, the original currency type of the GLPaymentAccountingTransaction. Refer to CurrencyType for list of currencies used in Gotransverse. |
Query to Use
Query to Use | Query for | Parameter Name and Value | Returns | |
---|---|---|---|---|
SimpleDataQuery |
GLPaymentAccountingTransaction |
<parameter name><parameter value> |
List of your GLPaymentAccountingTransactions for that parameter name and value. |
SOAP Example Query for Parameters "originalCurrencyType" and "GLAccountingTransaction EID"
In the following SOAP query of GLPaymentAccountingTransaction, the parameter of originalCurrencyType was used which in this example is "USD" and the parameter of the EID of the GLPaymentAccountingTransaction ("4435") which 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>GLPaymentAccountingTransaction</dom:type> <parameter parameter="originalCurrencyType" parameterValue="USD"/> <parameter parameter="eid" parameterValue="4435"/> </dom:simpleDataQuery> </ser:queryRequest> </ser:query> </soapenv:Body> </soapenv:Envelope>
SOAP Example Query for Parameters "batchPostedOn" and "GLAccountingTransaction EID"
In the following SOAP query of GLPaymentAccountingTransaction, the parameter of batchPostedOn was used, which in this example is "2014-01-08" and the parameter of the EID of the GLPaymentAccountingTransaction ("36080305") which 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>GLPaymentAccountingTransaction</dom:type> <parameter parameter="batchPostedOn" operator="GT" parameterValue="2014-01-08"/> <parameter parameter="eid" parameterValue="36080305"/> </dom:simpleDataQuery> </ser:queryRequest> </ser:query> </soapenv:Body>
REST Mount Points
Query
-
GET https://my.tractbilling.com/t/s/r/1.33/glPaymentAccountingTransactions/<eid>
-
GET https://my.tractbilling.com/t/s/r/1.33/glPaymentAccountingTransactions?eid=<eid>
-
GET https://my.tractbilling.com/t/s/r/1.33/glPaymentAccountingTransactions?batchNum=<batchNum>
-
GET https://my.tractbilling.com/t/s/r/1.33/glPaymentAccountingTransactions?glTransactionBatchEid=<glTransactionBatchEid>
-
GET https://my.tractbilling.com/t/s/r/1.33/glPaymentAccountingTransactions?batchPostedOn=<batchPostedOn>
-
GET https://my.tractbilling.com/t/s/r/1.33/glPaymentAccountingTransactions?occurredOn=<occurredOn>
-
GET https://my.tractbilling.com/t/s/r/1.33/glPaymentAccountingTransactions?currencyType=<currencyType>
-
GET https://my.tractbilling.com/t/s/r/1.33/glPaymentAccountingTransactions?originalCurrencyType=<originalCurrencyType>
REST Example Queries
The following examples show different sets of parameters in the queries.
REST Example Query for Parameters "batchNum" and "currencyType"
The following REST query of a GLPaymentAccountingTransaction uses the parameter of batchNum ("327") and currencyType ("USD").
-
GET https://my.tractbilling.com/t/s/r/1.33/glPaymentAccountingTransactions?batchNum=327¤cyType=USD&queryScope=DEEP
REST Example Query for Parameters "GLAccountingTransactionEID" and "batchPostedOn"
The following REST query of a GLPaymentAccountingTransaction 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/glPaymentAccountingTransactions?eid=36080305&batchPostedOn=2014-07-05&queryScope=DEEP