Order Entry Transaction Subtotal Templates

Subtotal templates define subtotals that can be used in different transaction definitions.

You can only use these functions at the top level of a multi entity company that is configured to use subtotal templates.

Get Order Entry Transaction Subtotal Template Object Definition

lookup

List all the fields and relationships for the Order Entry transaction subtotal template object:

<lookup>
    <object>SOSUBTOTALTEMPLATE</object>
</lookup>

Parameters

Name Required Type Description
object Required string Use SOSUBTOTALTEMPLATE

Query and List Order Entry Transaction Subtotal Templates

query

List the record number, name, and module for each Order Entry subtotal template:

<query>
    <object>SOSUBTOTALTEMPLATE</object>
    <select>
        <field>RECORDNO</field>
        <field>NAME</field>
        <field>MODULE</field>
    </select>
</query>

Parameters

Name Required Type Description
object Required string Use SOSUBTOTALTEMPLATE
filter Optional object Filter expression to limit the response to only objects that match the expression. Check the value of a single field using operators such as equalto/like, or multiple fields using and/or. Query fields on related objects using the dot operator (for example, VENDOR.CREDITLIMIT on APBILL).
select Required sequence The names of the fields that you want included in the response, and an optional aggregate function such as count or sum. Returning all fields is not supported.
orderby Optional object Provide an order element with a field name and choose an ascending or descending sort order, for example:
<order>
  <field>RECORDNO</field>
  <descending/>
</order>
options Optional object Query options:
  • Set the caseinsensitive element to true for a case-insensitive query
     <caseinsensitive>true</caseinsensitive>
  • In a multi-entity company, set the showprivate element to true to query data in private entities:
     <showprivate>true</showprivate>
  • Specify the returnformat for the response: xml (default), json, or csv
     <returnformat>json</returnformat>
pagesize Optional integer Maximum number of matching objects to return in the response, between 1 and 2000 items (Default: 100)
offset Optional integer Point at which to start indexing into records (Default: 0)

Query and List Order Entry Transaction Subtotal Templates (Legacy)

readByQuery

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

Parameters

Name Required Type Description
object Required string Use SOSUBTOTALTEMPLATE
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. The following operators are supported: <, >, >=, <=, =, like, not like, in, not in, IS NOT NULL, IS NULL, AND, OR. Illegal XML characters must be properly encoded, and single quotes must be escaped with backslashes ('Jane\'s Deli'). Joins are not supported.
pagesize Optional integer Custom page size between 1 and 1000 items (Default: 100)

Get Order Entry Transaction Subtotal Template

read

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

Parameters

Name Required Type Description
object Required string Use SOSUBTOTALTEMPLATE
keys Required string Comma-separated list of object RECORDNO to get.
fields Optional string Comma-separated list of fields on the object to get. To return all fields, omit the element or provide * for the value.
For best performance and predictability, limit the number of fields.
returnFormat Optional string Data format for the response body:
  • xml (default)
  • json
  • csv

Get Order Entry Transaction Subtotal Template by ID

readByName

<readByName>
    <object>SOSUBTOTALTEMPLATE</object>
    <keys>Name of the template</keys>
    <fields>*</fields>
</readByName>

Parameters

Name Required Type Description
object Required string Use SOSUBTOTALTEMPLATE
keys Required string Comma-separated list of template IDs to get.
fields Optional string Comma-separated list of fields on the object to get. To return all fields, omit the element or provide * for the value.
For best performance and predictability, limit the number of fields.
returnFormat Optional string Data format for the response body:
  • xml (default)
  • json
  • csv

Provide feedback