Statistical journals hold all non-financial transactions.


List Statistical Journal Entries

readByQuery

List entries for the statistical journal with the given symbol (SHC):

<readByQuery>
    <object>GLBATCH</object>
    <fields>*</fields>
    <query>JOURNAL = 'SHC'</query>
    <pagesize>100</pagesize>
</readByQuery>

Parameters

Name Required Type Description
object Required string Use GLBATCH
fields Optional string Comma-separated list of fields on the object to list. For best performance and predictability, limit the number of fields. To return all fields, omit the element or provide * for the value.
query Required string SQL-like query based on fields on the object. Illegal XML characters must be properly encoded. The following SQL operators are supported: <, >, >=, <=, =, like, not like, in, not in. When doing NULL comparisons: IS NOT NULL, IS NULL. Multiple fields may be matched using the AND and OR operators. Joins are not supported. Single quotes in any operands must be escaped with a backslash - For example, the value Erik's Deli would become 'Erik\'s Deli'.
pagesize Optional integer Set a custom page size between 1 and 1000 items (Default: 100)

query

Name Required Type Description
STATE Optional string State of the stat journal entry. Use I for Draft, S for Submitted, X for Partially Approved, A for Approved, P for Posted, R for Declined, L for Reversal Pending, or Z for Reversed.

Get Statistical Journal Entry

read

<read>
    <object>GLBATCH</object>
    <keys>31</keys>
    <fields>*</fields>
</read>

Parameters

Name Required Type Description
object Required string Use GLBATCH
keys Required string The stat journal entry RECORDNO to get
fields Optional string Comma-separated list of fields on the object to get. For best performance and predictability, limit the number of fields. To return all fields, omit the element or provide * for the value.

Create Statistical Journal Entry

create

<create>
    <GLBATCH>
        <JOURNAL>SHC</JOURNAL>
        <BATCH_DATE>03/31/2016</BATCH_DATE>
        <BATCH_TITLE>Headcount 03/31/2016</BATCH_TITLE>
        <ENTRIES>
            <GLENTRY>
                <ACCOUNTNO>HEADS</ACCOUNTNO>
                <DEPARTMENT>ADMIN</DEPARTMENT>
                <LOCATION>100</LOCATION>
                <TR_TYPE>1</TR_TYPE>
                <AMOUNT>2.00</AMOUNT>
                <DESCRIPTION>Headcount 03/31/2016</DESCRIPTION>
            </GLENTRY>
        </ENTRIES>
    </GLBATCH>
</create>

Parameters

Name Required Type Description
GLBATCH Optional object The object to create

GLBATCH

Name Required Type Description
JOURNAL Required string Stat journal symbol
BATCH_DATE Required string Posting date in format mm/dd/yyyy.
REVERSEDATE Optional string Reverse date in format mm/dd/yyyy. Must be greater than BATCH_DATE.
BATCH_TITLE Required string Description of entry.
HISTORY_COMMENT Optional string Comment added to history for this transaction.
REFERENCENO Optional string Reference number of transaction
SUPDOCID Optional string Attachments ID
STATE Optional string State to create the entry in. Posted to post to the GL, otherwise Draft (Default: Posted)
ENTRIES Required array[GLENTRY] Must have at least one line. Stat journal entries do not need to balance like regular journal entries
Custom fields Optional varies This object supports custom fields.

GLENTRY

Name Required Type Description
DOCUMENT Optional string Document number of entry
ACCOUNTNO Required string Account number
TRX_AMOUNT Required currency Amount. Absolute value, relates to TR_TYPE.
TR_TYPE Required string Transaction type. 1 for Increase, otherwise -1 for Decrease.
DESCRIPTION Optional string Memo. If left blank, set this value to match BATCH_TITLE.
ALLOCATION Optional string Allocation ID. All other dimension elements are ignored if allocation is set. Use Custom for custom splits and see SPLIT element below.
DEPARTMENT Optional string Department ID
LOCATION Optional string Location ID. Required if multi-entity enabled.
PROJECTID Optional string Project ID
CUSTOMERID Optional string Customer ID
VENDORID Optional string Vendor ID
EMPLOYEEID Optional string Employee ID
ITEMID Optional string Item ID
CLASSID Optional string Class ID
CONTRACTID Optional string Contract ID
WAREHOUSEID Optional string Warehouse ID
SPLIT Optional SPLIT[] Custom allocation split. Required if ALLOCATION equals Custom. Multiple SPLIT elements may then be passed.
Custom fields Optional varies This object supports custom fields.

SPLIT

Name Required Type Description
AMOUNT Required currency Split transaction amount. Absolute value. All SPLIT element’s AMOUNT values must sum up to equal GLENTRY element’s TRX_AMOUNT
DEPARTMENTID Optional string Department ID
LOCATIONID Optional string Location ID. Required if multi-entity enabled.
PROJECTID Optional string Project ID
CUSTOMERID Optional string Customer ID
VENDORID Optional string Vendor ID
EMPLOYEEID Optional string Employee ID
ITEMID Optional string Item ID
CLASSID Optional string Class ID
CONTRACTID Optional string Contract ID
WAREHOUSEID Optional string Warehouse ID

Update Statistical Journal Entry

update

<update>
    <GLBATCH>
        <RECORDNO>21</RECORDNO>
        <BATCH_DATE>03/31/2016</BATCH_DATE>
        <BATCH_TITLE>Headcount 03/31/2016</BATCH_TITLE>
        <ENTRIES>
            <GLENTRY>
                <ACCOUNTNO>HEADS</ACCOUNTNO>
                <DEPARTMENT>ADMIN</DEPARTMENT>
                <LOCATION>100</LOCATION>
                <TR_TYPE>1</TR_TYPE>
                <AMOUNT>2.00</AMOUNT>
                <DESCRIPTION>Headcount 03/31/2016</DESCRIPTION>
            </GLENTRY>
        </ENTRIES>
    </GLBATCH>
</update>

Parameters

Name Required Type Description
GLBATCH Optional object The object to update

GLBATCH

Name Required Type Description
RECORDNO Required integer Record number of the stat journal entry
BATCH_DATE Required string Posting date in format mm/dd/yyyy.
BATCH_TITLE Required string Description of entry.
HISTORY_COMMENT Optional string Comment added to history for this transaction.
REFERENCENO Optional string Reference number of transaction
SUPDOCID Optional string Attachments ID
STATE Optional string State to update the entry to. Posted to post to the GL, otherwise Draft.
ENTRIES Required array[GLENTRY] Must have at least one line. Stat journal entries do not need to balance like regular journal entries
Custom fields Optional varies This object supports custom fields.

GLENTRY

Name Required Type Description
DOCUMENT Optional string Document number of entry
ACCOUNTNO Required string Account number
TRX_AMOUNT Required currency Amount. Absolute value, relates to TR_TYPE.
TR_TYPE Required string Transaction type. 1 for Increase, otherwise -1 for Decrease.
DESCRIPTION Optional string Memo. If left blank, set this value to match BATCH_TITLE.
ALLOCATION Optional string Allocation ID. All other dimension elements are ignored if allocation is set. Use Custom for custom splits and see SPLIT element below.
DEPARTMENT Optional string Department ID
LOCATION Optional string Location ID. Required if multi-entity enabled.
PROJECTID Optional string Project ID
CUSTOMERID Optional string Customer ID
VENDORID Optional string Vendor ID
EMPLOYEEID Optional string Employee ID
ITEMID Optional string Item ID
CLASSID Optional string Class ID
CONTRACTID Optional string Contract ID
WAREHOUSEID Optional string Warehouse ID
SPLIT Optional SPLIT[] Custom allocation split. Required if ALLOCATION equals Custom. Multiple SPLIT elements may then be passed.
Custom fields Optional varies This object supports custom fields.

SPLIT

Name Required Type Description
AMOUNT Required currency Split transaction amount. Absolute value. All SPLIT element’s AMOUNT values must sum up to equal GLENTRY element’s TRX_AMOUNT
DEPARTMENTID Optional string Department ID
LOCATIONID Optional string Location ID. Required if multi-entity enabled.
PROJECTID Optional string Project ID
CUSTOMERID Optional string Customer ID
VENDORID Optional string Vendor ID
EMPLOYEEID Optional string Employee ID
ITEMID Optional string Item ID
CLASSID Optional string Class ID
CONTRACTID Optional string Contract ID
WAREHOUSEID Optional string Warehouse ID

Delete Statistical Journal Entry

delete

<delete>
    <object>GLENTRY</object>
    <keys>1</keys>
</delete>

Parameters

Name Required Type Description
object Required string Use GLBATCH
keys Required string The stat journal entry RECORDNO to delete

List Statistical Journal Entry Lines

readByQuery

<readByQuery>
    <object>GLENTRY</object>
    <fields>*</fields>
    <query></query>
    <pagesize>100</pagesize>
</readByQuery>

Parameters

Name Required Type Description
object Required string Use GLENTRY
fields Optional string Comma-separated list of fields on the object to list. For best performance and predictability, limit the number of fields. To return all fields, omit the element or provide * for the value.
query Required string SQL-like query based on fields on the object. Illegal XML characters must be properly encoded. The following SQL operators are supported: <, >, >=, <=, =, like, not like, in, not in. When doing NULL comparisons: IS NOT NULL, IS NULL. Multiple fields may be matched using the AND and OR operators. Joins are not supported. Single quotes in any operands must be escaped with a backslash - For example, the value Erik's Deli would become 'Erik\'s Deli'.
pagesize Optional integer Set a custom page size between 1 and 1000 items (Default: 100)

Get Statistical Journal Entry Line

read

<read>
    <object>GLENTRY</object>
    <keys>1</keys>
    <fields>*</fields>
</read>

Parameters

Name Required Type Description
object Required string Use GLENTRY
keys Required string The stat journal entry line RECORDNO to get
fields Optional string Comma-separated list of fields on the object to get. For best performance and predictability, limit the number of fields. To return all fields, omit the element or provide * for the value.

Provide feedback